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.

Sign up for GitHub

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.1 Descriptions #2892

Merged
merged 1 commit into from
Aug 16, 2023
Merged

Update OpenAPI 3.1 Descriptions #2892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
78 changes: 74 additions & 4 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@
"/advisories": {
"get": {
"summary": "List global security advisories",
"description": "List global security advisories and filter using parameters such as ecosystem, GHSA ID, CVE ID, etc.",
"description": "Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.\n\nBy default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see \"[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories).\"",
"tags": [
"security-advisories"
],
Expand Down Expand Up @@ -287,7 +287,7 @@
{
"name": "cwes",
"in": "query",
"description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.",
"description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.\n\nExample: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`",
"schema": {
"oneOf": [
{
Expand All @@ -313,7 +313,7 @@
{
"name": "affects",
"in": "query",
"description": "If specified, return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.",
"description": "If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.\nIf the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.\n\nExample: `affects=package1,[email protected],package3@^2.0.0` or `affects[]=package1&affects[][email protected]`",
"schema": {
"oneOf": [
{
Expand Down Expand Up @@ -42395,6 +42395,76 @@
}
}
},
"/repos/{owner}/{repo}/private-vulnerability-reporting": {
"put": {
"summary": "Enable private vulnerability reporting for a repository",
"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).\"",
"tags": [
"repos"
],
"operationId": "repos/enable-private-vulnerability-reporting",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository"
},
"parameters": [
{
"$ref": "#/components/parameters/owner"
},
{
"$ref": "#/components/parameters/repo"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/no_content"
},
"422": {
"$ref": "#/components/responses/bad_request"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "repos"
}
},
"delete": {
"summary": "Disable private vulnerability reporting for a repository",
"description": "Disables 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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-private-vulnerability-reporting",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository"
},
"parameters": [
{
"$ref": "#/components/parameters/owner"
},
{
"$ref": "#/components/parameters/repo"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/no_content"
},
"422": {
"$ref": "#/components/responses/bad_request"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "repos",
"subcategory": "repos"
}
}
},
"/repos/{owner}/{repo}/projects": {
"get": {
"summary": "List repository projects",
Expand Down Expand Up @@ -83985,7 +84055,7 @@
"null"
],
"format": "date-time",
"description": "The date and time of when the advisory was published in the National Vulnerability Database, in ISO 8601 format.",
"description": "The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format.\nThis field is only populated when the advisory is imported from the National Vulnerability Database.",
"readOnly": true
},
"withdrawn_at": {
Expand Down
Loading