From 18a9c91060767dea7cc82cb3e0af5959268d23ba Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Fri, 8 Mar 2024 14:39:42 -0500 Subject: [PATCH] Update OpenAPI Description (#49599) Co-authored-by: hubwriter Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com> --- .../fine-grained-pat-permissions.json | 9 ++ .../data/fpt-2022-11-28/fine-grained-pat.json | 6 ++ .../server-to-server-permissions.json | 11 +++ .../fpt-2022-11-28/server-to-server-rest.json | 6 ++ .../fpt-2022-11-28/user-to-server-rest.json | 6 ++ .../fine-grained-pat-permissions.json | 9 ++ .../ghec-2022-11-28/fine-grained-pat.json | 6 ++ .../server-to-server-permissions.json | 11 +++ .../server-to-server-rest.json | 6 ++ .../ghec-2022-11-28/user-to-server-rest.json | 6 ++ src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 86 +++++++++++++++++++ src/rest/data/ghec-2022-11-28/schema.json | 86 +++++++++++++++++++ src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 15 files changed, 251 insertions(+), 3 deletions(-) diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index 5ff3e6a888..e7b411366b 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -5316,6 +5316,15 @@ "additional-permissions": false, "access": "read" }, + { + "category": "repos", + "slug": "check-if-private-vulnerability-reporting-is-enabled-for-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting", + "additional-permissions": false, + "access": "read" + }, { "category": "repos", "slug": "get-all-custom-property-values-for-a-repository", diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index 7fda109421..4eb32642d0 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -4236,6 +4236,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages" }, + { + "slug": "check-if-private-vulnerability-reporting-is-enabled-for-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting" + }, { "slug": "enable-private-vulnerability-reporting-for-a-repository", "subcategory": "repos", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index f7962ccfe9..377f5b144e 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -6461,6 +6461,17 @@ "server-to-server": true, "additional-permissions": false }, + { + "category": "repos", + "slug": "check-if-private-vulnerability-reporting-is-enabled-for-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "repos", "slug": "get-all-custom-property-values-for-a-repository", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index b4bda8112c..ef8fad168c 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -3768,6 +3768,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages" }, + { + "slug": "check-if-private-vulnerability-reporting-is-enabled-for-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting" + }, { "slug": "enable-private-vulnerability-reporting-for-a-repository", "subcategory": "repos", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index 7fda109421..4eb32642d0 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -4236,6 +4236,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages" }, + { + "slug": "check-if-private-vulnerability-reporting-is-enabled-for-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting" + }, { "slug": "enable-private-vulnerability-reporting-for-a-repository", "subcategory": "repos", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index 94546a48e0..302859fac7 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -6000,6 +6000,15 @@ "additional-permissions": false, "access": "read" }, + { + "category": "repos", + "slug": "check-if-private-vulnerability-reporting-is-enabled-for-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting", + "additional-permissions": false, + "access": "read" + }, { "category": "repos", "slug": "get-all-custom-property-values-for-a-repository", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index f77ab3733d..d0b58ddce3 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -4564,6 +4564,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages" }, + { + "slug": "check-if-private-vulnerability-reporting-is-enabled-for-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting" + }, { "slug": "enable-private-vulnerability-reporting-for-a-repository", "subcategory": "repos", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index d587bf6c2b..dc51d2ff72 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -7293,6 +7293,17 @@ "server-to-server": true, "additional-permissions": false }, + { + "category": "repos", + "slug": "check-if-private-vulnerability-reporting-is-enabled-for-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "repos", "slug": "get-all-custom-property-values-for-a-repository", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index 5e569e0371..62f15714a8 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -4096,6 +4096,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages" }, + { + "slug": "check-if-private-vulnerability-reporting-is-enabled-for-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting" + }, { "slug": "enable-private-vulnerability-reporting-for-a-repository", "subcategory": "repos", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index f77ab3733d..d0b58ddce3 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -4564,6 +4564,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/languages" }, + { + "slug": "check-if-private-vulnerability-reporting-is-enabled-for-a-repository", + "subcategory": "repos", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting" + }, { "slug": "enable-private-vulnerability-reporting-for-a-repository", "subcategory": "repos", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 05d1ebf4c8..5975432b58 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "cd38d382a152e312524b1fe0f24acf46f25f74c5" + "sha": "22b0b09a28a8dbb71f7af81ec01cdf146e394fa6" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 78a04c5868..41f61152f3 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -448691,6 +448691,92 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting", + "title": "Check if private vulnerability reporting is enabled for a repository", + "category": "repos", + "subcategory": "repos", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "metadata": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Private vulnerability reporting status

", + "example": { + "enabled": true + }, + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether or not private vulnerability reporting is enabled for the repository." + } + }, + "required": [ + "enabled" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"Evaluating the security settings of a repository\".

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Private vulnerability reporting status

" + }, + { + "httpStatusCode": "422", + "description": "

Bad Request

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "put", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 299a23a9d2..878e062183 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -471570,6 +471570,92 @@ } ] }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/private-vulnerability-reporting", + "title": "Check if private vulnerability reporting is enabled for a repository", + "category": "repos", + "subcategory": "repos", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "enabledForGitHubApps": true, + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "metadata": "read" + } + ], + "allowsPublicRead": true + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Private vulnerability reporting status

", + "example": { + "enabled": true + }, + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether or not private vulnerability reporting is enabled for the repository." + } + }, + "required": [ + "enabled" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"Evaluating the security settings of a repository\".

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

Private vulnerability reporting status

" + }, + { + "httpStatusCode": "422", + "description": "

Bad Request

" + } + ] + }, { "serverUrl": "https://api.github.com", "verb": "put", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index c8abf9eab9..de2c104efd 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -44,5 +44,5 @@ ] } }, - "sha": "cd38d382a152e312524b1fe0f24acf46f25f74c5" + "sha": "22b0b09a28a8dbb71f7af81ec01cdf146e394fa6" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 9b87b02b86..6e0208105f 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "cd38d382a152e312524b1fe0f24acf46f25f74c5" + "sha": "22b0b09a28a8dbb71f7af81ec01cdf146e394fa6" } \ No newline at end of file