From 928362a36d893d14c400120e118e046edaafe69f Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Mon, 29 Jan 2024 14:40:02 -0600 Subject: [PATCH] Update OpenAPI Description (#48906) Co-authored-by: Annelisa Stephan --- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 30 ++++++++++++------- src/rest/data/ghae/schema.json | 2 +- src/rest/data/ghec-2022-11-28/schema.json | 30 ++++++++++++------- .../data/ghes-3.10-2022-11-28/schema.json | 2 +- .../data/ghes-3.11-2022-11-28/schema.json | 2 +- src/rest/data/ghes-3.8/schema.json | 2 +- src/rest/data/ghes-3.9-2022-11-28/schema.json | 2 +- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 4 +-- src/webhooks/data/ghec/schema.json | 4 +-- src/webhooks/lib/config.json | 2 +- 12 files changed, 50 insertions(+), 34 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 902aa267f8..7062aa46de 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "a4cd915fc10c3fb4b9198ee0a0c876b1de190c79" + "sha": "11e778654010c505cc7dd3d65885a3bea042ca6c" } \ 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 78a7be6272..f0ae6edd89 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -95009,7 +95009,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.

", + "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token of the target app to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -355427,9 +355427,11 @@ "null" ], "items": { - "type": "string" + "type": "string", + "maxLength": 75 }, - "description": "Ordered list of allowed values of the property" + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." }, "values_editable_by": { "type": [ @@ -355533,7 +355535,7 @@ { "type": "array of strings or null", "name": "allowed_values", - "description": "

Ordered list of allowed values of the property

" + "description": "

An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.

" }, { "type": "string or null", @@ -355658,9 +355660,11 @@ "null" ], "items": { - "type": "string" + "type": "string", + "maxLength": 75 }, - "description": "Ordered list of allowed values of the property" + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." }, "values_editable_by": { "type": [ @@ -355803,9 +355807,11 @@ "null" ], "items": { - "type": "string" + "type": "string", + "maxLength": 75 }, - "description": "Ordered list of allowed values of the property" + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." }, "values_editable_by": { "type": [ @@ -355909,7 +355915,7 @@ "type": "array of strings or null", "name": "allowed_values", "in": "body", - "description": "

Ordered list of allowed values of the property

" + "description": "

An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.

" } ], "enabledForGitHubApps": true, @@ -355994,9 +356000,11 @@ "null" ], "items": { - "type": "string" + "type": "string", + "maxLength": 75 }, - "description": "Ordered list of allowed values of the property" + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." }, "values_editable_by": { "type": [ diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index 61346b4b9e..97dbd8d350 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -65542,7 +65542,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.

", + "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token of the target app to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 0da6691897..95594e67b4 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -105347,7 +105347,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.

", + "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token of the target app to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -375471,9 +375471,11 @@ "null" ], "items": { - "type": "string" + "type": "string", + "maxLength": 75 }, - "description": "Ordered list of allowed values of the property" + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." }, "values_editable_by": { "type": [ @@ -375577,7 +375579,7 @@ { "type": "array of strings or null", "name": "allowed_values", - "description": "

Ordered list of allowed values of the property

" + "description": "

An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.

" }, { "type": "string or null", @@ -375702,9 +375704,11 @@ "null" ], "items": { - "type": "string" + "type": "string", + "maxLength": 75 }, - "description": "Ordered list of allowed values of the property" + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." }, "values_editable_by": { "type": [ @@ -375847,9 +375851,11 @@ "null" ], "items": { - "type": "string" + "type": "string", + "maxLength": 75 }, - "description": "Ordered list of allowed values of the property" + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." }, "values_editable_by": { "type": [ @@ -375953,7 +375959,7 @@ "type": "array of strings or null", "name": "allowed_values", "in": "body", - "description": "

Ordered list of allowed values of the property

" + "description": "

An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.

" } ], "enabledForGitHubApps": true, @@ -376038,9 +376044,11 @@ "null" ], "items": { - "type": "string" + "type": "string", + "maxLength": 75 }, - "description": "Ordered list of allowed values of the property" + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." }, "values_editable_by": { "type": [ diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json index 1686529030..d21e54029a 100644 --- a/src/rest/data/ghes-3.10-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json @@ -104383,7 +104383,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.

", + "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token of the target app to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.11-2022-11-28/schema.json b/src/rest/data/ghes-3.11-2022-11-28/schema.json index 2e4bb01827..29d82ea682 100644 --- a/src/rest/data/ghes-3.11-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.11-2022-11-28/schema.json @@ -104407,7 +104407,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.

", + "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token of the target app to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json index efe55cfa97..658a0672fa 100644 --- a/src/rest/data/ghes-3.8/schema.json +++ b/src/rest/data/ghes-3.8/schema.json @@ -102319,7 +102319,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.

", + "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token of the target app to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json index 3be8ca1e1c..eaa323bd1f 100644 --- a/src/rest/data/ghes-3.9-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json @@ -103401,7 +103401,7 @@ } ], "previews": [], - "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token to access this endpoint.

", + "descriptionHTML": "

Note: The :app_slug is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., https://github.com/settings/apps/:app_slug).

\n

If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a personal access token or an installation access token of the target app to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index f994b6685d..a4db73b053 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -41,5 +41,5 @@ ] } }, - "sha": "a4cd915fc10c3fb4b9198ee0a0c876b1de190c79" + "sha": "11e778654010c505cc7dd3d65885a3bea042ca6c" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 86ebae8009..6e6b631439 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -14933,7 +14933,7 @@ { "type": "array of strings or null", "name": "allowed_values", - "description": "

Ordered list of allowed values of the property

" + "description": "

An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.

" }, { "type": "string or null", @@ -15107,7 +15107,7 @@ { "type": "array of strings or null", "name": "allowed_values", - "description": "

Ordered list of allowed values of the property

" + "description": "

An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.

" }, { "type": "string or null", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 44e019369e..7a5f869212 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -14997,7 +14997,7 @@ { "type": "array of strings or null", "name": "allowed_values", - "description": "

Ordered list of allowed values of the property

" + "description": "

An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.

" }, { "type": "string or null", @@ -15171,7 +15171,7 @@ { "type": "array of strings or null", "name": "allowed_values", - "description": "

Ordered list of allowed values of the property

" + "description": "

An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.

" }, { "type": "string or null", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index b8d3ebe232..9dad4367d9 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "a4cd915fc10c3fb4b9198ee0a0c876b1de190c79" + "sha": "11e778654010c505cc7dd3d65885a3bea042ca6c" } \ No newline at end of file