Skip to content

Commit e7735b1

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.0 Descriptions
1 parent cd38d38 commit e7735b1

16 files changed

+1040
-0
lines changed

‎descriptions/api.github.com/api.github.com.2022-11-28.json

+57
Original file line numberDiff line numberDiff line change
@@ -44734,6 +44734,63 @@
4473444734
}
4473544735
},
4473644736
"/repos/{owner}/{repo}/private-vulnerability-reporting": {
44737+
"get": {
44738+
"summary": "Check if private vulnerability reporting is enabled for a repository",
44739+
"description": "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](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".",
44740+
"tags": [
44741+
"repos"
44742+
],
44743+
"operationId": "repos/check-private-vulnerability-reporting",
44744+
"externalDocs": {
44745+
"description": "API method documentation",
44746+
"url": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository"
44747+
},
44748+
"parameters": [
44749+
{
44750+
"$ref": "#/components/parameters/owner"
44751+
},
44752+
{
44753+
"$ref": "#/components/parameters/repo"
44754+
}
44755+
],
44756+
"responses": {
44757+
"200": {
44758+
"description": "Private vulnerability reporting status",
44759+
"content": {
44760+
"application/json": {
44761+
"schema": {
44762+
"type": "object",
44763+
"properties": {
44764+
"enabled": {
44765+
"type": "boolean",
44766+
"description": "Whether or not private vulnerability reporting is enabled for the repository."
44767+
}
44768+
},
44769+
"required": [
44770+
"enabled"
44771+
]
44772+
},
44773+
"examples": {
44774+
"default": {
44775+
"value": {
44776+
"enabled": true
44777+
}
44778+
}
44779+
}
44780+
}
44781+
}
44782+
},
44783+
"422": {
44784+
"$ref": "#/components/responses/bad_request"
44785+
}
44786+
},
44787+
"x-github": {
44788+
"githubCloudOnly": false,
44789+
"enabledForGitHubApps": true,
44790+
"category": "repos",
44791+
"subcategory": "repos"
44792+
}
44793+
},
4473744794
"put": {
4473844795
"summary": "Enable private vulnerability reporting for a repository",
4473944796
"description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"",

‎descriptions/api.github.com/api.github.com.2022-11-28.yaml

+39
Original file line numberDiff line numberDiff line change
@@ -32278,6 +32278,45 @@ paths:
3227832278
category: pages
3227932279
subcategory: pages
3228032280
"/repos/{owner}/{repo}/private-vulnerability-reporting":
32281+
get:
32282+
summary: Check if private vulnerability reporting is enabled for a repository
32283+
description: Returns a boolean indicating whether or not private vulnerability
32284+
reporting is enabled for the repository. For more information, see "[Evaluating
32285+
the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)".
32286+
tags:
32287+
- repos
32288+
operationId: repos/check-private-vulnerability-reporting
32289+
externalDocs:
32290+
description: API method documentation
32291+
url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository
32292+
parameters:
32293+
- "$ref": "#/components/parameters/owner"
32294+
- "$ref": "#/components/parameters/repo"
32295+
responses:
32296+
'200':
32297+
description: Private vulnerability reporting status
32298+
content:
32299+
application/json:
32300+
schema:
32301+
type: object
32302+
properties:
32303+
enabled:
32304+
type: boolean
32305+
description: Whether or not private vulnerability reporting is
32306+
enabled for the repository.
32307+
required:
32308+
- enabled
32309+
examples:
32310+
default:
32311+
value:
32312+
enabled: true
32313+
'422':
32314+
"$ref": "#/components/responses/bad_request"
32315+
x-github:
32316+
githubCloudOnly: false
32317+
enabledForGitHubApps: true
32318+
category: repos
32319+
subcategory: repos
3228132320
put:
3228232321
summary: Enable private vulnerability reporting for a repository
3228332322
description: Enables private vulnerability reporting for a repository. The authenticated

‎descriptions/api.github.com/api.github.com.json

+57
Original file line numberDiff line numberDiff line change
@@ -44734,6 +44734,63 @@
4473444734
}
4473544735
},
4473644736
"/repos/{owner}/{repo}/private-vulnerability-reporting": {
44737+
"get": {
44738+
"summary": "Check if private vulnerability reporting is enabled for a repository",
44739+
"description": "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](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)\".",
44740+
"tags": [
44741+
"repos"
44742+
],
44743+
"operationId": "repos/check-private-vulnerability-reporting",
44744+
"externalDocs": {
44745+
"description": "API method documentation",
44746+
"url": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository"
44747+
},
44748+
"parameters": [
44749+
{
44750+
"$ref": "#/components/parameters/owner"
44751+
},
44752+
{
44753+
"$ref": "#/components/parameters/repo"
44754+
}
44755+
],
44756+
"responses": {
44757+
"200": {
44758+
"description": "Private vulnerability reporting status",
44759+
"content": {
44760+
"application/json": {
44761+
"schema": {
44762+
"type": "object",
44763+
"properties": {
44764+
"enabled": {
44765+
"type": "boolean",
44766+
"description": "Whether or not private vulnerability reporting is enabled for the repository."
44767+
}
44768+
},
44769+
"required": [
44770+
"enabled"
44771+
]
44772+
},
44773+
"examples": {
44774+
"default": {
44775+
"value": {
44776+
"enabled": true
44777+
}
44778+
}
44779+
}
44780+
}
44781+
}
44782+
},
44783+
"422": {
44784+
"$ref": "#/components/responses/bad_request"
44785+
}
44786+
},
44787+
"x-github": {
44788+
"githubCloudOnly": false,
44789+
"enabledForGitHubApps": true,
44790+
"category": "repos",
44791+
"subcategory": "repos"
44792+
}
44793+
},
4473744794
"put": {
4473844795
"summary": "Enable private vulnerability reporting for a repository",
4473944796
"description": "Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability).\"",

‎descriptions/api.github.com/api.github.com.yaml

+39
Original file line numberDiff line numberDiff line change
@@ -32278,6 +32278,45 @@ paths:
3227832278
category: pages
3227932279
subcategory: pages
3228032280
"/repos/{owner}/{repo}/private-vulnerability-reporting":
32281+
get:
32282+
summary: Check if private vulnerability reporting is enabled for a repository
32283+
description: Returns a boolean indicating whether or not private vulnerability
32284+
reporting is enabled for the repository. For more information, see "[Evaluating
32285+
the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)".
32286+
tags:
32287+
- repos
32288+
operationId: repos/check-private-vulnerability-reporting
32289+
externalDocs:
32290+
description: API method documentation
32291+
url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository
32292+
parameters:
32293+
- "$ref": "#/components/parameters/owner"
32294+
- "$ref": "#/components/parameters/repo"
32295+
responses:
32296+
'200':
32297+
description: Private vulnerability reporting status
32298+
content:
32299+
application/json:
32300+
schema:
32301+
type: object
32302+
properties:
32303+
enabled:
32304+
type: boolean
32305+
description: Whether or not private vulnerability reporting is
32306+
enabled for the repository.
32307+
required:
32308+
- enabled
32309+
examples:
32310+
default:
32311+
value:
32312+
enabled: true
32313+
'422':
32314+
"$ref": "#/components/responses/bad_request"
32315+
x-github:
32316+
githubCloudOnly: false
32317+
enabledForGitHubApps: true
32318+
category: repos
32319+
subcategory: repos
3228132320
put:
3228232321
summary: Enable private vulnerability reporting for a repository
3228332322
description: Enables private vulnerability reporting for a repository. The authenticated

0 commit comments

Comments
 (0)