jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-30 03:01:36 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #33264 from github/repo-sync

Browse Source 
Repo sync
This commit is contained in:
docs-bot
2024-05-31 00:58:32 -07:00
committed by GitHub
parent 490088a64e 3256180994
commit 0beff0209d
11 changed files with 177 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/github-apps/lib/config.json
View File

@@ -60,5 +60,5 @@
"2022-11-28"
]
},
"sha": "b771e7568b66b5f7ea7502d8c3039a33fbb153bd"
"sha": "0cc5a38280c755ac33acf9a7ea54840a421b22ea"
}

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

@@ -345624,7 +345624,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The return hash contains a <code>role</code> field which refers to the Organization Invitation role and will be one of the following values: <code>direct_member</code>, <code>admin</code>, <code>billing_manager</code>, or <code>hiring_manager</code>. If the invitee is not a GitHub member, the <code>login</code> field in the return hash will be <code>null</code>.</p>",
"descriptionHTML": "<p>The return hash contains a <code>role</code> field which refers to the Organization\nInvitation role and will be one of the following values: <code>direct_member</code>, <code>admin</code>,\n<code>billing_manager</code>, or <code>hiring_manager</code>. If the invitee is not a GitHub\nmember, the <code>login</code> field in the return hash will be <code>null</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -367965,7 +367965,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The return hash contains <code>failed_at</code> and <code>failed_reason</code> fields which represent the time at which the invitation failed and the reason for the failure.</p>",
"descriptionHTML": "<p>The return hash contains <code>failed_at</code> and <code>failed_reason</code> fields which\nrepresent the time at which the invitation failed and the reason for the failure.</p>\n<p>This endpoint is not available for <a href=\"https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users\">Enterprise Managed User (EMU) organizations</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -368345,7 +368345,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The return hash contains a <code>role</code> field which refers to the Organization Invitation role and will be one of the following values: <code>direct_member</code>, <code>admin</code>, <code>billing_manager</code>, or <code>hiring_manager</code>. If the invitee is not a GitHub Enterprise Cloud member, the <code>login</code> field in the return hash will be <code>null</code>.</p>",
"descriptionHTML": "<p>The return hash contains a <code>role</code> field which refers to the Organization\nInvitation role and will be one of the following values: <code>direct_member</code>, <code>admin</code>,\n<code>billing_manager</code>, or <code>hiring_manager</code>. If the invitee is not a GitHub Enterprise Cloud\nmember, the <code>login</code> field in the return hash will be <code>null</code>.</p>\n<p>This endpoint is not available for <a href=\"https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users\">Enterprise Managed User (EMU) organizations</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -368709,7 +368709,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>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.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\"\nand \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>",
"descriptionHTML": "<p>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.</p>\n<p>This endpoint is not available for <a href=\"https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users\">Enterprise Managed User (EMU) organizations</a>.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -368781,7 +368781,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>.</p>",
"descriptionHTML": "<p>Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.</p>\n<p>This endpoint is not available for <a href=\"https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users\">Enterprise Managed User (EMU) organizations</a>.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -369102,7 +369102,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.</p>",
"descriptionHTML": "<p>List all teams associated with an invitation. In order to see invitations\nin an organization, the authenticated user must be an organization owner.</p>\n<p>This endpoint is not available for <a href=\"https://docs.github.com/enterprise-cloud@latest//admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users\">Enterprise Managed User (EMU) organizations</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -47,5 +47,5 @@
]
}
},
"sha": "b771e7568b66b5f7ea7502d8c3039a33fbb153bd"
"sha": "0cc5a38280c755ac33acf9a7ea54840a421b22ea"
}

29
src/webhooks/data/fpt/schema.json
View File

@@ -86390,6 +86390,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -86730,6 +86737,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -87070,6 +87084,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -87091,7 +87112,6 @@
"name": "installation",
"in": "body",
"description": "<p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"<a href=\"https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\">Using webhooks with GitHub Apps</a>.\"</p>",
"isRequired": true,
"childParamsGroups": []
}
],
@@ -87418,6 +87438,13 @@
"isRequired": true,
"childParamsGroups": []
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",

29
src/webhooks/data/ghec/schema.json
View File

@@ -86454,6 +86454,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -86794,6 +86801,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -87134,6 +87148,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -87155,7 +87176,6 @@
"name": "installation",
"in": "body",
"description": "<p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\">Using webhooks with GitHub Apps</a>.\"</p>",
"isRequired": true,
"childParamsGroups": []
}
],
@@ -87482,6 +87502,13 @@
"isRequired": true,
"childParamsGroups": []
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",

29
src/webhooks/data/ghes-3.10/schema.json
View File

@@ -82386,6 +82386,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.10/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -82726,6 +82733,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.10/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -83066,6 +83080,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.10/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -83087,7 +83108,6 @@
"name": "installation",
"in": "body",
"description": "<p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.10/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\">Using webhooks with GitHub Apps</a>.\"</p>",
"isRequired": true,
"childParamsGroups": []
}
],
@@ -83414,6 +83434,13 @@
"isRequired": true,
"childParamsGroups": []
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.10/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",

29
src/webhooks/data/ghes-3.11/schema.json
View File

@@ -82515,6 +82515,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.11/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -82855,6 +82862,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.11/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -83195,6 +83209,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.11/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -83216,7 +83237,6 @@
"name": "installation",
"in": "body",
"description": "<p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.11/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\">Using webhooks with GitHub Apps</a>.\"</p>",
"isRequired": true,
"childParamsGroups": []
}
],
@@ -83543,6 +83563,13 @@
"isRequired": true,
"childParamsGroups": []
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.11/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",

29
src/webhooks/data/ghes-3.12/schema.json
View File

@@ -83679,6 +83679,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.12/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -84019,6 +84026,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.12/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -84359,6 +84373,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.12/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -84380,7 +84401,6 @@
"name": "installation",
"in": "body",
"description": "<p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.12/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\">Using webhooks with GitHub Apps</a>.\"</p>",
"isRequired": true,
"childParamsGroups": []
}
],
@@ -84707,6 +84727,13 @@
"isRequired": true,
"childParamsGroups": []
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.12/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",

29
src/webhooks/data/ghes-3.13/schema.json
View File

@@ -83694,6 +83694,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.13/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -84034,6 +84041,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.13/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -84374,6 +84388,13 @@
}
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.13/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
@@ -84395,7 +84416,6 @@
"name": "installation",
"in": "body",
"description": "<p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.13/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\">Using webhooks with GitHub Apps</a>.\"</p>",
"isRequired": true,
"childParamsGroups": []
}
],
@@ -84722,6 +84742,13 @@
"isRequired": true,
"childParamsGroups": []
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-server@3.13/admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",

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

@@ -1,3 +1,3 @@
{
"sha": "b771e7568b66b5f7ea7502d8c3039a33fbb153bd"
"sha": "0cc5a38280c755ac33acf9a7ea54840a421b22ea"
}