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

Merge branch 'main' into repo-sync

Browse Source
This commit is contained in:
Octomerger Bot
2023-04-12 12:38:22 -04:00
committed by GitHub
parent 3de367fcb7 a829fc75c1
commit 3adc8dbedb
28 changed files with 13663 additions and 7631 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
assets/images/internal-docs/copy-block-header.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

BIN
assets/images/internal-docs/search-results.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 112 KiB

5
content/rest/dependency-graph/index.md
View File

@@ -1,6 +1,8 @@
---
title: Dependency Graph
intro: Use the REST API to view dependency changes and their security impact on your repository.
intro: >-
Use the REST API to view dependency changes and their security impact on your
repository.
versions:
fpt: '*'
ghes: '>=3.6'
@@ -10,6 +12,7 @@ topics:
children:
- /dependency-review
- /dependency-submission
- /sboms
redirect_from:
- /rest/reference/dependency-graph
autogenerated: rest

14
content/rest/dependency-graph/sboms.md Normal file
View File

@@ -0,0 +1,14 @@
---
title: Software bill of materials (SBOM)
shortTitle: Software bill of materials (SBOM)
intro: 'Use the REST API to export the software bill of materials (SBOM) for a repository.'
versions:
fpt: '*'
ghec: '*'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
---
<!-- Content after this section is automatically generated -->

5
content/rest/orgs/index.md
View File

@@ -1,6 +1,8 @@
---
title: Organizations
intro: 'Use the REST API to control and manage all your {% data variables.product.product_name %} organizations.'
intro: >-
Use the REST API to control and manage all your {% data
variables.product.product_name %} organizations.
allowTitleToDifferFromFilename: true
redirect_from:
- /v3/orgs
@@ -18,6 +20,7 @@ children:
- /custom-roles
- /members
- /outside-collaborators
- /personal-access-tokens
- /security-managers
- /webhooks
autogenerated: rest

20
content/rest/orgs/personal-access-tokens.md Normal file
View File

@@ -0,0 +1,20 @@
---
title: Personal access tokens
shortTitle: Personal access tokens
intro: 'Use the REST API to manage {% data variables.product.pat_v2 %}s.'
versions:
fpt: '*'
ghec: '*'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
---
{% note %}
**Note**: {% data reusables.user-settings.pat-v2-beta %}
{% endnote %}
<!-- Content after this section is automatically generated -->

2
content/rest/users/social-accounts.md
View File

@@ -12,3 +12,5 @@ autogenerated: rest
## About social account administration
{% data reusables.user-settings.user-api %}
<!-- Content after this section is automatically generated -->

2
lib/render-content/README.md
View File

@@ -47,6 +47,6 @@ You can add a header to code blocks by adding the `{:copy}` annotation after the
This renders:
![image](https://user-images.githubusercontent.com/10660468/95881747-e96c6900-0d46-11eb-9abf-1e8ad16c7646.png)
![Screenshot of a code block showing the clipboard icon that is displayed when you use `{:copy}` annotation.](/assets/images/internal-docs/copy-block-header.png)
The un-highlighted text is available as `button.js-btn-copy`'s `data-clipboard-text` attribute.

16
src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
View File

@@ -2288,49 +2288,49 @@
},
{
"slug": "list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-token-requests"
},
{
"slug": "review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-token-requests"
},
{
"slug": "review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}"
},
{
"slug": "list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}/repositories"
},
{
"slug": "list-fine-grained-personal-access-tokens-with-access-to-organization-resources",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-tokens"
},
{
"slug": "update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-tokens"
},
{
"slug": "update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}"
},
{
"slug": "list-repositories-a-fine-grained-personal-access-token-has-access-to",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}/repositories"
},

16
src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
View File

@@ -2400,49 +2400,49 @@
},
{
"slug": "list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-token-requests"
},
{
"slug": "review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-token-requests"
},
{
"slug": "review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}"
},
{
"slug": "list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}/repositories"
},
{
"slug": "list-fine-grained-personal-access-tokens-with-access-to-organization-resources",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-tokens"
},
{
"slug": "update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-tokens"
},
{
"slug": "update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}"
},
{
"slug": "list-repositories-a-fine-grained-personal-access-token-has-access-to",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}/repositories"
},

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

@@ -1,3 +1,3 @@
{
"sha": "e27c8f10a2208e6a8df88e64d2b40c9c7a1ecd2d"
"sha": "e462c64f50b84f040ac76cd2205984ddf151b67f"
}

12
src/rest/data/client-side-rest-api-redirects.json
View File

