1
0
mirror of synced 2026-01-07 09:01:31 -05:00

Update OpenAPI Descriptions (#29408)

* Update OpenAPI  Descriptions

* Add decorated OpenAPI schema files

* Add new pages override (#29446)

* update decorated files

Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Rachael Sewell <rachmari@github.com>
This commit is contained in:
github-openapi-bot
2022-07-28 13:40:47 -07:00
committed by GitHub
parent ccb9cd28e3
commit 2255a2c8f7
17 changed files with 919 additions and 63 deletions

View File

@@ -270559,7 +270559,7 @@
"response": {
"statusCode": "200",
"contentType": "application/json",
"description": "<ul>\n<li><code>w</code> - Start of the week, given as a <a href=\"http://en.wikipedia.org/wiki/Unix_time\">Unix timestamp</a>.</li>\n<li><code>a</code> - Number of additions</li>\n<li><code>d</code> - Number of deletions</li>\n<li><code>c</code> - Number of commits</li>\n</ul>",
"description": "<p>Response</p>",
"example": [
{
"author": {
@@ -270818,7 +270818,7 @@
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<ul>\n<li><code>w</code> - Start of the week, given as a <a href=\"http://en.wikipedia.org/wiki/Unix_time\">Unix timestamp</a>.</li>\n<li><code>a</code> - Number of additions</li>\n<li><code>d</code> - Number of deletions</li>\n<li><code>c</code> - Number of commits</li>\n</ul>"
"description": "<p>OK</p>"
},
{
"httpStatusCode": "202",
@@ -291785,6 +291785,20 @@
}
],
"bodyParameters": [
{
"type": "string",
"description": "<p>The process in which the Page will be built. Possible values are <code>\"legacy\"</code> and <code>\"workflow\"</code>.</p>",
"enum": [
"legacy",
"workflow"
],
"name": "build_type",
"in": "body",
"rawType": "string",
"rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.",
"isRequired": false,
"childParamsGroups": []
},
{
"type": "object",
"description": "<p>The source branch and directory used to publish your Pages site.</p>",
@@ -292169,6 +292183,20 @@
"isRequired": false,
"childParamsGroups": []
},
{
"type": "string",
"description": "<p>The process by which the GitHub Pages site will be built. <code>workflow</code> means that the site is built by a custom GitHub Actions workflow. <code>legacy</code> means that the site is built by GitHub when changes are pushed to a specific branch.</p>",
"enum": [
"legacy",
"workflow"
],
"name": "build_type",
"in": "body",
"rawType": "string",
"rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.",
"isRequired": false,
"childParamsGroups": []
},
{
"anyOf": [
{
@@ -350300,7 +350328,7 @@
"response": {
"statusCode": "200",
"contentType": "application/json",
"description": "<p>To download the asset's binary content, set the <code>Accept</code> header of the request to <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\"><code>application/octet-stream</code></a>. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a <code>200</code> or <code>302</code> response.</p>",
"description": "<p>Response</p>",
"example": {
"url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1",
"browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip",
@@ -350585,7 +350613,7 @@
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>To download the asset's binary content, set the <code>Accept</code> header of the request to <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types\"><code>application/octet-stream</code></a>. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a <code>200</code> or <code>302</code> response.</p>"
"description": "<p>OK</p>"
},
{
"httpStatusCode": "302",
@@ -361762,12 +361790,12 @@
},
{
"type": "boolean",
"description": "<p>Either <code>true</code> to make the repository private or <code>false</code> to make it public. Default: <code>false</code>.<br>\n<strong>Note</strong>: You will get a <code>422</code> error if the organization restricts <a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories\">changing repository visibility</a> to organization owners and a non-owner tries to change the value of private. <strong>Note</strong>: You will get a <code>422</code> error if the organization restricts <a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories\">changing repository visibility</a> to organization owners and a non-owner tries to change the value of private.</p>",
"description": "<p>Either <code>true</code> to make the repository private or <code>false</code> to make it public. Default: <code>false</code>.<br>\n<strong>Note</strong>: You will get a <code>422</code> error if the organization restricts <a href=\"https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories\">changing repository visibility</a> to organization owners and a non-owner tries to change the value of private.</p>",
"default": false,
"name": "private",
"in": "body",
"rawType": "boolean",
"rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.",
"rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.",
"isRequired": false,
"childParamsGroups": []
},