From cc76b6994bae78df61851a7fa6557082d8a63e5f Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Thu, 28 Sep 2023 12:09:13 -0700 Subject: [PATCH] Update OpenAPI Description (#43458) --- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 11 +- src/rest/data/ghec-2022-11-28/schema.json | 11 +- .../data/ghes-3.10-2022-11-28/schema.json | 2 +- src/rest/data/ghes-3.9-2022-11-28/schema.json | 2 +- src/rest/lib/config.json | 2 +- src/webhooks/data/ghec/schema.json | 356 ++++++++++++++++++ src/webhooks/lib/config.json | 2 +- 8 files changed, 381 insertions(+), 7 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index e4b86ddbe6a3..fc164d5d114b 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "61444d47d4a539686946556ec28a14e1ed7c1fba" + "sha": "588349f3b71883016d36d3185aee4697ef812f41" } \ 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 1d5152ce6b7d..c22f3e12a660 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -154355,7 +154355,7 @@ }, { "httpStatusCode": "403", - "description": "
Response if GitHub Advanced Security is not enabled for this repository
" + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", @@ -215537,6 +215537,15 @@ "unknown" ] }, + "copilot_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, "seat_management_setting": { "type": "string", "description": "The mode of assigning new seats.", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index bc076554c2a2..d3020b80f2a1 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -166064,7 +166064,7 @@ }, { "httpStatusCode": "403", - "description": "Response if GitHub Advanced Security is not enabled for this repository
" + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", @@ -227246,6 +227246,15 @@ "unknown" ] }, + "copilot_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, "seat_management_setting": { "type": "string", "description": "The mode of assigning new seats.", 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 faaad605f7d6..6e193894229a 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 @@ -159846,7 +159846,7 @@ }, { "httpStatusCode": "403", - "description": "Response if GitHub Advanced Security is not enabled for this repository
" + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", 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 94e111f3cb8d..02bc5f0bae6b 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 @@ -158577,7 +158577,7 @@ }, { "httpStatusCode": "403", - "description": "Response if GitHub Advanced Security is not enabled for this repository
" + "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository
" }, { "httpStatusCode": "404", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index ea6da6adc98c..cc24f35a9ea0 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -36,5 +36,5 @@ ] } }, - "sha": "61444d47d4a539686946556ec28a14e1ed7c1fba" + "sha": "588349f3b71883016d36d3185aee4697ef812f41" } \ No newline at end of file diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 2a64e68a9a15..75c8d798f208 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -214357,6 +214357,362 @@ "category": "team" } }, + "user": { + "created": { + "descriptionHtml": "A user account was added to the enterprise.
", + "summaryHtml": "This event occurs when there is activity relating to user accounts in an enterprise.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub. Webhook payloads contain the enterprise
property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation
property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization
property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository
property\nwhen the event occurs from activity in a repository.
The GitHub user that triggered the event. This property is included in every webhook payload.
", + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "user", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ], + "availability": [ + "business" + ], + "action": "created", + "category": "user" + }, + "deleted": { + "descriptionHtml": "A user account was removed from the enterprise.
", + "summaryHtml": "This event occurs when there is activity relating to user accounts in an enterprise.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "deleted" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub. Webhook payloads contain the enterprise
property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation
property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization
property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository
property\nwhen the event occurs from activity in a repository.
The GitHub user that triggered the event. This property is included in every webhook payload.
", + "childParamsGroups": [] + }, + { + "type": "object or null", + "name": "user", + "in": "body", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + } + ], + "availability": [ + "business" + ], + "action": "deleted", + "category": "user" + } + }, "watch": { "started": { "descriptionHtml": "Someone started watching the repository.
", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 5f9649cd1757..e2cb614872dd 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "61444d47d4a539686946556ec28a14e1ed7c1fba" + "sha": "588349f3b71883016d36d3185aee4697ef812f41" } \ No newline at end of file