Skip to content

Commit 5122d02

Browse files
author
Hubot
committed
Sync changes from upstream repository
1 parent a5eb4ce commit 5122d02

File tree

2 files changed

+40
-19
lines changed

2 files changed

+40
-19
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
kind: change
3+
title: The combined status API is official
4+
created_at: 2014-07-09
5+
author_name: bhuga
6+
---
7+
8+
We're happy to announce that the [Combined Status API][docs] is officially part
9+
of the GitHub API v3. We now consider it stable for production use.
10+
11+
Thanks to everyone who provided feedback during the comment period. We got
12+
some great feedback, and hope this feature helps you build the tools you
13+
need to make GitHub the best place to ship exactly the way you want.
14+
15+
### Preview media type no longer needed
16+
17+
If you used the Combined Status API during the preview period, you needed to
18+
provide a custom media type in the `Accept` header:
19+
20+
application/vnd.github.she-hulk-preview+json
21+
22+
Now that the preview period has ended, you no longer need to pass this custom
23+
media type.
24+
25+
Instead, we [recommend][media-types] that you specify `v3` as the version in the
26+
`Accept` header:
27+
28+
application/vnd.github.v3+json
29+
30+
### Feedback
31+
32+
We'll never be done listening to you! As always, please don't hestitate to
33+
[share your feedback][feedback].
34+
35+
[docs]: /v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
36+
[media-types]: /v3/media
37+
[feedback]: https://github.com/contact?form[subject]=Combined+Status+API

content/v3/repos/statuses.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -56,19 +56,16 @@ Name | Type | Description
5656
'https://api.github.com/repos/octocat/example/statuses/1' %>
5757
<%= json :status %>
5858

59-
<% combined_media_type = "application/vnd.github.she-hulk-preview+json" %>
60-
6159
## List Statuses for a specific Ref
6260

6361
Users with pull access can view commit statuses for a given ref:
6462

65-
GET /repos/:owner/:repo/statuses/:ref
63+
GET /repos/:owner/:repo/commits/:ref/statuses
6664

6765
<div class="alert">
6866
<p>
69-
If you send an <code>Accept</code> header with the Combined Status API preview
70-
<a href="/v3/media/">media type</a>, <code><%= combined_media_type %></code>,
71-
this endpoint is also available at <code>/repos/:owner/:repo/commits/:ref/statuses</code>.
67+
This resource is also available via a legacy route:
68+
<code>GET /repos/:owner/:repo/statuses/:ref</code>.
7269
</p>
7370
</div>
7471

@@ -89,19 +86,6 @@ Name | Type | Description
8986

9087
## Get the combined Status for a specific Ref
9188

92-
<div class="alert">
93-
<p>
94-
The Combined status endpoint is currently available for developers to preview.
95-
During the preview period, the API may change without advance notice.
96-
Please see the <a href="/changes/2014-03-27-combined-status-api/">blog post</a> for full details.
97-
</p>
98-
<p>
99-
To access this endpoint during the preview period, you must provide a custom
100-
<a href="/v3/media/">media type</a> in the <code>Accept</code> header:
101-
<pre><%= combined_media_type %></pre>
102-
</p>
103-
</div>
104-
10589
Users with pull access can access a combined view of commit statuses for a given ref.
10690

10791
GET /repos/:owner/:repo/commits/:ref/status

0 commit comments

Comments
 (0)