Skip to content

Commit 0400060

Browse files
Update OpenAPI 3.1 Descriptions
1 parent 443ffa6 commit 0400060

16 files changed

+1716
-116
lines changed

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

Lines changed: 74 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@
207207
"/advisories": {
208208
"get": {
209209
"summary": "List global security advisories",
210-
"description": "List global security advisories and filter using parameters such as ecosystem, GHSA ID, CVE ID, etc.",
210+
"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).\"",
211211
"tags": [
212212
"security-advisories"
213213
],
@@ -287,7 +287,7 @@
287287
{
288288
"name": "cwes",
289289
"in": "query",
290-
"description": "If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.",
290+
"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`",
291291
"schema": {
292292
"oneOf": [
293293
{
@@ -313,7 +313,7 @@
313313
{
314314
"name": "affects",
315315
"in": "query",
316-
"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.",
316+
"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]`",
317317
"schema": {
318318
"oneOf": [
319319
{
@@ -42395,6 +42395,76 @@
4239542395
}
4239642396
}
4239742397
},
42398+
"/repos/{owner}/{repo}/private-vulnerability-reporting": {
42399+
"put": {
42400+
"summary": "Enable private vulnerability reporting for a repository",
42401+
"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).\"",
42402+
"tags": [
42403+
"repos"
42404+
],
42405+
"operationId": "repos/enable-private-vulnerability-reporting",
42406+
"externalDocs": {
42407+
"description": "API method documentation",
42408+
"url": "https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository"
42409+
},
42410+
"parameters": [
42411+
{
42412+
"$ref": "#/components/parameters/owner"
42413+
},
42414+
{
42415+
"$ref": "#/components/parameters/repo"
42416+
}
42417+
],
42418+
"responses": {
42419+
"204": {
42420+
"$ref": "#/components/responses/no_content"
42421+
},
42422+
"422": {
42423+
"$ref": "#/components/responses/bad_request"
42424+
}
42425+
},
42426+
"x-github": {
42427+
"githubCloudOnly": false,
42428+
"enabledForGitHubApps": true,
42429+
"category": "repos",
42430+
"subcategory": "repos"
42431+
}
42432+
},
42433+
"delete": {
42434+
"summary": "Disable private vulnerability reporting for a repository",
42435+
"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)\".",
42436+
"tags": [
42437+
"repos"
42438+
],
42439+
"operationId": "repos/disable-private-vulnerability-reporting",
42440+
"externalDocs": {
42441+
"description": "API method documentation",
42442+
"url": "https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository"
42443+
},
42444+
"parameters": [
42445+
{
42446+
"$ref": "#/components/parameters/owner"
42447+
},
42448+
{
42449+
"$ref": "#/components/parameters/repo"
42450+
}
42451+
],
42452+
"responses": {
42453+
"204": {
42454+
"$ref": "#/components/responses/no_content"
42455+
},
42456+
"422": {
42457+
"$ref": "#/components/responses/bad_request"
42458+
}
42459+
},
42460+
"x-github": {
42461+
"githubCloudOnly": false,
42462+
"enabledForGitHubApps": true,
42463+
"category": "repos",
42464+
"subcategory": "repos"
42465+
}
42466+
}
42467+
},
4239842468
"/repos/{owner}/{repo}/projects": {
4239942469
"get": {
4240042470
"summary": "List repository projects",
@@ -83985,7 +84055,7 @@
8398584055
"null"
8398684056
],
8398784057
"format": "date-time",
83988-
"description": "The date and time of when the advisory was published in the National Vulnerability Database, in ISO 8601 format.",
84058+
"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.",
8398984059
"readOnly": true
8399084060
},
8399184061
"withdrawn_at": {

0 commit comments

Comments
 (0)