@@ -232,18 +232,10 @@
"/rest/activity#set-a-thread-subscription": "/rest/activity/notifications#set-a-thread-subscription",
"/rest/activity#delete-a-thread-subscription": "/rest/activity/notifications#delete-a-thread-subscription",
"/rest/orgs#list-organizations": "/rest/orgs/orgs#list-organizations",
"/rest/orgs/orgs#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens": "/rest/orgs/orgs#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens",
"/rest/orgs#orgs": "/rest/orgs/orgs",
"/rest/orgs/orgs#review-requests-to-access-organization-resources-with-a-fine-grained-personal-access-token": "/rest/orgs/orgs#review-requests-to-access-organization-resources-with-a-fine-grained-personal-access-token",
"/rest/orgs/orgs#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token": "/rest/orgs/orgs#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token",
"/rest/orgs/orgs#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token": "/rest/orgs/orgs#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token",
"/rest/orgs/orgs#list-fine-grained-personal-access-tokens-with-access-to-organization-resources": "/rest/orgs/orgs#list-fine-grained-personal-access-tokens-with-access-to-organization-resources",
"/rest/orgs/orgs#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens": "/rest/orgs/orgs#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens",
"/rest/orgs/orgs#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources": "/rest/orgs/orgs#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources",
"/rest/orgs/orgs#list-repositories-a-fine-grained-personal-access-token-has-access-to": "/rest/orgs/orgs#list-repositories-a-fine-grained-personal-access-token-has-access-to",
"/rest/orgs#get-an-organization": "/rest/orgs/orgs#get-an-organization",
"/rest/orgs#update-an-organization": "/rest/orgs/orgs#update-an-organization",
"/rest/orgs/orgs/#delete-an-organization": "/rest/orgs/orgs#delete-an-organization",
"/rest/orgs#orgs": "/rest/orgs/orgs",
"/rest/actions#get-github-actions-cache-usage-for-an-organization": "/rest/actions/cache#get-github-actions-cache-usage-for-an-organization",
"/rest/actions#cache": "/rest/actions/cache",
"/rest/actions#list-repositories-with-github-actions-cache-usage-for-an-organization": "/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization",
@@ -638,6 +630,8 @@
"/rest/dependabot#delete-a-repository-secret": "/rest/dependabot/secrets#delete-a-repository-secret",
"/rest/dependency-graph#get-a-diff-of-the-dependencies-between-commits": "/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits",
"/rest/dependency-graph#dependency-review": "/rest/dependency-graph/dependency-review",
"/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository": "/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository",
"/rest/dependency-graph#sboms": "/rest/dependency-graph/sboms",
"/rest/dependency-graph#create-a-snapshot-of-dependencies-for-a-repository": "/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository",
"/rest/dependency-graph#dependency-submission": "/rest/dependency-graph/dependency-submission",
"/rest/deployments/deployments#list-deployments": "/rest/deployments/deployments#list-deployments",

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

715
src/rest/data/ghes-3.4/schema.json
View File

File diff suppressed because it is too large Load Diff

715
src/rest/data/ghes-3.5/schema.json
View File

File diff suppressed because it is too large Load Diff

715
src/rest/data/ghes-3.6/schema.json
View File

File diff suppressed because it is too large Load Diff

723
src/rest/data/ghes-3.7/schema.json
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

@@ -23,8 +23,12 @@
"targetDirectory": "content/rest",
"indexOrder": {
"content/rest/index.md": {
"startsWith": ["quickstart", "overview", "guides"]
"startsWith": [
"quickstart",
"overview",
"guides"
]
}
},
"sha": "e27c8f10a2208e6a8df88e64d2b40c9c7a1ecd2d"
"sha": "e462c64f50b84f040ac76cd2205984ddf151b67f"
}

2
src/search/README.md
View File

