Skip to content

Commit b83ccc8

Browse files
github-openapi-botgithub-openapi-bot
authored
Update OpenAPI Descriptions (github#18828)
1 parent 9f0f159 commit b83ccc8

16 files changed

+1404
-114
lines changed

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

Lines changed: 32 additions & 9 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.18.json

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44170,7 +44170,7 @@
4417044170
"httpStatusCode": "200",
4417144171
"httpStatusMessage": "OK",
4417244172
"description": "Response",
44173-
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/repos/github/developer.github.com/pages\"</span>,\n <span class=\"hljs-attr\">\"status\"</span>: <span class=\"hljs-string\">\"built\"</span>,\n <span class=\"hljs-attr\">\"cname\"</span>: <span class=\"hljs-string\">\"developer.github.com\"</span>,\n <span class=\"hljs-attr\">\"custom_404\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://developer.github.com\"</span>,\n <span class=\"hljs-attr\">\"source\"</span>: {\n <span class=\"hljs-attr\">\"branch\"</span>: <span class=\"hljs-string\">\"master\"</span>,\n <span class=\"hljs-attr\">\"path\"</span>: <span class=\"hljs-string\">\"/\"</span>\n },\n <span class=\"hljs-attr\">\"public\"</span>: <span class=\"hljs-literal\">true</span>\n}\n</code></pre>"
44173+
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/repos/github/developer.github.com/pages\"</span>,\n <span class=\"hljs-attr\">\"status\"</span>: <span class=\"hljs-string\">\"built\"</span>,\n <span class=\"hljs-attr\">\"cname\"</span>: <span class=\"hljs-string\">\"developer.github.com\"</span>,\n <span class=\"hljs-attr\">\"custom_404\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://developer.github.com\"</span>,\n <span class=\"hljs-attr\">\"source\"</span>: {\n <span class=\"hljs-attr\">\"branch\"</span>: <span class=\"hljs-string\">\"master\"</span>,\n <span class=\"hljs-attr\">\"path\"</span>: <span class=\"hljs-string\">\"/\"</span>\n },\n <span class=\"hljs-attr\">\"public\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"https_certificate\"</span>: {\n <span class=\"hljs-attr\">\"state\"</span>: <span class=\"hljs-string\">\"approved\"</span>,\n <span class=\"hljs-attr\">\"description\"</span>: <span class=\"hljs-string\">\"Certificate is approved\"</span>,\n <span class=\"hljs-attr\">\"domains\"</span>: [\n <span class=\"hljs-string\">\"developer.github.com\"</span>\n ],\n <span class=\"hljs-attr\">\"expires_at\"</span>: <span class=\"hljs-string\">\"2021-05-22\"</span>\n },\n <span class=\"hljs-attr\">\"https_enforced\"</span>: <span class=\"hljs-literal\">true</span>\n}\n</code></pre>"
4417444174
},
4417544175
{
4417644176
"httpStatusCode": "404",
@@ -44355,7 +44355,7 @@
4435544355
"httpStatusCode": "201",
4435644356
"httpStatusMessage": "Created",
4435744357
"description": "Response",
44358-
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/repos/github/developer.github.com/pages\"</span>,\n <span class=\"hljs-attr\">\"status\"</span>: <span class=\"hljs-string\">\"built\"</span>,\n <span class=\"hljs-attr\">\"cname\"</span>: <span class=\"hljs-string\">\"developer.github.com\"</span>,\n <span class=\"hljs-attr\">\"custom_404\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://developer.github.com\"</span>,\n <span class=\"hljs-attr\">\"source\"</span>: {\n <span class=\"hljs-attr\">\"branch\"</span>: <span class=\"hljs-string\">\"master\"</span>,\n <span class=\"hljs-attr\">\"path\"</span>: <span class=\"hljs-string\">\"/\"</span>\n },\n <span class=\"hljs-attr\">\"public\"</span>: <span class=\"hljs-literal\">true</span>\n}\n</code></pre>"
44358+
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/repos/github/developer.github.com/pages\"</span>,\n <span class=\"hljs-attr\">\"status\"</span>: <span class=\"hljs-string\">\"built\"</span>,\n <span class=\"hljs-attr\">\"cname\"</span>: <span class=\"hljs-string\">\"developer.github.com\"</span>,\n <span class=\"hljs-attr\">\"custom_404\"</span>: <span class=\"hljs-literal\">false</span>,\n <span class=\"hljs-attr\">\"html_url\"</span>: <span class=\"hljs-string\">\"https://developer.github.com\"</span>,\n <span class=\"hljs-attr\">\"source\"</span>: {\n <span class=\"hljs-attr\">\"branch\"</span>: <span class=\"hljs-string\">\"master\"</span>,\n <span class=\"hljs-attr\">\"path\"</span>: <span class=\"hljs-string\">\"/\"</span>\n },\n <span class=\"hljs-attr\">\"public\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"https_certificate\"</span>: {\n <span class=\"hljs-attr\">\"state\"</span>: <span class=\"hljs-string\">\"approved\"</span>,\n <span class=\"hljs-attr\">\"description\"</span>: <span class=\"hljs-string\">\"Certificate is approved\"</span>,\n <span class=\"hljs-attr\">\"domains\"</span>: [\n <span class=\"hljs-string\">\"developer.github.com\"</span>\n ],\n <span class=\"hljs-attr\">\"expires_at\"</span>: <span class=\"hljs-string\">\"2021-05-22\"</span>\n },\n <span class=\"hljs-attr\">\"https_enforced\"</span>: <span class=\"hljs-literal\">true</span>\n}\n</code></pre>"
4435944359
},
4436044360
{
4436144361
"httpStatusCode": "409",
@@ -44479,13 +44479,13 @@
4447944479
"x-codeSamples": [
4448044480
{
4448144481
"lang": "Shell",
44482-
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"public\":true}'",
44483-
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"public\":true}'</code></pre>"
44482+
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"https_enforced\":true}'",
44483+
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/pages \\\n -d '{\"https_enforced\":true}'</code></pre>"
4448444484
},
4448544485
{
4448644486
"lang": "JavaScript",
44487-
"source": "await octokit.request('PUT /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n 'public': true\n})",
44488-
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-string\">'public'</span>: <span class=\"hljs-literal\">true</span>\n})\n</code></pre>"
44487+
"source": "await octokit.request('PUT /repos/{owner}/{repo}/pages', {\n owner: 'octocat',\n repo: 'hello-world',\n https_enforced: true\n})",
44488+
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/pages'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">https_enforced</span>: <span class=\"hljs-literal\">true</span>\n})\n</code></pre>"
4448944489
}
4449044490
],
4449144491
"summary": "Update information about a GitHub Pages site",
@@ -44504,6 +44504,15 @@
4450444504
"schema": {
4450544505
"type": "object",
4450644506
"properties": {
44507+
"https_enforced": {
44508+
"type": "boolean",
44509+
"description": "<p>Specify whether HTTPS should be enforced for the repository.</p>",
44510+
"name": "https_enforced",
44511+
"in": "body",
44512+
"rawType": "boolean",
44513+
"rawDescription": "Specify whether HTTPS should be enforced for the repository.",
44514+
"childParamsGroups": []
44515+
},
4450744516
"public": {
4450844517
"type": "boolean",
4450944518
"description": "<p>Configures access controls for the GitHub Pages site. If public is set to <code>true</code>, the site is accessible to anyone on the internet. If set to <code>false</code>, the site will only be accessible to users who have at least <code>read</code> access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to <code>internal</code> visibility. This feature is only available to repositories in an organization on an Enterprise plan.</p>",
@@ -44576,6 +44585,11 @@
4457644585
"required": [
4457744586
"public"
4457844587
]
44588+
},
44589+
{
44590+
"required": [
44591+
"https_enforced"
44592+
]
4457944593
}
4458044594
]
4458144595
},
@@ -44624,6 +44638,15 @@
4462444638
],
4462544639
"descriptionHTML": "<p>Updates information for a GitHub Enterprise Server Pages site. For more information, see \"<a href=\"/github/working-with-github-pages/about-github-pages\">About GitHub Pages</a>.</p>",
4462644640
"bodyParameters": [
44641+
{
44642+
"type": "boolean",
44643+
"description": "<p>Specify whether HTTPS should be enforced for the repository.</p>",
44644+
"name": "https_enforced",
44645+
"in": "body",
44646+
"rawType": "boolean",
44647+
"rawDescription": "Specify whether HTTPS should be enforced for the repository.",
44648+
"childParamsGroups": []
44649+
},
4462744650
{
4462844651
"type": "boolean",
4462944652
"description": "<p>Configures access controls for the GitHub Pages site. If public is set to <code>true</code>, the site is accessible to anyone on the internet. If set to <code>false</code>, the site will only be accessible to users who have at least <code>read</code> access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to <code>internal</code> visibility. This feature is only available to repositories in an organization on an Enterprise plan.</p>",

0 commit comments

Comments
 (0)