Skip to content

Commit e31c97d

Browse files
committed
OAuth notes
1 parent 70952a5 commit e31c97d

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

content/v3/oauth.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,10 @@ app.
164164
scopes
165165
: _Optional_ **array** - A list of scopes that this authorization is in.
166166

167-
<%= json :scopes => ["public_repo"] %>
167+
note
168+
: _Optional_ **string** - A note to remind you what the OAuth token is for.
169+
170+
<%= json :scopes => ["public_repo"], :note => 'admin script' %>
168171

169172
### Response
170173

@@ -188,9 +191,12 @@ remove_scopes
188191
: _Optional_ **array** - A list of scopes to remove from this
189192
authorization.
190193

194+
note
195+
: _Optional_ **string** - A note to remind you what the OAuth token is for.
196+
191197
You can only send one of these scope keys at a time.
192198

193-
<%= json :add_scopes => ['repo'] %>
199+
<%= json :add_scopes => ['repo'], :note => 'admin script' %>
194200

195201
### Response
196202

lib/resources.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -671,6 +671,7 @@ def json(key)
671671
"url" => "http://my-github-app.com",
672672
"name" => "my github app"
673673
},
674+
"note" => "optional note",
674675
"updated_at" => "2011-09-06T20:39:23Z",
675676
"created_at" => "2011-09-06T17:26:27Z"
676677
}

0 commit comments

Comments
 (0)