jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-02-01 03:01:50 -05:00
Code Issues Projects Releases Wiki Activity

Update OpenAPI Description (#48906)

Browse Source 
Co-authored-by: Annelisa Stephan <meowius@github.com>
This commit is contained in:
docs-bot
2024-01-29 14:40:02 -06:00
committed by GitHub
parent 3ab2473f07
commit 928362a36d
12 changed files with 50 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/rest/data/fpt-2022-11-28/schema.json
View File

@@ -95009,7 +95009,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> of the target app to access this endpoint.</p>",
"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": "<p>Ordered list of allowed values of the property</p>"
"description": "<p>An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.</p>"
},
{
"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": "<p>Ordered list of allowed values of the property</p>"
"description": "<p>An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.</p>"
}
],
"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": [

2
src/rest/data/ghae/schema.json
View File

@@ -65542,7 +65542,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/github-ae@latest/articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/github-ae@latest/articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> of the target app to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

30
src/rest/data/ghec-2022-11-28/schema.json
View File

@@ -105347,7 +105347,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/enterprise-cloud@latest//articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/enterprise-cloud@latest//articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> of the target app to access this endpoint.</p>",
"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": "<p>Ordered list of allowed values of the property</p>"
"description": "<p>An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.</p>"
},
{
"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": "<p>Ordered list of allowed values of the property</p>"
"description": "<p>An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.</p>"
}
],
"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": [

2
src/rest/data/ghes-3.10-2022-11-28/schema.json
View File

@@ -104383,7 +104383,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/enterprise-server@3.10/articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/enterprise-server@3.10/articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> of the target app to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

2
src/rest/data/ghes-3.11-2022-11-28/schema.json
View File

@@ -104407,7 +104407,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/enterprise-server@3.11/articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/enterprise-server@3.11/articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> of the target app to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

2
src/rest/data/ghes-3.8/schema.json
View File

@@ -102319,7 +102319,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/enterprise-server@3.8/articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/enterprise-server@3.8/articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> of the target app to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

2
src/rest/data/ghes-3.9-2022-11-28/schema.json
View File

@@ -103401,7 +103401,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/enterprise-server@3.9/articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> to access this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: The <code>:app_slug</code> is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., <code>https://github.com/settings/apps/:app_slug</code>).</p>\n<p>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 <a href=\"https://docs.github.com/enterprise-server@3.9/articles/creating-a-personal-access-token-for-the-command-line/\">personal access token</a> or an <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation\">installation access token</a> of the target app to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

2
src/rest/lib/config.json
View File

@@ -41,5 +41,5 @@
]
}
},
"sha": "a4cd915fc10c3fb4b9198ee0a0c876b1de190c79"
"sha": "11e778654010c505cc7dd3d65885a3bea042ca6c"
}