Skip to content

Commit 22b0b09

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #3451 from github/openapi-update-f61197f0c561d63a51b25bf2f7365af6e88bae17fe573c48684b97c9962fc5b9
Update OpenAPI 3.1 Descriptions
2 parents af01132 + 7705f54 commit 22b0b09

16 files changed

+1072
-0
lines changed

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

+57
Original file line numberDiff line numberDiff line change
@@ -44963,6 +44963,63 @@
4496344963
}
4496444964
},
4496544965
"/repos/{owner}/{repo}/private-vulnerability-reporting": {
44966+
"get": {
44967+
"summary": "Check if private vulnerability reporting is enabled for a repository",
44968+
"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)\".",
44969+
"tags": [
44970+
"repos"
44971+
],
44972+
"operationId": "repos/check-private-vulnerability-reporting",
44973+
"externalDocs": {
44974+
"description": "API method documentation",
44975+
"url": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository"
44976+
},
44977+
"parameters": [
44978+
{
44979+
"$ref": "#/components/parameters/owner"
44980+
},
44981+
{
44982+
"$ref": "#/components/parameters/repo"
44983+
}
44984+
],
44985+
"responses": {
44986+
"200": {
44987+
"description": "Private vulnerability reporting status",
44988+
"content": {
44989+
"application/json": {
44990+
"schema": {
44991+
"type": "object",
44992+
"properties": {
44993+
"enabled": {
44994+
"type": "boolean",
44995+
"description": "Whether or not private vulnerability reporting is enabled for the repository."
44996+
}
44997+
},
44998+
"required": [
44999+
"enabled"
45000+
]
45001+
},
45002+
"examples": {
45003+
"default": {
45004+
"value": {
45005+
"enabled": true
45006+
}
45007+
}
45008+
}
45009+
}
45010+
}
45011+
},
45012+
"422": {
45013+
"$ref": "#/components/responses/bad_request"
45014+
}
45015+
},
45016+
"x-github": {
45017+
"githubCloudOnly": false,
45018+
"enabledForGitHubApps": true,
45019+
"category": "repos",
45020+
"subcategory": "repos"
45021+
}
45022+
},
4496645023
"put": {
4496745024
"summary": "Enable private vulnerability reporting for a repository",
4496845025
"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-next/api.github.com/api.github.com.2022-11-28.yaml

+39
Original file line numberDiff line numberDiff line change
@@ -32393,6 +32393,45 @@ paths:
3239332393
category: pages
3239432394
subcategory: pages
3239532395
"/repos/{owner}/{repo}/private-vulnerability-reporting":
32396+
get:
32397+
summary: Check if private vulnerability reporting is enabled for a repository
32398+
description: Returns a boolean indicating whether or not private vulnerability
32399+
reporting is enabled for the repository. For more information, see "[Evaluating
32400+
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)".
32401+
tags:
32402+
- repos
32403+
operationId: repos/check-private-vulnerability-reporting
32404+
externalDocs:
32405+
description: API method documentation
32406+
url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository
32407+
parameters:
32408+
- "$ref": "#/components/parameters/owner"
32409+
- "$ref": "#/components/parameters/repo"
32410+
responses:
32411+
'200':
32412+
description: Private vulnerability reporting status
32413+
content:
32414+
application/json:
32415+
schema:
32416+
type: object
32417+
properties:
32418+
enabled:
32419+
type: boolean
32420+
description: Whether or not private vulnerability reporting is
32421+
enabled for the repository.
32422+
required:
32423+
- enabled
32424+
examples:
32425+
default:
32426+
value:
32427+
enabled: true
32428+
'422':
32429+
"$ref": "#/components/responses/bad_request"
32430+
x-github:
32431+
githubCloudOnly: false
32432+
enabledForGitHubApps: true
32433+
category: repos
32434+
subcategory: repos
3239632435
put:
3239732436
summary: Enable private vulnerability reporting for a repository
3239832437
description: Enables private vulnerability reporting for a repository. The authenticated

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

+57
Original file line numberDiff line numberDiff line change
@@ -44963,6 +44963,63 @@
4496344963
}
4496444964
},
4496544965
"/repos/{owner}/{repo}/private-vulnerability-reporting": {
44966+
"get": {
44967+
"summary": "Check if private vulnerability reporting is enabled for a repository",
44968+
"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)\".",
44969+
"tags": [
44970+
"repos"
44971+
],
44972+
"operationId": "repos/check-private-vulnerability-reporting",
44973+
"externalDocs": {
44974+
"description": "API method documentation",
44975+
"url": "https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository"
44976+
},
44977+
"parameters": [
44978+
{
44979+
"$ref": "#/components/parameters/owner"
44980+
},
44981+
{
44982+
"$ref": "#/components/parameters/repo"
44983+
}
44984+
],
44985+
"responses": {
44986+
"200": {
44987+
"description": "Private vulnerability reporting status",
44988+
"content": {
44989+
"application/json": {
44990+
"schema": {
44991+
"type": "object",
44992+
"properties": {
44993+
"enabled": {
44994+
"type": "boolean",
44995+
"description": "Whether or not private vulnerability reporting is enabled for the repository."
44996+
}
44997+
},
44998+
"required": [
44999+
"enabled"
45000+
]
45001+
},
45002+
"examples": {
45003+
"default": {
45004+
"value": {
45005+
"enabled": true
45006+
}
45007+
}
45008+
}
45009+
}
45010+
}
45011+
},
45012+
"422": {
45013+
"$ref": "#/components/responses/bad_request"
45014+
}
45015+
},
45016+
"x-github": {
45017+
"githubCloudOnly": false,
45018+
"enabledForGitHubApps": true,
45019+
"category": "repos",
45020+
"subcategory": "repos"
45021+
}
45022+
},
4496645023
"put": {
4496745024
"summary": "Enable private vulnerability reporting for a repository",
4496845025
"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-next/api.github.com/api.github.com.yaml

+39
Original file line numberDiff line numberDiff line change
@@ -32393,6 +32393,45 @@ paths:
3239332393
category: pages
3239432394
subcategory: pages
3239532395
"/repos/{owner}/{repo}/private-vulnerability-reporting":
32396+
get:
32397+
summary: Check if private vulnerability reporting is enabled for a repository
32398+
description: Returns a boolean indicating whether or not private vulnerability
32399+
reporting is enabled for the repository. For more information, see "[Evaluating
32400+
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)".
32401+
tags:
32402+
- repos
32403+
operationId: repos/check-private-vulnerability-reporting
32404+
externalDocs:
32405+
description: API method documentation
32406+
url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository
32407+
parameters:
32408+
- "$ref": "#/components/parameters/owner"
32409+
- "$ref": "#/components/parameters/repo"
32410+
responses:
32411+
'200':
32412+
description: Private vulnerability reporting status
32413+
content:
32414+
application/json:
32415+
schema:
32416+
type: object
32417+
properties:
32418+
enabled:
32419+
type: boolean
32420+
description: Whether or not private vulnerability reporting is
32421+
enabled for the repository.
32422+
required:
32423+
- enabled
32424+
examples:
32425+
default:
32426+
value:
32427+
enabled: true
32428+
'422':
32429+
"$ref": "#/components/responses/bad_request"
32430+
x-github:
32431+
githubCloudOnly: false
32432+
enabledForGitHubApps: true
32433+
category: repos
32434+
subcategory: repos
3239632435
put:
3239732436
summary: Enable private vulnerability reporting for a repository
3239832437
description: Enables private vulnerability reporting for a repository. The authenticated

0 commit comments

Comments
 (0)