Skip to content

Update OpenAPI 3.0 Descriptions #1611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timrogers merged 1 commit into from
Sep 27, 2022
Merged

Update OpenAPI 3.0 Descriptions #1611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions descriptions/api.github.com/api.github.com.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25665,12 +25665,12 @@
"summary": {
"type": "string",
"maxLength": 65535,
"description": "The summary of the check run. This parameter supports Markdown."
"description": "The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
},
"text": {
"type": "string",
"maxLength": 65535,
"description": "The details of the check run. This parameter supports Markdown."
"description": "The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
},
"annotations": {
"type": "array",
Expand Down Expand Up @@ -39510,7 +39510,7 @@
},
"post": {
"summary": "Create a GitHub Pages site",
"description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
"description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\" You must be an admin of the repository in order to use this operation.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -39618,7 +39618,6 @@
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "pages"
}
},
Expand Down Expand Up @@ -39769,7 +39768,7 @@
},
"delete": {
"summary": "Delete a GitHub Pages site",
"description": "",
"description": "Deletes a GitHub Pages site. You must be an admin of the repository in order to use this operation.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -39802,7 +39801,6 @@
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "pages"
}
}
Expand Down
16 changes: 8 additions & 8 deletions descriptions/api.github.com/api.github.com.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18455,13 +18455,13 @@ paths:
summary:
type: string
maxLength: 65535
description: The summary of the check run. This parameter supports
Markdown.
description: 'The summary of the check run. This parameter supports
Markdown. **Maximum length**: 65535 characters.'
text:
type: string
maxLength: 65535
description: The details of the check run. This parameter supports
Markdown.
description: 'The details of the check run. This parameter supports
Markdown. **Maximum length**: 65535 characters.'
annotations:
type: array
description: Adds information from your analysis to specific
Expand Down Expand Up @@ -28568,7 +28568,8 @@ paths:
post:
summary: Create a GitHub Pages site
description: Configures a GitHub Pages site. For more information, see "[About
GitHub Pages](/github/working-with-github-pages/about-github-pages)."
GitHub Pages](/github/working-with-github-pages/about-github-pages)." You
must be an admin of the repository in order to use this operation.
tags:
- repos
operationId: repos/create-pages-site
Expand Down Expand Up @@ -28642,7 +28643,6 @@ paths:
"$ref": "#/components/responses/conflict"
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pages
put:
summary: Update information about a GitHub Pages site
Expand Down Expand Up @@ -28754,7 +28754,8 @@ paths:
category: pages
delete:
summary: Delete a GitHub Pages site
description: ''
description: Deletes a GitHub Pages site. You must be an admin of the repository
in order to use this operation.
tags:
- repos
operationId: repos/delete-pages-site
Expand All @@ -28775,7 +28776,6 @@ paths:
"$ref": "#/components/responses/conflict"
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pages
"/repos/{owner}/{repo}/pages/builds":
get:
Expand Down
10 changes: 4 additions & 6 deletions descriptions/api.github.com/dereferenced/api.github.com.deref.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190922,12 +190922,12 @@
"summary": {
"type": "string",
"maxLength": 65535,
"description": "The summary of the check run. This parameter supports Markdown."
"description": "The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
},
"text": {
"type": "string",
"maxLength": 65535,
"description": "The details of the check run. This parameter supports Markdown."
"description": "The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
},
"annotations": {
"type": "array",
Expand Down Expand Up @@ -335902,7 +335902,7 @@
},
"post": {
"summary": "Create a GitHub Pages site",
"description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
"description": "Configures a GitHub Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\" You must be an admin of the repository in order to use this operation.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -336278,7 +336278,6 @@
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "pages"
}
},
Expand Down Expand Up @@ -336587,7 +336586,7 @@
},
"delete": {
"summary": "Delete a GitHub Pages site",
"description": "",
"description": "Deletes a GitHub Pages site. You must be an admin of the repository in order to use this operation.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -336744,7 +336743,6 @@
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "pages"
}
}
Expand Down
16 changes: 8 additions & 8 deletions descriptions/api.github.com/dereferenced/api.github.com.deref.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38481,13 +38481,13 @@ paths:
summary:
type: string
maxLength: 65535
description: The summary of the check run. This parameter supports
Markdown.
description: 'The summary of the check run. This parameter supports
Markdown. **Maximum length**: 65535 characters.'
text:
type: string
maxLength: 65535
description: The details of the check run. This parameter supports
Markdown.
description: 'The details of the check run. This parameter supports
Markdown. **Maximum length**: 65535 characters.'
annotations:
type: array
description: Adds information from your analysis to specific
Expand Down Expand Up @@ -59257,7 +59257,8 @@ paths:
post:
summary: Create a GitHub Pages site
description: Configures a GitHub Pages site. For more information, see "[About
GitHub Pages](/github/working-with-github-pages/about-github-pages)."
GitHub Pages](/github/working-with-github-pages/about-github-pages)." You
must be an admin of the repository in order to use this operation.
tags:
- repos
operationId: repos/create-pages-site
Expand Down Expand Up @@ -59327,7 +59328,6 @@ paths:
'409': *228
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pages
put:
summary: Update information about a GitHub Pages site
Expand Down Expand Up @@ -59436,7 +59436,8 @@ paths:
category: pages
delete:
summary: Delete a GitHub Pages site
description: ''
description: Deletes a GitHub Pages site. You must be an admin of the repository
in order to use this operation.
tags:
- repos
operationId: repos/delete-pages-site
Expand All @@ -59454,7 +59455,6 @@ paths:
'409': *228
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pages
"/repos/{owner}/{repo}/pages/builds":
get:
Expand Down
10 changes: 4 additions & 6 deletions descriptions/ghec/dereferenced/ghec.deref.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194235,12 +194235,12 @@
"summary": {
"type": "string",
"maxLength": 65535,
"description": "The summary of the check run. This parameter supports Markdown."
"description": "The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
},
"text": {
"type": "string",
"maxLength": 65535,
"description": "The details of the check run. This parameter supports Markdown."
"description": "The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters."
},
"annotations": {
"type": "array",
Expand Down Expand Up @@ -339215,7 +339215,7 @@
},
"post": {
"summary": "Create a GitHub Enterprise Cloud Pages site",
"description": "Configures a GitHub Enterprise Cloud Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"",
"description": "Configures a GitHub Enterprise Cloud Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\" You must be an admin of the repository in order to use this operation.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -339591,7 +339591,6 @@
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "pages"
}
},
Expand Down Expand Up @@ -339900,7 +339899,7 @@
},
"delete": {
"summary": "Delete a GitHub Enterprise Cloud Pages site",
"description": "",
"description": "Deletes a GitHub Pages site. You must be an admin of the repository in order to use this operation.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -340057,7 +340056,6 @@
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "pages"
}
}
Expand Down
14 changes: 7 additions & 7 deletions descriptions/ghec/dereferenced/ghec.deref.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39962,13 +39962,13 @@ paths:
summary:
type: string
maxLength: 65535
description: The summary of the check run. This parameter supports
Markdown.
description: 'The summary of the check run. This parameter supports
Markdown. **Maximum length**: 65535 characters.'
text:
type: string
maxLength: 65535
description: The details of the check run. This parameter supports
Markdown.
description: 'The details of the check run. This parameter supports
Markdown. **Maximum length**: 65535 characters.'
annotations:
type: array
description: Adds information from your analysis to specific
Expand Down Expand Up @@ -60740,6 +60740,7 @@ paths:
summary: Create a GitHub Enterprise Cloud Pages site
description: Configures a GitHub Enterprise Cloud Pages site. For more information,
see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)."
You must be an admin of the repository in order to use this operation.
tags:
- repos
operationId: repos/create-pages-site
Expand Down Expand Up @@ -60809,7 +60810,6 @@ paths:
'409': *251
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pages
put:
summary: Update information about a GitHub Enterprise Cloud Pages site
Expand Down Expand Up @@ -60918,7 +60918,8 @@ paths:
category: pages
delete:
summary: Delete a GitHub Enterprise Cloud Pages site
description: ''
description: Deletes a GitHub Pages site. You must be an admin of the repository
in order to use this operation.
tags:
- repos
operationId: repos/delete-pages-site
Expand All @@ -60936,7 +60937,6 @@ paths:
'409': *251
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pages
"/repos/{owner}/{repo}/pages/builds":
get:
Expand Down
Loading