Skip to content

Commit 3164fd1

Browse files
committed
document the new branches/:branch endpoint
1 parent 2001311 commit 3164fd1

File tree

2 files changed

+65
-7
lines changed

2 files changed

+65
-7
lines changed

content/v3/repos.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,16 @@ in results.
222222
### Response
223223

224224
<%= headers 200 %>
225-
<%= json(:branch) { |h| [h] }%>
225+
<%= json(:branches) %>
226+
227+
## Get Branch
228+
229+
GET /repos/:user/:repo/branches/:branch
230+
231+
### Response
232+
233+
<%= headers 200 %>
234+
<%= json(:branch) %>
226235

227236
## Delete a Repository
228237

lib/resources.rb

Lines changed: 55 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -152,13 +152,62 @@ def json(key)
152152
"tarball_url" => "https://github.com/octocat/Hello-World/tarball/v0.1",
153153
}
154154

155-
BRANCH = {
156-
"name" => "master",
157-
"commit" => {
158-
"sha" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
159-
"url" => "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"
155+
BRANCHES = [
156+
{
157+
"name" => "master",
158+
"commit" => {
159+
"sha" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
160+
"url" => "https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc"
161+
}
160162
}
161-
}
163+
]
164+
165+
BRANCH = {"name"=>"master",
166+
"commit"=>
167+
{"sha"=>"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
168+
"commit"=>
169+
{"author"=>
170+
{"name"=>"The Octocat",
171+
"date"=>"2012-03-06T15:06:50-08:00",
172+
"email"=>"octocat@nowhere.com"},
173+
"url"=>
174+
"https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
175+
"message"=>
176+
"Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.",
177+
"tree"=>
178+
{"sha"=>"b4eecafa9be2f2006ce1b709d6857b07069b4608",
179+
"url"=>
180+
"https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608"},
181+
"committer"=>
182+
{"name"=>"The Octocat",
183+
"date"=>"2012-03-06T15:06:50-08:00",
184+
"email"=>"octocat@nowhere.com"}},
185+
"author"=>
186+
{"gravatar_id"=>"7ad39074b0584bc555d0417ae3e7d974",
187+
"avatar_url"=>
188+
"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
189+
"url"=>"https://api.github.com/users/octocat",
190+
"id"=>583231,
191+
"login"=>"octocat"},
192+
"parents"=>
193+
[{"sha"=>"553c2077f0edc3d5dc5d17262f6aa498e69d6f8e",
194+
"url"=>
195+
"https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e"},
196+
{"sha"=>"762941318ee16e59dabbacb1b4049eec22f0d303",
197+
"url"=>
198+
"https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303"}],
199+
"url"=>
200+
"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
201+
"committer"=>
202+
{"gravatar_id"=>"7ad39074b0584bc555d0417ae3e7d974",
203+
"avatar_url"=>
204+
"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
205+
"url"=>"https://api.github.com/users/octocat",
206+
"id"=>583231,
207+
"login"=>"octocat"}},
208+
"_links"=>
209+
{"html"=>"https://github.com/octocat/Hello-World/tree/master",
210+
"self"=>"https://api.github.com/repos/octocat/Hello-World/branches/master"}}
162211

163212
PULL = {
164213
"url" => "https://api.github.com/octocat/Hello-World/pulls/1",

0 commit comments

Comments
 (0)