From 3256180994ad6361e23fa83a39e2b6dca3427bc6 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Fri, 31 May 2024 00:37:17 -0700 Subject: [PATCH] Update OpenAPI Description (#50889) Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com> --- src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 2 +- src/rest/data/ghec-2022-11-28/schema.json | 10 ++++---- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 29 ++++++++++++++++++++++- src/webhooks/data/ghec/schema.json | 29 ++++++++++++++++++++++- src/webhooks/data/ghes-3.10/schema.json | 29 ++++++++++++++++++++++- src/webhooks/data/ghes-3.11/schema.json | 29 ++++++++++++++++++++++- src/webhooks/data/ghes-3.12/schema.json | 29 ++++++++++++++++++++++- src/webhooks/data/ghes-3.13/schema.json | 29 ++++++++++++++++++++++- src/webhooks/lib/config.json | 2 +- 11 files changed, 177 insertions(+), 15 deletions(-) diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 794c98b6cc..2ee2e4e002 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "b771e7568b66b5f7ea7502d8c3039a33fbb153bd" + "sha": "0cc5a38280c755ac33acf9a7ea54840a421b22ea" } \ 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 c496ab9cc3..1c744f762f 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -345624,7 +345624,7 @@ } ], "previews": [], - "descriptionHTML": "

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, or hiring_manager. If the invitee is not a GitHub member, the login field in the return hash will be null.

", + "descriptionHTML": "

The return hash contains a role field which refers to the Organization\nInvitation role and will be one of the following values: direct_member, admin,\nbilling_manager, or hiring_manager. If the invitee is not a GitHub\nmember, the login field in the return hash will be null.

", "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 f9c64f34ae..d5960b1f8f 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -367965,7 +367965,7 @@ } ], "previews": [], - "descriptionHTML": "

The return hash contains failed_at and failed_reason fields which represent the time at which the invitation failed and the reason for the failure.

", + "descriptionHTML": "

The return hash contains failed_at and failed_reason fields which\nrepresent the time at which the invitation failed and the reason for the failure.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

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

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, or hiring_manager. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.

", + "descriptionHTML": "

The return hash contains a role field which refers to the Organization\nInvitation role and will be one of the following values: direct_member, admin,\nbilling_manager, or hiring_manager. If the invitee is not a GitHub Enterprise Cloud\nmember, the login field in the return hash will be null.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

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

Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

", "statusCodes": [ { "httpStatusCode": "201", @@ -368781,7 +368781,7 @@ } ], "previews": [], - "descriptionHTML": "

Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

\n

This endpoint triggers notifications.

", + "descriptionHTML": "

Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

\n

This endpoint triggers notifications.

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

List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.

", + "descriptionHTML": "

List all teams associated with an invitation. In order to see invitations\nin an organization, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

", "statusCodes": [ { "httpStatusCode": "200", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index e5126c149c..cb87fe421f 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "b771e7568b66b5f7ea7502d8c3039a33fbb153bd" + "sha": "0cc5a38280c755ac33acf9a7ea54840a421b22ea" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 8a63f93c7a..3dfd36f4c1 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -86390,6 +86390,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -86730,6 +86737,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -87070,6 +87084,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -87091,7 +87112,6 @@ "name": "installation", "in": "body", "description": "

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.\"

", - "isRequired": true, "childParamsGroups": [] } ], @@ -87418,6 +87438,13 @@ "isRequired": true, "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "sender", diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 40a7027dd8..0c07188dd5 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -86454,6 +86454,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -86794,6 +86801,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -87134,6 +87148,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -87155,7 +87176,6 @@ "name": "installation", "in": "body", "description": "

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.\"

", - "isRequired": true, "childParamsGroups": [] } ], @@ -87482,6 +87502,13 @@ "isRequired": true, "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "sender", diff --git a/src/webhooks/data/ghes-3.10/schema.json b/src/webhooks/data/ghes-3.10/schema.json index a160ba203b..32d78fceea 100644 --- a/src/webhooks/data/ghes-3.10/schema.json +++ b/src/webhooks/data/ghes-3.10/schema.json @@ -82386,6 +82386,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -82726,6 +82733,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -83066,6 +83080,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -83087,7 +83108,6 @@ "name": "installation", "in": "body", "description": "

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.\"

", - "isRequired": true, "childParamsGroups": [] } ], @@ -83414,6 +83434,13 @@ "isRequired": true, "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "sender", diff --git a/src/webhooks/data/ghes-3.11/schema.json b/src/webhooks/data/ghes-3.11/schema.json index 4b56381570..d6435d7664 100644 --- a/src/webhooks/data/ghes-3.11/schema.json +++ b/src/webhooks/data/ghes-3.11/schema.json @@ -82515,6 +82515,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -82855,6 +82862,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -83195,6 +83209,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -83216,7 +83237,6 @@ "name": "installation", "in": "body", "description": "

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.\"

", - "isRequired": true, "childParamsGroups": [] } ], @@ -83543,6 +83563,13 @@ "isRequired": true, "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "sender", diff --git a/src/webhooks/data/ghes-3.12/schema.json b/src/webhooks/data/ghes-3.12/schema.json index 677604a7af..944ecb6b07 100644 --- a/src/webhooks/data/ghes-3.12/schema.json +++ b/src/webhooks/data/ghes-3.12/schema.json @@ -83679,6 +83679,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -84019,6 +84026,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -84359,6 +84373,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -84380,7 +84401,6 @@ "name": "installation", "in": "body", "description": "

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.\"

", - "isRequired": true, "childParamsGroups": [] } ], @@ -84707,6 +84727,13 @@ "isRequired": true, "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "sender", diff --git a/src/webhooks/data/ghes-3.13/schema.json b/src/webhooks/data/ghes-3.13/schema.json index ff080e8fa8..6119a7dd3a 100644 --- a/src/webhooks/data/ghes-3.13/schema.json +++ b/src/webhooks/data/ghes-3.13/schema.json @@ -83694,6 +83694,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -84034,6 +84041,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -84374,6 +84388,13 @@ } ] }, + { + "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "organization", @@ -84395,7 +84416,6 @@ "name": "installation", "in": "body", "description": "

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.\"

", - "isRequired": true, "childParamsGroups": [] } ], @@ -84722,6 +84742,13 @@ "isRequired": true, "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.\"

", + "childParamsGroups": [] + }, { "type": "object", "name": "sender", diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 207f9b6681..95299d1bd0 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "b771e7568b66b5f7ea7502d8c3039a33fbb153bd" + "sha": "0cc5a38280c755ac33acf9a7ea54840a421b22ea" } \ No newline at end of file