@@ -8,7 +8,7 @@ To see all existing search-related issues and pull requests, visit [github.com/g
---
![search-screenshot](https://user-images.githubusercontent.com/2289/65067899-68bd1c80-d93c-11e9-93ec-f57293e56113.png)
![Screenshot of the search results page for GitHub docs with the example keywords "private key".](/assets/images/internal-docs/search-results.png)
---

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

@@ -68822,6 +68822,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -68857,6 +68867,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -69169,6 +69188,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -69204,6 +69233,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -69232,7 +69270,7 @@
}
},
"merge_group": {
"default": {
"checks_requested": {
"descriptionHtml": "<p>Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.</p>\n<p>When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.</p>",
"summaryHtml": "<p>This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"<a href=\"https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue\">Managing a merge queue</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in public beta and subject to change.</p>",
"bodyParameters": [
@@ -69242,6 +69280,9 @@
"in": "body",
"description": "",
"isRequired": true,
"enum": [
"checks_requested"
],
"childParamsGroups": []
},
{
@@ -69401,7 +69442,7 @@
"availability": [
"app"
],
"action": "default",
"action": "checks_requested",
"category": "merge_group"
}
},
@@ -94738,6 +94779,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -98046,6 +98092,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -108083,6 +108134,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -124518,6 +124574,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -127826,6 +127887,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -131134,6 +131200,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -196884,6 +196955,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -196919,6 +197000,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197100,6 +197190,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197135,6 +197235,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197315,6 +197424,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197350,6 +197469,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197529,6 +197657,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197564,6 +197702,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197651,6 +197798,19 @@
}
]
},
{
"type": "object",
"name": "notification_setting",
"description": "",
"childParamsGroups": [
{
"type": "string",
"name": "from",
"description": "<p>The previous version of the team's notification setting if the action was <code>edited</code>.</p>",
"isRequired": true
}
]
},
{
"type": "object",
"name": "repository",
@@ -197830,6 +197990,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197865,6 +198035,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -198045,6 +198224,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -198080,6 +198269,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",

369
src/webhooks/data/ghae/schema.json
View File

@@ -65602,6 +65602,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -65637,6 +65647,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -65949,6 +65968,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -65984,6 +66013,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -66011,180 +66049,6 @@
"category": "membership"
}
},
"merge_group": {
"default": {
"descriptionHtml": "<p>Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.</p>\n<p>When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.</p>",
"summaryHtml": "<p>This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"<a href=\"https://docs.github.com/github-ae@latest/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue\">Managing a merge queue</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in public beta and subject to change.</p>",
"bodyParameters": [
{
"type": "string",
"name": "action",
"in": "body",
"description": "",
"isRequired": true,
"childParamsGroups": []
},
{
"type": "object",
"name": "installation",
"in": "body",
"description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "merge_group",
"in": "body",
"description": "",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "head_sha",
"description": "<p>The SHA of the merge group.</p>",
"isRequired": true
},
{
"type": "string",
"name": "head_ref",
"description": "<p>The full ref of the merge group.</p>",
"isRequired": true
},
{
"type": "string",
"name": "base_sha",
"description": "<p>The SHA of the merge group's parent commit.</p>",
"isRequired": true
},
{
"type": "string",
"name": "base_ref",
"description": "<p>The full ref of the branch the merge group will be merged into.</p>",
"isRequired": true
},
{
"type": "object",
"name": "head_commit",
"description": "",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "author",
"description": "<p>Metaproperties for Git author/committer information.</p>",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "date",
"description": ""
},
{
"type": "string or null",
"name": "email",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "<p>The git author's name.</p>",
"isRequired": true
},
{
"type": "string",
"name": "username",
"description": ""
}
]
},
{
"type": "object",
"name": "committer",
"description": "<p>Metaproperties for Git author/committer information.</p>",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "date",
"description": ""
},
{
"type": "string or null",
"name": "email",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "<p>The git author's name.</p>",
"isRequired": true
},
{
"type": "string",
"name": "username",
"description": ""
}
]
},
{
"type": "string",
"name": "id",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "message",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "timestamp",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "tree_id",
"description": "",
"isRequired": true
}
]
}
]
},
{
"type": "object",
"name": "organization",
"in": "body",
"description": "<p>A GitHub organization.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "repository",
"in": "body",
"description": "<p>A repository on GitHub.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",
"in": "body",
"description": "<p>A GitHub user.</p>",
"childParamsGroups": []
}
],
"availability": [
"app"
],
"action": "default",
"category": "merge_group"
}
},
"meta": {
"deleted": {
"descriptionHtml": "<p>The webhook was deleted.</p>",
@@ -88033,6 +87897,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -91341,6 +91210,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -98159,6 +98033,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -111382,6 +111261,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -114690,6 +114574,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -117998,6 +117887,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -179824,6 +179718,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -179859,6 +179763,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -180040,6 +179953,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -180075,6 +179998,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -180255,6 +180187,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -180290,6 +180232,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -180469,6 +180420,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -180504,6 +180465,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -180591,6 +180561,19 @@
}
]
},
{
"type": "object",
"name": "notification_setting",
"description": "",
"childParamsGroups": [
{
"type": "string",
"name": "from",
"description": "<p>The previous version of the team's notification setting if the action was <code>edited</code>.</p>",
"isRequired": true
}
]
},
{
"type": "object",
"name": "repository",
@@ -180770,6 +180753,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -180805,6 +180798,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -180985,6 +180987,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -181020,6 +181032,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",

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

@@ -68822,6 +68822,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -68857,6 +68867,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -69169,6 +69188,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -69204,6 +69233,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -69232,7 +69270,7 @@
}
},
"merge_group": {
"default": {
"checks_requested": {
"descriptionHtml": "<p>Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.</p>\n<p>When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.</p>",
"summaryHtml": "<p>This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue\">Managing a merge queue</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in public beta and subject to change.</p>",
"bodyParameters": [
@@ -69242,6 +69280,9 @@
"in": "body",
"description": "",
"isRequired": true,
"enum": [
"checks_requested"
],
"childParamsGroups": []
},
{
@@ -69401,7 +69442,7 @@
"availability": [
"app"
],
"action": "default",
"action": "checks_requested",
"category": "merge_group"
}
},
@@ -94738,6 +94779,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -98046,6 +98092,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -108083,6 +108134,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -124518,6 +124574,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -127826,6 +127887,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -131134,6 +131200,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -196884,6 +196955,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -196919,6 +197000,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197100,6 +197190,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197135,6 +197235,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197315,6 +197424,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197350,6 +197469,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197529,6 +197657,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197564,6 +197702,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197651,6 +197798,19 @@
}
]
},
{
"type": "object",
"name": "notification_setting",
"description": "",
"childParamsGroups": [
{
"type": "string",
"name": "from",
"description": "<p>The previous version of the team's notification setting if the action was <code>edited</code>.</p>",
"isRequired": true
}
]
},
{
"type": "object",
"name": "repository",
@@ -197830,6 +197990,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -197865,6 +198035,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -198045,6 +198224,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -198080,6 +198269,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",

369
src/webhooks/data/ghes-3.7/schema.json
View File

@@ -65833,6 +65833,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -65868,6 +65878,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -66180,6 +66199,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -66215,6 +66244,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -66242,180 +66280,6 @@
"category": "membership"
}
},
"merge_group": {
"default": {
"descriptionHtml": "<p>Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.</p>\n<p>When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.</p>",
"summaryHtml": "<p>This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue\">Managing a merge queue</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in public beta and subject to change.</p>",
"bodyParameters": [
{
"type": "string",
"name": "action",
"in": "body",
"description": "",
"isRequired": true,
"childParamsGroups": []
},
{
"type": "object",
"name": "installation",
"in": "body",
"description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "merge_group",
"in": "body",
"description": "",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "head_sha",
"description": "<p>The SHA of the merge group.</p>",
"isRequired": true
},
{
"type": "string",
"name": "head_ref",
"description": "<p>The full ref of the merge group.</p>",
"isRequired": true
},
{
"type": "string",
"name": "base_sha",
"description": "<p>The SHA of the merge group's parent commit.</p>",
"isRequired": true
},
{
"type": "string",
"name": "base_ref",
"description": "<p>The full ref of the branch the merge group will be merged into.</p>",
"isRequired": true
},
{
"type": "object",
"name": "head_commit",
"description": "",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "author",
"description": "<p>Metaproperties for Git author/committer information.</p>",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "date",
"description": ""
},
{
"type": "string or null",
"name": "email",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "<p>The git author's name.</p>",
"isRequired": true
},
{
"type": "string",
"name": "username",
"description": ""
}
]
},
{
"type": "object",
"name": "committer",
"description": "<p>Metaproperties for Git author/committer information.</p>",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "date",
"description": ""
},
{
"type": "string or null",
"name": "email",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "<p>The git author's name.</p>",
"isRequired": true
},
{
"type": "string",
"name": "username",
"description": ""
}
]
},
{
"type": "string",
"name": "id",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "message",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "timestamp",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "tree_id",
"description": "",
"isRequired": true
}
]
}
]
},
{
"type": "object",
"name": "organization",
"in": "body",
"description": "<p>A GitHub organization.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "repository",
"in": "body",
"description": "<p>A repository on GitHub.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",
"in": "body",
"description": "<p>A GitHub user.</p>",
"childParamsGroups": []
}
],
"availability": [
"app"
],
"action": "default",
"category": "merge_group"
}
},
"meta": {
"deleted": {
"descriptionHtml": "<p>The webhook was deleted.</p>",
@@ -87412,6 +87276,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -90720,6 +90589,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -97538,6 +97412,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -110761,6 +110640,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -114069,6 +113953,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -117377,6 +117266,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -181616,6 +181510,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -181651,6 +181555,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -181832,6 +181745,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -181867,6 +181790,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182047,6 +181979,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182082,6 +182024,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182261,6 +182212,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182296,6 +182257,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182383,6 +182353,19 @@
}
]
},
{
"type": "object",
"name": "notification_setting",
"description": "",
"childParamsGroups": [
{
"type": "string",
"name": "from",
"description": "<p>The previous version of the team's notification setting if the action was <code>edited</code>.</p>",
"isRequired": true
}
]
},
{
"type": "object",
"name": "repository",
@@ -182562,6 +182545,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182597,6 +182590,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182777,6 +182779,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182812,6 +182824,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",

369
src/webhooks/data/ghes-3.8/schema.json
View File

@@ -66053,6 +66053,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -66088,6 +66098,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -66400,6 +66419,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -66435,6 +66464,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -66462,180 +66500,6 @@
"category": "membership"
}
},
"merge_group": {
"default": {
"descriptionHtml": "<p>Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.</p>\n<p>When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.</p>",
"summaryHtml": "<p>This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue\">Managing a merge queue</a>.\"</p>\n<p>To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.</p>\n<p><strong>Note</strong>: The pull request merge queue feature is currently in public beta and subject to change.</p>",
"bodyParameters": [
{
"type": "string",
"name": "action",
"in": "body",
"description": "",
"isRequired": true,
"childParamsGroups": []
},
{
"type": "object",
"name": "installation",
"in": "body",
"description": "<p>The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "merge_group",
"in": "body",
"description": "",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "head_sha",
"description": "<p>The SHA of the merge group.</p>",
"isRequired": true
},
{
"type": "string",
"name": "head_ref",
"description": "<p>The full ref of the merge group.</p>",
"isRequired": true
},
{
"type": "string",
"name": "base_sha",
"description": "<p>The SHA of the merge group's parent commit.</p>",
"isRequired": true
},
{
"type": "string",
"name": "base_ref",
"description": "<p>The full ref of the branch the merge group will be merged into.</p>",
"isRequired": true
},
{
"type": "object",
"name": "head_commit",
"description": "",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "author",
"description": "<p>Metaproperties for Git author/committer information.</p>",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "date",
"description": ""
},
{
"type": "string or null",
"name": "email",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "<p>The git author's name.</p>",
"isRequired": true
},
{
"type": "string",
"name": "username",
"description": ""
}
]
},
{
"type": "object",
"name": "committer",
"description": "<p>Metaproperties for Git author/committer information.</p>",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "date",
"description": ""
},
{
"type": "string or null",
"name": "email",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "<p>The git author's name.</p>",
"isRequired": true
},
{
"type": "string",
"name": "username",
"description": ""
}
]
},
{
"type": "string",
"name": "id",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "message",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "timestamp",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "tree_id",
"description": "",
"isRequired": true
}
]
}
]
},
{
"type": "object",
"name": "organization",
"in": "body",
"description": "<p>A GitHub organization.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "repository",
"in": "body",
"description": "<p>A repository on GitHub.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",
"in": "body",
"description": "<p>A GitHub user.</p>",
"childParamsGroups": []
}
],
"availability": [
"app"
],
"action": "default",
"category": "merge_group"
}
},
"meta": {
"deleted": {
"descriptionHtml": "<p>The webhook was deleted.</p>",
@@ -87632,6 +87496,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -90940,6 +90809,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -97758,6 +97632,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -110981,6 +110860,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -114289,6 +114173,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -117597,6 +117486,11 @@
"name": "privacy",
"description": "<p>The level of privacy this team should have</p>"
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>The notification setting the team has set</p>"
},
{
"type": "string",
"name": "html_url",
@@ -181859,6 +181753,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -181894,6 +181798,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182075,6 +181988,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182110,6 +182033,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182290,6 +182222,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182325,6 +182267,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182504,6 +182455,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182539,6 +182500,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182626,6 +182596,19 @@
}
]
},
{
"type": "object",
"name": "notification_setting",
"description": "",
"childParamsGroups": [
{
"type": "string",
"name": "from",
"description": "<p>The previous version of the team's notification setting if the action was <code>edited</code>.</p>",
"isRequired": true
}
]
},
{
"type": "object",
"name": "repository",
@@ -182805,6 +182788,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -182840,6 +182833,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -183020,6 +183022,16 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"isRequired": true,
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",
@@ -183055,6 +183067,15 @@
"secret"
]
},
{
"type": "string",
"name": "notification_setting",
"description": "<p>Whether team members will receive notifications when their team is @mentioned</p>",
"enum": [
"notifications_enabled",
"notifications_disabled"
]
},
{
"type": "string",
"name": "repositories_url",

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

@@ -1,3 +1,3 @@
{
"sha": "e27c8f10a2208e6a8df88e64d2b40c9c7a1ecd2d"
"sha": "e462c64f50b84f040ac76cd2205984ddf151b67f"
}