Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update OpenAPI 3.0 Descriptions #2818

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions descriptions/api.github.com/api.github.com.2022-11-28.json
Original file line number Diff line number Diff line change
Expand Up @@ -47567,6 +47567,54 @@
}
}
},
"/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": {
"post": {
"summary": "Request a CVE for a repository security advisory",
"description": "If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional).\"\n\nYou may request a CVE for public repositories, but cannot do so for private repositories.\n\nYou must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.\n\nIn order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository.",
"tags": [
"security-advisories"
],
"operationId": "security-advisories/create-repository-advisory-cve-request",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory"
},
"parameters": [
{
"$ref": "#/components/parameters/owner"
},
{
"$ref": "#/components/parameters/repo"
},
{
"$ref": "#/components/parameters/ghsa_id"
}
],
"responses": {
"202": {
"$ref": "#/components/responses/accepted"
},
"400": {
"$ref": "#/components/responses/bad_request"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/not_found"
},
"422": {
"$ref": "#/components/responses/validation_failed"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "security-advisories",
"subcategory": "repository-advisories"
}
}
},
"/repos/{owner}/{repo}/stargazers": {
"get": {
"summary": "List stargazers",
Expand Down
37 changes: 37 additions & 0 deletions descriptions/api.github.com/api.github.com.2022-11-28.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33884,6 +33884,43 @@ paths:
enabledForGitHubApps: true
category: security-advisories
subcategory: repository-advisories
"/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve":
post:
summary: Request a CVE for a repository security advisory
description: |-
If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)."

You may request a CVE for public repositories, but cannot do so for private repositories.

You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint.

In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository.
tags:
- security-advisories
operationId: security-advisories/create-repository-advisory-cve-request
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/security-advisories/repository-advisories#request-a-cve-for-a-repository-security-advisory
parameters:
- "$ref": "#/components/parameters/owner"
- "$ref": "#/components/parameters/repo"
- "$ref": "#/components/parameters/ghsa_id"
responses:
'202':
"$ref": "#/components/responses/accepted"
'400':
"$ref": "#/components/responses/bad_request"
'403':
"$ref": "#/components/responses/forbidden"
'404':
"$ref": "#/components/responses/not_found"
'422':
"$ref": "#/components/responses/validation_failed"
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: security-advisories
subcategory: repository-advisories
"/repos/{owner}/{repo}/stargazers":
get:
summary: List stargazers
Expand Down
Loading
Loading