jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 03:16:52 -05:00
Code Issues Projects Releases Wiki Activity

Update OpenAPI Description (#43458)

Browse Source
This commit is contained in:
docs-bot
2023-09-28 12:09:13 -07:00
committed by GitHub
parent 580a7dd9cc
commit cc76b6994b
8 changed files with 381 additions and 7 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": "61444d47d4a539686946556ec28a14e1ed7c1fba"
"sha": "588349f3b71883016d36d3185aee4697ef812f41"
}

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

@@ -154355,7 +154355,7 @@
},
{
"httpStatusCode": "403",
"description": "<p>Response if GitHub Advanced Security is not enabled for this repository</p>"
"description": "<p>Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository</p>"
},
{
"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.",

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

@@ -166064,7 +166064,7 @@
},
{
"httpStatusCode": "403",
"description": "<p>Response if GitHub Advanced Security is not enabled for this repository</p>"
"description": "<p>Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository</p>"
},
{
"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.",

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

@@ -159846,7 +159846,7 @@
},
{
"httpStatusCode": "403",
"description": "<p>Response if GitHub Advanced Security is not enabled for this repository</p>"
"description": "<p>Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository</p>"
},
{
"httpStatusCode": "404",

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

@@ -158577,7 +158577,7 @@
},
{
"httpStatusCode": "403",
"description": "<p>Response if GitHub Advanced Security is not enabled for this repository</p>"
"description": "<p>Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository</p>"
},
{
"httpStatusCode": "404",

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

@@ -36,5 +36,5 @@
]
}
},
"sha": "61444d47d4a539686946556ec28a14e1ed7c1fba"
"sha": "588349f3b71883016d36d3185aee4697ef812f41"
}

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

@@ -214357,6 +214357,362 @@
"category": "team"
}
},
"user": {
"created": {
"descriptionHtml": "<p>A user account was added to the enterprise.</p>",
"summaryHtml": "<p>This event occurs when there is activity relating to user accounts in an enterprise.</p>",
"bodyParameters": [
{
"type": "string",
"name": "action",
"in": "body",
"description": "",
"isRequired": true,
"enum": [
"created"
],
"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": "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>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
"in": "body",
"description": "<p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "repository",
"in": "body",
"description": "<p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property\nwhen the event occurs from activity in a repository.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",
"in": "body",
"description": "<p>The GitHub user that triggered the event. This property is included in every webhook payload.</p>",
"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": "<p>A user account was removed from the enterprise.</p>",
"summaryHtml": "<p>This event occurs when there is activity relating to user accounts in an enterprise.</p>",
"bodyParameters": [
{
"type": "string",
"name": "action",
"in": "body",
"description": "",
"isRequired": true,
"enum": [
"deleted"
],
"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": "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>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
"in": "body",
"description": "<p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "repository",
"in": "body",
"description": "<p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property\nwhen the event occurs from activity in a repository.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",
"in": "body",
"description": "<p>The GitHub user that triggered the event. This property is included in every webhook payload.</p>",
"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": "<p>Someone started watching the repository.</p>",

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

@@ -1,3 +1,3 @@
{
"sha": "61444d47d4a539686946556ec28a14e1ed7c1fba"
"sha": "588349f3b71883016d36d3185aee4697ef812f41"
}