Skip to content

Update OpenAPI Descriptions #54

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.

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
merged 1 commit into from
Oct 14, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 10 additions & 4 deletions descriptions/api.github.com/api.github.com.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "1.1.0",
"version": "1.1.1",
"title": "GitHub v3 REST API",
"description": "GitHub's v3 REST API.",
"license": {
Expand Down Expand Up @@ -21107,7 +21107,7 @@
"/repos/{owner}/{repo}/check-runs": {
"post": {
"summary": "Create a check run",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
"tags": [
"checks"
],
Expand Down Expand Up @@ -22197,7 +22197,7 @@
}
},
"404": {
"description": "Response if the ref doesn't match an existing ref"
"description": "Response if the ref does not match an existing ref"
},
"503": {
"$ref": "#/components/responses/service_unavailable"
Expand Down Expand Up @@ -22337,8 +22337,11 @@
}
}
},
"403": {
"description": "Response if the repository is archived"
},
"503": {
"description": "When code scanning isn't available you can try again at a later time"
"description": "Response when code scanning is not available and you should try again at a later time"
}
},
"x-github": {
Expand Down Expand Up @@ -22489,6 +22492,9 @@
"202": {
"description": "response"
},
"403": {
"description": "Response if the repository is archived"
},
"404": {
"description": "Response if `commit_sha` or `ref` cannot be found"
}
Expand Down
14 changes: 10 additions & 4 deletions descriptions/api.github.com/api.github.com.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
openapi: 3.0.3
info:
version: 1.1.0
version: 1.1.1
title: GitHub v3 REST API
description: GitHub's v3 REST API.
license:
Expand Down Expand Up @@ -15130,6 +15130,8 @@ paths:
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
tags:
- checks
operationId: checks/create
Expand Down Expand Up @@ -15993,7 +15995,7 @@ paths:
default:
"$ref": "#/components/examples/code-scanning-alert-code-scanning-alert-items"
'404':
description: Response if the ref doesn't match an existing ref
description: Response if the ref does not match an existing ref
'503':
"$ref": "#/components/responses/service_unavailable"
x-github:
Expand Down Expand Up @@ -16083,9 +16085,11 @@ paths:
examples:
default:
"$ref": "#/components/examples/code-scanning-alert-code-scanning-alert-dismissed"
'403':
description: Response if the repository is archived
'503':
description: When code scanning isn't available you can try again at a later
time
description: Response when code scanning is not available and you should
try again at a later time
x-github:
enabledForApps: true
githubCloudOnly: false
Expand Down Expand Up @@ -16193,6 +16197,8 @@ paths:
responses:
'202':
description: response
'403':
description: Response if the repository is archived
'404':
description: Response if `commit_sha` or `ref` cannot be found
x-github:
Expand Down
14 changes: 10 additions & 4 deletions descriptions/api.github.com/dereferenced/api.github.com.deref.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "1.1.0",
"version": "1.1.1",
"title": "GitHub v3 REST API",
"description": "GitHub's v3 REST API.",
"license": {
Expand Down Expand Up @@ -116148,7 +116148,7 @@
"/repos/{owner}/{repo}/check-runs": {
"post": {
"summary": "Create a check run",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
"tags": [
"checks"
],
Expand Down Expand Up @@ -123639,7 +123639,7 @@
}
},
"404": {
"description": "Response if the ref doesn't match an existing ref"
"description": "Response if the ref does not match an existing ref"
},
"503": {
"description": "Service Unavailable",
Expand Down Expand Up @@ -124500,8 +124500,11 @@
}
}
},
"403": {
"description": "Response if the repository is archived"
},
"503": {
"description": "When code scanning isn't available you can try again at a later time"
"description": "Response when code scanning is not available and you should try again at a later time"
}
},
"x-github": {
Expand Down Expand Up @@ -124736,6 +124739,9 @@
"202": {
"description": "response"
},
"403": {
"description": "Response if the repository is archived"
},
"404": {
"description": "Response if `commit_sha` or `ref` cannot be found"
}
Expand Down
14 changes: 10 additions & 4 deletions descriptions/api.github.com/dereferenced/api.github.com.deref.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
openapi: 3.0.3
info:
version: 1.1.0
version: 1.1.1
title: GitHub v3 REST API
description: GitHub's v3 REST API.
license:
Expand Down Expand Up @@ -88850,6 +88850,8 @@ paths:
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
tags:
- checks
operationId: checks/create
Expand Down Expand Up @@ -94780,7 +94782,7 @@ paths:
name: CodeQL command-line toolchain
version:
'404':
description: Response if the ref doesn't match an existing ref
description: Response if the ref does not match an existing ref
'503':
description: Service Unavailable
content:
Expand Down Expand Up @@ -95444,9 +95446,11 @@ paths:
tool:
name: CodeQL command-line toolchain
version:
'403':
description: Response if the repository is archived
'503':
description: When code scanning isn't available you can try again at a later
time
description: Response when code scanning is not available and you should
try again at a later time
x-github:
enabledForApps: true
githubCloudOnly: false
Expand Down Expand Up @@ -95634,6 +95638,8 @@ paths:
responses:
'202':
description: response
'403':
description: Response if the repository is archived
'404':
description: Response if `commit_sha` or `ref` cannot be found
x-github:
Expand Down
4 changes: 2 additions & 2 deletions descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "1.1.0",
"version": "1.1.1",
"title": "GitHub v3 REST API",
"description": "GitHub's v3 REST API.",
"license": {
Expand Down Expand Up @@ -74516,7 +74516,7 @@
"/repos/{owner}/{repo}/check-runs": {
"post": {
"summary": "Create a check run",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
"tags": [
"checks"
],
Expand Down
4 changes: 3 additions & 1 deletion descriptions/ghes-2.18/dereferenced/ghes-2.18.deref.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
openapi: 3.0.3
info:
version: 1.1.0
version: 1.1.1
title: GitHub v3 REST API
description: GitHub's v3 REST API.
license:
Expand Down Expand Up @@ -56631,6 +56631,8 @@ paths:
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
tags:
- checks
operationId: checks/create
Expand Down
4 changes: 2 additions & 2 deletions descriptions/ghes-2.18/ghes-2.18.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "1.1.0",
"version": "1.1.1",
"title": "GitHub v3 REST API",
"description": "GitHub's v3 REST API.",
"license": {
Expand Down Expand Up @@ -13536,7 +13536,7 @@
"/repos/{owner}/{repo}/check-runs": {
"post": {
"summary": "Create a check run",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
"tags": [
"checks"
],
Expand Down
4 changes: 3 additions & 1 deletion descriptions/ghes-2.18/ghes-2.18.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
openapi: 3.0.3
info:
version: 1.1.0
version: 1.1.1
title: GitHub v3 REST API
description: GitHub's v3 REST API.
license:
Expand Down Expand Up @@ -9747,6 +9747,8 @@ paths:
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
tags:
- checks
operationId: checks/create
Expand Down
4 changes: 2 additions & 2 deletions descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "1.1.0",
"version": "1.1.1",
"title": "GitHub v3 REST API",
"description": "GitHub's v3 REST API.",
"license": {
Expand Down Expand Up @@ -77401,7 +77401,7 @@
"/repos/{owner}/{repo}/check-runs": {
"post": {
"summary": "Create a check run",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
"tags": [
"checks"
],
Expand Down
4 changes: 3 additions & 1 deletion descriptions/ghes-2.19/dereferenced/ghes-2.19.deref.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
openapi: 3.0.3
info:
version: 1.1.0
version: 1.1.1
title: GitHub v3 REST API
description: GitHub's v3 REST API.
license:
Expand Down Expand Up @@ -58803,6 +58803,8 @@ paths:
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
tags:
- checks
operationId: checks/create
Expand Down
4 changes: 2 additions & 2 deletions descriptions/ghes-2.19/ghes-2.19.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "1.1.0",
"version": "1.1.1",
"title": "GitHub v3 REST API",
"description": "GitHub's v3 REST API.",
"license": {
Expand Down Expand Up @@ -13873,7 +13873,7 @@
"/repos/{owner}/{repo}/check-runs": {
"post": {
"summary": "Create a check run",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
"tags": [
"checks"
],
Expand Down
4 changes: 3 additions & 1 deletion descriptions/ghes-2.19/ghes-2.19.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
openapi: 3.0.3
info:
version: 1.1.0
version: 1.1.1
title: GitHub v3 REST API
description: GitHub's v3 REST API.
license:
Expand Down Expand Up @@ -9976,6 +9976,8 @@ paths:
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
tags:
- checks
operationId: checks/create
Expand Down
4 changes: 2 additions & 2 deletions descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "1.1.0",
"version": "1.1.1",
"title": "GitHub v3 REST API",
"description": "GitHub's v3 REST API.",
"license": {
Expand Down Expand Up @@ -78496,7 +78496,7 @@
"/repos/{owner}/{repo}/check-runs": {
"post": {
"summary": "Create a check run",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
"description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.",
"tags": [
"checks"
],
Expand Down
4 changes: 3 additions & 1 deletion descriptions/ghes-2.20/dereferenced/ghes-2.20.deref.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
openapi: 3.0.3
info:
version: 1.1.0
version: 1.1.1
title: GitHub v3 REST API
description: GitHub's v3 REST API.
license:
Expand Down Expand Up @@ -59776,6 +59776,8 @@ paths:
**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.

Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.

In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
tags:
- checks
operationId: checks/create
Expand Down
Loading