Skip to content

Commit

Permalink
Update OpenAPI Descriptions (github#22042)
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-openapi-bot
github-openapi-bot authored Oct 10, 2021
1 parent 8d2e988 commit 8cce792
Show file tree
Hide file tree
Showing 12 changed files with 1,162 additions and 0 deletions.
120 changes: 120 additions & 0 deletions lib/rest/static/decorated/api.github.com.json
View file

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions lib/rest/static/decorated/ghes-2.22.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65978,6 +65978,11 @@
"httpStatusMessage": "Created",
"description": "Response for successful upload",
"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>"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
"description": "Response if you upload an asset with the same filename as another uploaded asset"
}
]
},
Expand Down
5 changes: 5 additions & 0 deletions lib/rest/static/decorated/ghes-3.0.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70781,6 +70781,11 @@
"httpStatusMessage": "Created",
"description": "Response for successful upload",
"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>"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
"description": "Response if you upload an asset with the same filename as another uploaded asset"
}
]
},
Expand Down
5 changes: 5 additions & 0 deletions lib/rest/static/decorated/ghes-3.1.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71471,6 +71471,11 @@
"httpStatusMessage": "Created",
"description": "Response for successful upload",
"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>"
},
{
"httpStatusCode": "422",
"httpStatusMessage": "Unprocessable Entity",
"description": "Response if you upload an asset with the same filename as another uploaded asset"
}
]
},
Expand Down
Loading

0 comments on commit 8cce792

Please sign in to comment.