Skip to content

Commit 8cce792

Browse files
Update OpenAPI Descriptions (#22042)
1 parent 8d2e988 commit 8cce792

File tree

12 files changed

+1162
-0
lines changed

12 files changed

+1162
-0
lines changed

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

Lines changed: 120 additions & 0 deletions
Large diffs are not rendered by default.

lib/rest/static/decorated/ghes-2.22.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65978,6 +65978,11 @@
6597865978
"httpStatusMessage": "Created",
6597965979
"description": "Response for successful upload",
6598065980
"payload": "<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"browser_download_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"node_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"MDEyOlJlbGVhc2VBc3NldDE=\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"example.zip\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"label\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"short description\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"state\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"uploaded\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"content_type\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"application/zip\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"size\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1024</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"download_count\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">42</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"created_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2013-02-27T19:35:32Z\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"updated_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2013-02-27T19:35:32Z\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"uploader\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"login\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"octocat\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"node_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"avatar_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"gravatar_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"html_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/octocat\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"followers_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"following_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"gists_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"starred_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"subscriptions_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"organizations_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"repos_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"events_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"received_events_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"type\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"User\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"site_admin\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">false</span>\n <span class=\"hljs-punctuation\">}</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>"
65981+
},
65982+
{
65983+
"httpStatusCode": "422",
65984+
"httpStatusMessage": "Unprocessable Entity",
65985+
"description": "Response if you upload an asset with the same filename as another uploaded asset"
6598165986
}
6598265987
]
6598365988
},

lib/rest/static/decorated/ghes-3.0.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70781,6 +70781,11 @@
7078170781
"httpStatusMessage": "Created",
7078270782
"description": "Response for successful upload",
7078370783
"payload": "<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"browser_download_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"node_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"MDEyOlJlbGVhc2VBc3NldDE=\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"example.zip\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"label\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"short description\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"state\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"uploaded\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"content_type\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"application/zip\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"size\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1024</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"download_count\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">42</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"created_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2013-02-27T19:35:32Z\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"updated_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2013-02-27T19:35:32Z\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"uploader\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"login\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"octocat\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"node_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"avatar_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"gravatar_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"html_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/octocat\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"followers_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"following_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"gists_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"starred_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"subscriptions_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"organizations_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"repos_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"events_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"received_events_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"type\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"User\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"site_admin\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">false</span>\n <span class=\"hljs-punctuation\">}</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>"
70784+
},
70785+
{
70786+
"httpStatusCode": "422",
70787+
"httpStatusMessage": "Unprocessable Entity",
70788+
"description": "Response if you upload an asset with the same filename as another uploaded asset"
7078470789
}
7078570790
]
7078670791
},

lib/rest/static/decorated/ghes-3.1.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71471,6 +71471,11 @@
7147171471
"httpStatusMessage": "Created",
7147271472
"description": "Response for successful upload",
7147371473
"payload": "<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"browser_download_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"node_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"MDEyOlJlbGVhc2VBc3NldDE=\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"name\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"example.zip\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"label\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"short description\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"state\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"uploaded\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"content_type\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"application/zip\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"size\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1024</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"download_count\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">42</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"created_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2013-02-27T19:35:32Z\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"updated_at\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"2013-02-27T19:35:32Z\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"uploader\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"login\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"octocat\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-number\">1</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"node_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"MDQ6VXNlcjE=\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"avatar_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/images/error/octocat_happy.gif\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"gravatar_id\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"html_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://github.com/octocat\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"followers_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/followers\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"following_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/following{/other_user}\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"gists_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/gists{/gist_id}\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"starred_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/starred{/owner}{/repo}\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"subscriptions_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/subscriptions\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"organizations_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/orgs\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"repos_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/repos\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"events_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/events{/privacy}\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"received_events_url\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"https://api.github.com/users/octocat/received_events\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"type\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-string\">\"User\"</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"site_admin\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-keyword\">false</span>\n <span class=\"hljs-punctuation\">}</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>"
71474+
},
71475+
{
71476+
"httpStatusCode": "422",
71477+
"httpStatusMessage": "Unprocessable Entity",
71478+
"description": "Response if you upload an asset with the same filename as another uploaded asset"
7147471479
}
7147571480
]
7147671481
},

0 commit comments

Comments
 (0)