Skip to content

Commit ad34fb2

Browse files
Update OpenAPI Descriptions (#18447)
1 parent bec5b43 commit ad34fb2

6 files changed

Lines changed: 115 additions & 4901 deletions

File tree

lib/rest/static/decorated/api.github.com.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3240,7 +3240,7 @@
32403240
}
32413241
],
32423242
"summary": "Create a scoped access token",
3243-
"description": "Exchanges a non-repository scoped user-to-server OAuth access token for a repository scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
3243+
"description": "Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.",
32443244
"tags": [
32453245
"apps"
32463246
],
@@ -3257,12 +3257,12 @@
32573257
"properties": {
32583258
"access_token": {
32593259
"type": "string",
3260-
"description": "<p><strong>Required</strong>. <strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
3260+
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
32613261
"example": "e72e16c7e42f292c6912e7710c838347ae178b4a",
32623262
"name": "access_token",
32633263
"in": "body",
32643264
"rawType": "string",
3265-
"rawDescription": "**Required.** The OAuth access token used to authenticate to the GitHub API.",
3265+
"rawDescription": "The OAuth access token used to authenticate to the GitHub API.",
32663266
"childParamsGroups": []
32673267
},
32683268
"target": {
@@ -4138,13 +4138,13 @@
41384138
"subcategory": "oauth-applications",
41394139
"subcategoryLabel": "Oauth applications",
41404140
"notes": [],
4141-
"descriptionHTML": "<p>Exchanges a non-repository scoped user-to-server OAuth access token for a repository scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use <a href=\"https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
4141+
"descriptionHTML": "<p>Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use <a href=\"https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication\">Basic Authentication</a> when accessing this endpoint, using the OAuth application's <code>client_id</code> and <code>client_secret</code> as the username and password. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
41424142
"responses": [
41434143
{
41444144
"httpStatusCode": "200",
41454145
"httpStatusMessage": "OK",
41464146
"description": "Response",
4147-
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/authorizations/1\"</span>,\n <span class=\"hljs-attr\">\"scopes\"</span>: [\n <span class=\"hljs-string\">\"public_repo\"</span>\n ],\n <span class=\"hljs-attr\">\"token\"</span>: <span class=\"hljs-string\">\"abcdefgh12345678\"</span>,\n <span class=\"hljs-attr\">\"token_last_eight\"</span>: <span class=\"hljs-string\">\"12345678\"</span>,\n <span class=\"hljs-attr\">\"hashed_token\"</span>: <span class=\"hljs-string\">\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\"</span>,\n <span class=\"hljs-attr\">\"app\"</span>: {\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"http://my-github-app.com\"</span>,\n <span class=\"hljs-attr\">\"name\"</span>: <span class=\"hljs-string\">\"my github app\"</span>,\n <span class=\"hljs-attr\">\"client_id\"</span>: <span class=\"hljs-string\">\"abcde12345fghij67890\"</span>\n },\n <span class=\"hljs-attr\">\"note\"</span>: <span class=\"hljs-string\">\"optional note\"</span>,\n <span class=\"hljs-attr\">\"note_url\"</span>: <span class=\"hljs-string\">\"http://optional/note/url\"</span>,\n <span class=\"hljs-attr\">\"updated_at\"</span>: <span class=\"hljs-string\">\"2011-09-06T20:39:23Z\"</span>,\n <span class=\"hljs-attr\">\"created_at\"</span>: <span class=\"hljs-string\">\"2011-09-06T17:26:27Z\"</span>,\n <span class=\"hljs-attr\">\"fingerprint\"</span>: <span class=\"hljs-string\">\"jklmnop12345678\"</span>,\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"login\"</span>: <span class=\"hljs-string\">\"octocat\"</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"node_id\"</span>: <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span>,\n <span class=\"hljs-attr\">\"avatar_url\"</span>: <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span>,\n <span class=\"hljs-attr\">\"gravatar_id\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"followers_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span>,\n <span class=\"hljs-attr\">\"following_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span>,\n <span class=\"hljs-attr\">\"gists_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span>,\n <span class=\"hljs-attr\">\"starred_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span>,\n <span class=\"hljs-attr\">\"subscriptions_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span>,\n <span class=\"hljs-attr\">\"organizations_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span>,\n <span class=\"hljs-attr\">\"repos_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span>,\n <span class=\"hljs-attr\">\"events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span>,\n <span class=\"hljs-attr\">\"received_events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"User\"</span>,\n <span class=\"hljs-attr\">\"site_admin\"</span>: <span class=\"hljs-literal\">false</span>\n },\n <span class=\"hljs-attr\">\"installation\"</span>: {\n <span class=\"hljs-attr\">\"permissions\"</span>: {\n <span class=\"hljs-attr\">\"metadata\"</span>: <span class=\"hljs-string\">\"read\"</span>,\n <span class=\"hljs-attr\">\"issues\"</span>: <span class=\"hljs-string\">\"write\"</span>,\n <span class=\"hljs-attr\">\"contents\"</span>: <span class=\"hljs-string\">\"read\"</span>\n },\n <span class=\"hljs-attr\">\"repository_selection\"</span>: <span class=\"hljs-string\">\"selected\"</span>,\n <span class=\"hljs-attr\">\"single_file_name\"</span>: <span class=\"hljs-string\">\".github/workflow.yml\"</span>,\n <span class=\"hljs-attr\">\"repositories_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/user/repos\"</span>,\n <span class=\"hljs-attr\">\"account\"</span>: {\n <span class=\"hljs-attr\">\"login\"</span>: <span class=\"hljs-string\">\"octocat\"</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"node_id\"</span>: <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span>,\n <span class=\"hljs-attr\">\"avatar_url\"</span>: <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span>,\n <span class=\"hljs-attr\">\"gravatar_id\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"followers_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span>,\n <span class=\"hljs-attr\">\"following_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span>,\n <span class=\"hljs-attr\">\"gists_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span>,\n <span class=\"hljs-attr\">\"starred_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span>,\n <span class=\"hljs-attr\">\"subscriptions_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span>,\n <span class=\"hljs-attr\">\"organizations_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span>,\n <span class=\"hljs-attr\">\"repos_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span>,\n <span class=\"hljs-attr\">\"events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span>,\n <span class=\"hljs-attr\">\"received_events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"User\"</span>,\n <span class=\"hljs-attr\">\"site_admin\"</span>: <span class=\"hljs-literal\">false</span>\n },\n <span class=\"hljs-attr\">\"has_multiple_single_files\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"single_file_paths\"</span>: []\n }\n}\n</code></pre>"
4147+
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/authorizations/1\"</span>,\n <span class=\"hljs-attr\">\"scopes\"</span>: [],\n <span class=\"hljs-attr\">\"token\"</span>: <span class=\"hljs-string\">\"abcdefgh12345678\"</span>,\n <span class=\"hljs-attr\">\"token_last_eight\"</span>: <span class=\"hljs-string\">\"12345678\"</span>,\n <span class=\"hljs-attr\">\"hashed_token\"</span>: <span class=\"hljs-string\">\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\"</span>,\n <span class=\"hljs-attr\">\"app\"</span>: {\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"http://my-github-app.com\"</span>,\n <span class=\"hljs-attr\">\"name\"</span>: <span class=\"hljs-string\">\"my github app\"</span>,\n <span class=\"hljs-attr\">\"client_id\"</span>: <span class=\"hljs-string\">\"abcde12345fghij67890\"</span>\n },\n <span class=\"hljs-attr\">\"note\"</span>: <span class=\"hljs-string\">\"optional note\"</span>,\n <span class=\"hljs-attr\">\"note_url\"</span>: <span class=\"hljs-string\">\"http://optional/note/url\"</span>,\n <span class=\"hljs-attr\">\"updated_at\"</span>: <span class=\"hljs-string\">\"2011-09-06T20:39:23Z\"</span>,\n <span class=\"hljs-attr\">\"created_at\"</span>: <span class=\"hljs-string\">\"2011-09-06T17:26:27Z\"</span>,\n <span class=\"hljs-attr\">\"fingerprint\"</span>: <span class=\"hljs-string\">\"jklmnop12345678\"</span>,\n <span class=\"hljs-attr\">\"user\"</span>: {\n <span class=\"hljs-attr\">\"login\"</span>: <span class=\"hljs-string\">\"octocat\"</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"node_id\"</span>: <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span>,\n <span class=\"hljs-attr\">\"avatar_url\"</span>: <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span>,\n <span class=\"hljs-attr\">\"gravatar_id\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"followers_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span>,\n <span class=\"hljs-attr\">\"following_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span>,\n <span class=\"hljs-attr\">\"gists_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span>,\n <span class=\"hljs-attr\">\"starred_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span>,\n <span class=\"hljs-attr\">\"subscriptions_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span>,\n <span class=\"hljs-attr\">\"organizations_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span>,\n <span class=\"hljs-attr\">\"repos_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span>,\n <span class=\"hljs-attr\">\"events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span>,\n <span class=\"hljs-attr\">\"received_events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"User\"</span>,\n <span class=\"hljs-attr\">\"site_admin\"</span>: <span class=\"hljs-literal\">false</span>\n },\n <span class=\"hljs-attr\">\"installation\"</span>: {\n <span class=\"hljs-attr\">\"permissions\"</span>: {\n <span class=\"hljs-attr\">\"metadata\"</span>: <span class=\"hljs-string\">\"read\"</span>,\n <span class=\"hljs-attr\">\"issues\"</span>: <span class=\"hljs-string\">\"write\"</span>,\n <span class=\"hljs-attr\">\"contents\"</span>: <span class=\"hljs-string\">\"read\"</span>\n },\n <span class=\"hljs-attr\">\"repository_selection\"</span>: <span class=\"hljs-string\">\"selected\"</span>,\n <span class=\"hljs-attr\">\"single_file_name\"</span>: <span class=\"hljs-string\">\".github/workflow.yml\"</span>,\n <span class=\"hljs-attr\">\"repositories_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/user/repos\"</span>,\n <span class=\"hljs-attr\">\"account\"</span>: {\n <span class=\"hljs-attr\">\"login\"</span>: <span class=\"hljs-string\">\"octocat\"</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">1</span>,\n <span class=\"hljs-attr\">\"node_id\"</span>: <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span>,\n <span class=\"hljs-attr\">\"avatar_url\"</span>: <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span>,\n <span class=\"hljs-attr\">\"gravatar_id\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://github.com/octocat\"</span>,\n <span class=\"hljs-attr\">\"followers_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span>,\n <span class=\"hljs-attr\">\"following_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span>,\n <span class=\"hljs-attr\">\"gists_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span>,\n <span class=\"hljs-attr\">\"starred_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span>,\n <span class=\"hljs-attr\">\"subscriptions_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span>,\n <span class=\"hljs-attr\">\"organizations_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span>,\n <span class=\"hljs-attr\">\"repos_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span>,\n <span class=\"hljs-attr\">\"events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span>,\n <span class=\"hljs-attr\">\"received_events_url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span>,\n <span class=\"hljs-attr\">\"type\"</span>: <span class=\"hljs-string\">\"User\"</span>,\n <span class=\"hljs-attr\">\"site_admin\"</span>: <span class=\"hljs-literal\">false</span>\n },\n <span class=\"hljs-attr\">\"has_multiple_single_files\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"single_file_paths\"</span>: []\n }\n}\n</code></pre>"
41484148
},
41494149
{
41504150
"httpStatusCode": "401",
@@ -4170,12 +4170,12 @@
41704170
"bodyParameters": [
41714171
{
41724172
"type": "string",
4173-
"description": "<p><strong>Required</strong>. <strong>Required.</strong> The OAuth access token used to authenticate to the GitHub API.</p>",
4173+
"description": "<p><strong>Required</strong>. The OAuth access token used to authenticate to the GitHub API.</p>",
41744174
"example": "e72e16c7e42f292c6912e7710c838347ae178b4a",
41754175
"name": "access_token",
41764176
"in": "body",
41774177
"rawType": "string",
4178-
"rawDescription": "**Required.** The OAuth access token used to authenticate to the GitHub API.",
4178+
"rawDescription": "The OAuth access token used to authenticate to the GitHub API.",
41794179
"childParamsGroups": []
41804180
},
41814181
{

0 commit comments

Comments
 (0)