From f1e6cb5e507a20892e0264341f4abd2dfd5e624b Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Fri, 27 Oct 2023 13:07:51 -0400 Subject: [PATCH] Update OpenAPI Description (#45199) Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com> --- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 110 +++++++++++++++++++--- src/rest/data/ghae/schema.json | 51 +++++++++- src/rest/data/ghec-2022-11-28/schema.json | 110 +++++++++++++++++++--- src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 6 files changed, 242 insertions(+), 35 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 61527baec6..d16d65789d 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "da0d1d1b5e111057b120425fc23d6ff891b29aba" + "sha": "85de871f74feaf766d5201a86fbba490d6cc6290" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index baf9f95f97..01ae3a1ff1 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -188282,7 +188282,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the codespaces associated to a specified organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Lists the codespaces associated to a specified organization.

\n

You must authenticate using an access token with the admin:org scope or the Organization codespaces read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -188375,7 +188375,7 @@ } ], "previews": [], - "descriptionHTML": "

Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nYou must authenticate using an access token with the admin:org scope or the Organization codespaces settings write permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -188455,7 +188455,7 @@ } ], "previews": [], - "descriptionHTML": "

Codespaces for the specified users will be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Codespaces for the specified users will be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

You must authenticate using an access token with the admin:org scope or the Organization codespaces settings write permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -188535,7 +188535,7 @@ } ], "previews": [], - "descriptionHTML": "

Codespaces for the specified users will no longer be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Codespaces for the specified users will no longer be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

You must authenticate using an access token with the admin:org scope or the Organization codespaces settings write permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -190589,7 +190589,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the codespaces that a member of an organization has for repositories in that organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Lists the codespaces that a member of an organization has for repositories in that organization.

\n

You must authenticate using an access token with the admin:org scope or the Organization codespaces read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -190679,7 +190679,7 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a user's codespace.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Deletes a user's codespace.

\n

To use this endpoint you must authenticate using one of the following methods:

\n", "statusCodes": [ { "httpStatusCode": "202", @@ -192423,7 +192423,7 @@ } ], "previews": [], - "descriptionHTML": "

Stops a user's codespace.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Stops a user's codespace.

\n

To use this endpoint you must authenticate using one of the following methods:

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -501987,6 +501987,15 @@ "schema": { "type": "string" } + }, + { + "name": "validity", + "in": "query", + "description": "

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.

", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -502127,7 +502136,8 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "resolution_comment": "Example comment" + "resolution_comment": "Example comment", + "validity": "active" }, { "number": 1, @@ -502212,7 +502222,8 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "resolution_comment": null, + "validity": "unknown" } ], "schema": { @@ -503203,6 +503214,15 @@ "null" ], "description": "The comment that was optionally added when this alert was closed" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } @@ -503338,6 +503358,15 @@ "schema": { "type": "string" } + }, + { + "name": "validity", + "in": "query", + "description": "

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.

", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -503478,7 +503507,8 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "resolution_comment": "Example comment" + "resolution_comment": "Example comment", + "validity": "active" }, { "number": 1, @@ -503563,7 +503593,8 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "resolution_comment": null, + "validity": "unknown" } ], "schema": { @@ -504554,6 +504585,15 @@ "null" ], "description": "The comment that was optionally added when this alert was closed" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } @@ -504698,6 +504738,15 @@ "schema": { "type": "string" } + }, + { + "name": "validity", + "in": "query", + "description": "

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.

", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -504772,7 +504821,8 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "resolution_comment": "Example comment" + "resolution_comment": "Example comment", + "validity": "inactive" }, { "number": 1, @@ -504790,7 +504840,8 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "resolution_comment": null, + "validity": "unknown" } ], "schema": { @@ -505238,6 +505289,15 @@ ], "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } @@ -505334,7 +505394,8 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "resolution_comment": null, + "validity": "unknown" }, "schema": { "type": "object", @@ -505779,6 +505840,15 @@ ], "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } @@ -505933,7 +506003,8 @@ "push_protection_bypassed": false, "push_protection_bypassed_by": null, "push_protection_bypassed_at": null, - "resolution_comment": "Example comment" + "resolution_comment": "Example comment", + "validity": "unknown" }, "schema": { "type": "object", @@ -506378,6 +506449,15 @@ ], "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index 1812f29477..706b2c2b1d 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -370010,6 +370010,15 @@ "schema": { "type": "string" } + }, + { + "name": "validity", + "in": "query", + "description": "

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.

", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -371195,6 +371204,15 @@ "null" ], "description": "The comment that was optionally added when this alert was closed" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } @@ -371615,6 +371633,15 @@ "secret": { "type": "string", "description": "The secret that was detected." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } @@ -371703,7 +371730,8 @@ "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations", "state": "open", "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2" + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "validity": "unknown" }, "schema": { "type": "object", @@ -371961,6 +371989,15 @@ "secret": { "type": "string", "description": "The secret that was detected." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } @@ -372111,7 +372148,8 @@ }, "secret_type": "mailchimp_api_key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "resolution_comment": "Example comment" + "resolution_comment": "Example comment", + "validity": "unknown" }, "schema": { "type": "object", @@ -372369,6 +372407,15 @@ "secret": { "type": "string", "description": "The secret that was detected." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index fb177a6c60..6303d32ad2 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -199991,7 +199991,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the codespaces associated to a specified organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Lists the codespaces associated to a specified organization.

\n

You must authenticate using an access token with the admin:org scope or the Organization codespaces read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -200084,7 +200084,7 @@ } ], "previews": [], - "descriptionHTML": "

Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nYou must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility.\nYou must authenticate using an access token with the admin:org scope or the Organization codespaces settings write permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -200164,7 +200164,7 @@ } ], "previews": [], - "descriptionHTML": "

