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] 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 55e1d167f18f..3f499b29b5c3 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 0331f1470384..bbc01fe62b85 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 abb94a8099c8..53e3faf3b25e 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 20264f16b6e0..dac849a16590 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"