From 1a2855242f6cc3a4b81d2883eb4f870d30b5966c Mon Sep 17 00:00:00 2001 From: Josh Gross Date: Tue, 22 Jun 2021 17:18:46 -0400 Subject: [PATCH 1/2] Remove extra period from PR permission description (#20071) --- content/rest/reference/permissions-required-for-github-apps.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/rest/reference/permissions-required-for-github-apps.md b/content/rest/reference/permissions-required-for-github-apps.md index 517f7a35c4..eae0107db7 100644 --- a/content/rest/reference/permissions-required-for-github-apps.md +++ b/content/rest/reference/permissions-required-for-github-apps.md @@ -704,7 +704,7 @@ _Teams_ ### Permission on "pull requests" -Pull requests and issues are closely related.. If your GitHub App has permissions on pull requests but not on issues, these endpoints will be limited to pull requests. Endpoints that return both pull requests and issues will be filtered. Endpoints that allow operations on both pull requests and issues will be restricted to pull requests. +Pull requests and issues are closely related. If your GitHub App has permissions on pull requests but not on issues, these endpoints will be limited to pull requests. Endpoints that return both pull requests and issues will be filtered. Endpoints that allow operations on both pull requests and issues will be restricted to pull requests. - [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (:write) - [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (:read) From 60e5417deb2810dd4840b698646fc99c06149fee Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Tue, 22 Jun 2021 17:50:34 -0400 Subject: [PATCH 2/2] Update OpenAPI Descriptions (#20074) * Update OpenAPI Descriptions * Add decorated OpenAPI schema files Co-authored-by: github-openapi-bot --- lib/rest/static/decorated/api.github.com.json | 6 +++--- lib/rest/static/decorated/ghes-3.1.json | 6 +++--- lib/rest/static/dereferenced/api.github.com.deref.json | 4 ++-- lib/rest/static/dereferenced/ghes-3.1.deref.json | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 55e1d167f1..3f499b29b5 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -73495,14 +73495,14 @@ "descriptionHTML": "

Set to open or resolved to only list secret scanning alerts in a specific state.

" }, { - "name": "secret_types", + "name": "secret_type", "in": "query", - "description": "Set to a comma separated list of `secret_type` in order to only list secret scanning alerts for those types. Set to `all` to list all the secret scanning alerts. Default is `all`.", + "description": "A comma separated list of secret types to return. By default all secret types are returned.", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "

Set to a comma separated list of secret_type in order to only list secret scanning alerts for those types. Set to all to list all the secret scanning alerts. Default is all.

" + "descriptionHTML": "

A comma separated list of secret types to return. By default all secret types are returned.

" }, { "name": "page", diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 0331f14703..bbc01fe62b 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -71286,14 +71286,14 @@ "descriptionHTML": "

Set to open or resolved to only list secret scanning alerts in a specific state.

" }, { - "name": "secret_types", + "name": "secret_type", "in": "query", - "description": "Set to a comma separated list of `secret_type` in order to only list secret scanning alerts for those types. Set to `all` to list all the secret scanning alerts. Default is `all`.", + "description": "A comma separated list of secret types to return. By default all secret types are returned.", "required": false, "schema": { "type": "string" }, - "descriptionHTML": "

Set to a comma separated list of secret_type in order to only list secret scanning alerts for those types. Set to all to list all the secret scanning alerts. Default is all.

" + "descriptionHTML": "

A comma separated list of secret types to return. By default all secret types are returned.

" }, { "name": "page", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index abb94a8099..53e3faf3b2 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -323444,9 +323444,9 @@ } }, { - "name": "secret_types", + "name": "secret_type", "in": "query", - "description": "Set to a comma separated list of `secret_type` in order to only list secret scanning alerts for those types. Set to `all` to list all the secret scanning alerts. Default is `all`.", + "description": "A comma separated list of secret types to return. By default all secret types are returned.", "required": false, "schema": { "type": "string" diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index 20264f16b6..dac849a165 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -307188,9 +307188,9 @@ } }, { - "name": "secret_types", + "name": "secret_type", "in": "query", - "description": "Set to a comma separated list of `secret_type` in order to only list secret scanning alerts for those types. Set to `all` to list all the secret scanning alerts. Default is `all`.", + "description": "A comma separated list of secret types to return. By default all secret types are returned.", "required": false, "schema": { "type": "string"