Codespaces for the specified users will be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Codespaces for the specified users will be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

You must authenticate using an access token with the admin:org scope or the Organization codespaces settings write permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -200244,7 +200244,7 @@ } ], "previews": [], - "descriptionHTML": "

Codespaces for the specified users will no longer be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Codespaces for the specified users will no longer be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

You must authenticate using an access token with the admin:org scope or the Organization codespaces settings write permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", @@ -202298,7 +202298,7 @@ } ], "previews": [], - "descriptionHTML": "

Lists the codespaces that a member of an organization has for repositories in that organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Lists the codespaces that a member of an organization has for repositories in that organization.

\n

You must authenticate using an access token with the admin:org scope or the Organization codespaces read permission to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -202388,7 +202388,7 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a user's codespace.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Deletes a user's codespace.

\n

To use this endpoint you must authenticate using one of the following methods:

\n", "statusCodes": [ { "httpStatusCode": "202", @@ -204132,7 +204132,7 @@ } ], "previews": [], - "descriptionHTML": "

Stops a user's codespace.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Stops a user's codespace.

\n

To use this endpoint you must authenticate using one of the following methods:

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -526897,6 +526897,15 @@ "schema": { "type": "string" } + }, + { + "name": "validity", + "in": "query", + "description": "

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.

", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -527037,7 +527046,8 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "resolution_comment": "Example comment" + "resolution_comment": "Example comment", + "validity": "active" }, { "number": 1, @@ -527122,7 +527132,8 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "resolution_comment": null, + "validity": "unknown" } ], "schema": { @@ -528113,6 +528124,15 @@ "null" ], "description": "The comment that was optionally added when this alert was closed" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } @@ -528248,6 +528268,15 @@ "schema": { "type": "string" } + }, + { + "name": "validity", + "in": "query", + "description": "

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.

", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -528388,7 +528417,8 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "resolution_comment": "Example comment" + "resolution_comment": "Example comment", + "validity": "active" }, { "number": 1, @@ -528473,7 +528503,8 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "resolution_comment": null, + "validity": "unknown" } ], "schema": { @@ -529464,6 +529495,15 @@ "null" ], "description": "The comment that was optionally added when this alert was closed" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } @@ -529608,6 +529648,15 @@ "schema": { "type": "string" } + }, + { + "name": "validity", + "in": "query", + "description": "

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are active, inactive, and unknown.

", + "required": false, + "schema": { + "type": "string" + } } ], "bodyParameters": [], @@ -529682,7 +529731,8 @@ }, "push_protection_bypassed": true, "push_protection_bypassed_at": "2020-11-06T21:48:51Z", - "resolution_comment": "Example comment" + "resolution_comment": "Example comment", + "validity": "inactive" }, { "number": 1, @@ -529700,7 +529750,8 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "resolution_comment": null, + "validity": "unknown" } ], "schema": { @@ -530148,6 +530199,15 @@ ], "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } @@ -530244,7 +530304,8 @@ "push_protection_bypassed_by": null, "push_protection_bypassed": false, "push_protection_bypassed_at": null, - "resolution_comment": null + "resolution_comment": null, + "validity": "unknown" }, "schema": { "type": "object", @@ -530689,6 +530750,15 @@ ], "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } @@ -530843,7 +530913,8 @@ "push_protection_bypassed": false, "push_protection_bypassed_by": null, "push_protection_bypassed_at": null, - "resolution_comment": "Example comment" + "resolution_comment": "Example comment", + "validity": "unknown" }, "schema": { "type": "object", @@ -531288,6 +531359,15 @@ ], "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] } } } diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 1bc9704f20..e7980b45d1 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -36,5 +36,5 @@ ] } }, - "sha": "da0d1d1b5e111057b120425fc23d6ff891b29aba" + "sha": "85de871f74feaf766d5201a86fbba490d6cc6290" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index f7fffb18a2..1cd4db30c2 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "da0d1d1b5e111057b120425fc23d6ff891b29aba" + "sha": "85de871f74feaf766d5201a86fbba490d6cc6290" } \ No newline at end of file