Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Commitf9cbf0e

Browse files
committed
Merge pull request#533 from github/finalize-mirage-preview
Announce the finalized mirage-preview release
2 parentse3aa5ec +0817e9d commitf9cbf0e

File tree

3 files changed

+48
-19
lines changed

3 files changed

+48
-19
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
kind:change
3+
title:Authorizations API response changes are now in effect
4+
created_at:2015-04-20
5+
author_name:ptoomey3
6+
---
7+
8+
Two months ago, we
9+
[announced the migration period][migration-period-announcement]
10+
for several[API changes related to managing OAuth authorizations][original-announcement].
11+
As promised, the migration period concluded today, and these changes are
12+
now in effect for all requests.
13+
14+
###Preview media type no longer needed
15+
16+
If you used the updated Authorizations API during the migration period, you needed
17+
to provide a custom media type in the`Accept` header:
18+
19+
application/vnd.github.mirage-preview+json
20+
21+
Now that the migration period has ended, you no longer need to pass this custom
22+
media type.
23+
24+
Instead, we[recommend][media-types] that you specify`v3` as the version in the
25+
`Accept` header:
26+
27+
application/vnd.github.v3+json
28+
29+
###Feedback
30+
31+
As always, if you have any feedback, please don't hesitate to
32+
[get in touch with us][contact].
33+
34+
[migration-period-announcement]:/changes/2015-02-20-migration-period-removing-authorizations-token
35+
[original-announcement]:/changes/2014-12-08-removing-authorizations-token/
36+
[docs]:/v3/oauth_authorizations
37+
[media-types]:/v3/media
38+
[contact]:https://github.com/contact?form[subject]=Removing+token+from+Authorizations+API

‎content/v3/oauth_authorizations.md‎

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,16 @@ Make sure you understand how to [work with two-factor authentication](/v3/auth/#
2828
</ul>
2929

3030
<p>
31-
We're currently offering a migration period allowing applications to opt in to the new Authorization API behavior. This functionality will apply to all API consumers beginning April 20, 2015. Please see <a href="/changes/2015-02-20-migration-period-removing-authorizations-token/">the blog post</a> for full details.
32-
</p>
33-
34-
<p>
35-
In order to reduce the impact of removing the <code>token</code> attribute,
36-
the OAuth Authorizations API has added a new request attribute
37-
(<code>fingerprint</code>), added three new response attributes
31+
To reduce the impact of removing the <code>token</code> value,
32+
the OAuth Authorizations API now includes a new request attribute
33+
(<code>fingerprint</code>), three new response attributes
3834
(<code>token_last_eight</code>, <code>hashed_token</code>, and
39-
<code>fingerprint</code>), and added
40-
<a href="#get-or-create-an-authorization-for-a-specific-app-and-fingerprint">one newAPI</a>.
35+
<code>fingerprint</code>), and
36+
<a href="#get-or-create-an-authorization-for-a-specific-app-and-fingerprint">one newendpoint</a>.
4137
</p>
4238

4339
<p>
44-
To access the new API functionality during the migration period, you must
45-
provide a custom <a href="/v3/media/">media type</a> in the
46-
<code>Accept</code> header:
47-
<pre>application/vnd.github.mirage-preview+json</pre>
40+
This functionality became the default for all requests on April 20, 2015. Please see <a href="/changes/2015-04-20-authorizations-api-response-changes-are-now-in-effect/">the blog post</a> for full details.
4841
</p>
4942
</div>
5043

@@ -87,7 +80,7 @@ Name | Type | Description
8780
`note_url`|`string` | A URL to remind you what app the OAuth token is for.
8881
`client_id`|`string` | The 20 character OAuth app client key for which to create the token.
8982
`client_secret`|`string` | The 40 character OAuth app client secret for which to create the token.
90-
`fingerprint`|`string` |**This attribute is only available when using the[mirage-preview](#deprecation-notice) media type.**A unique string to distinguish an authorization from others created for the same client ID and user.
83+
`fingerprint`|`string` | A unique string to distinguish an authorization from others created for the same client ID and user.
9184

9285

9386
<%= json:scopes =>["public_repo"],:note => 'admin script' %>
@@ -115,7 +108,7 @@ Name | Type | Description
115108
`scopes`|`array` | A list of scopes that this authorization is in.
116109
`note`|`string` | A note to remind you what the OAuth token is for.
117110
`note_url`|`string` | A URL to remind you what app the OAuth token is for.
118-
`fingerprint`|`string` |**This attribute is only available when using the[mirage-preview](#deprecation-notice) media type.**A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to[Get-or-create an authorization for a specific app and fingerprint](/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).
111+
`fingerprint`|`string` | A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to[Get-or-create an authorization for a specific app and fingerprint](/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).
119112

120113

121114
<%= json:client_secret => "abcdabcdabcdabcdabcdabcdabcdabcdabcdabcd",:scopes =>["public_repo"],:note => 'admin script' %>
@@ -132,8 +125,6 @@ Name | Type | Description
132125

133126
##Get-or-create an authorization for a specific app and fingerprint
134127

135-
**This API method is only available when using the
136-
[mirage-preview](#deprecation-notice) media type.**
137128
This method will create a new authorization for the specified OAuth application,
138129
only if an authorization for that application and fingerprint do not already
139130
exist for the user. The URL includes the 20 character client ID for the OAuth
@@ -179,7 +170,7 @@ Name | Type | Description
179170
`remove_scopes`|`array` | A list of scopes to remove from this authorization.
180171
`note`|`string` | A note to remind you what the OAuth token is for.
181172
`note_url`|`string` | A URL to remind you what app the OAuth token is for.
182-
`fingerprint`|`string` |**This attribute is only available when using the[mirage-preview](#deprecation-notice) media type.**A unique string to distinguish an authorization from others created for the same client ID and user.
173+
`fingerprint`|`string` | A unique string to distinguish an authorization from others created for the same client ID and user.
183174

184175

185176
You can only send one of these scope keys at a time.

‎content/v3/versions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ The recommendations below will help you prepare your application for the next ma
114114
1. Authorization attribute: token
115115
: Recommendation: This attribute will return an empty string in the majority of
116116
the Authorizations API responses. Please see
117-
[the deprecation blog post](/changes/2015-02-20-migration-period-removing-authorizations-token/)
117+
[the deprecation blog post](/changes/2015-04-20-authorizations-api-response-changes-are-now-in-effect/)
118118
and the[Authorizations API deprecation notice](/v3/oauth_authorizations/#deprecation-notice)
119119
for full details.
120120

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp