jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Update OpenAPI Description (#57578)

Browse Source 
Co-authored-by: Guillaume Perrot <guperrot@github.com>
Co-authored-by: Indrajith Premanath <inpreman@github.com>
Co-authored-by: Vanessa <vgrl@github.com>
This commit is contained in:
docs-bot
2025-09-16 16:18:28 -07:00
committed by GitHub
parent 66658b6ead
commit d9c1f7cfd6
21 changed files with 91175 additions and 2243 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
content/rest/enterprise-admin/enterprises.md Normal file
View File

@@ -0,0 +1,13 @@
---
title: REST API endpoints for enterprise access verification
shortTitle: Enterprise access verification
intro: 'Use the REST API to manage enterprise access verification configuration in your {% data variables.product.github %} enterprise.'
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
ghec: '*'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
---
<!-- Content after this section is automatically generated -->

1
content/rest/enterprise-admin/index.md
View File

@@ -20,6 +20,7 @@ children:
- /bypass-requests
- /code-security-and-analysis
- /custom-properties
- /enterprises
- /global-webhooks
- /ldap
- /license

20
content/rest/enterprise-teams/enterprise-team-members.md Normal file
View File

@@ -0,0 +1,20 @@
---
title: REST API endpoints for enterprise team memberships
shortTitle: Enterprise team members
intro: >-
Use the REST API to create and manage membership of enterprise teams in your {% data
variables.product.github %} enterprise.
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
---
## About enterprise team members
{% data reusables.enterprise.enterprise-team-api %}
<!-- Content after this section is automatically generated -->

18
content/rest/enterprise-teams/enterprise-teams.md Normal file
View File

@@ -0,0 +1,18 @@
---
title: REST API endpoints for enterprise team members
shortTitle: Enterprise teams
intro: 'Use the REST API to create and manage enterprise teams in your {% data variables.product.github %} enterprise.'
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
---
## About enterprise teams
{% data reusables.enterprise.enterprise-team-api %}
<!-- Content after this section is automatically generated -->

15
content/rest/enterprise-teams/index.md Normal file
View File

@@ -0,0 +1,15 @@
---
title: Enterprise teams
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
intro: 'Use the REST API to create and manage enterprise teams in your {% data variables.product.github %} enterprise.'
children:
- /enterprise-teams
- /enterprise-team-members
versions:
fpt: '*'
ghec: '*'
---

1
content/rest/index.md
View File

@@ -63,6 +63,7 @@ children:
- /deployments
- /emojis
- /enterprise-admin
- /enterprise-teams
- /gists
- /git
- /gitignore

12
data/reusables/enterprise/enterprise-team-api.md Normal file
View File

@@ -0,0 +1,12 @@
> [!NOTE]
> These endpoints are currently in {% data variables.release-phases.public_preview %} and subject to change.
>
> This API documentation is for enterprises on {% data variables.product.prodname_ghe_cloud %}.
>
> If your enterprise is Copilot Business for non-GHE, please refer to the early access documentation link that was previously shared to you.
These endpoints are only available to authenticated members of the enterprise team's enterprise with classic {% data variables.product.pat_generic_plural %} with the `read:enterprise` [scope](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps) for `GET` APIs and `admin:enterprise` for other APIs.
These endpoints are not compatible with {% data variables.product.pat_v2_plural %} or GitHub App access tokens.
{% data variables.product.prodname_dotcom %} generates the enterprise team's `slug` from the team `name` and adds the `ent:` prefix.

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

@@ -60,5 +60,5 @@
"2022-11-28"
]
},
"sha": "b27d92b4094f9c4c6c60680325830982f04e5449"
"sha": "73684ea0156d151bb888c351ff7ce1544258a4b3"
}

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

92
src/rest/data/ghes-3.14-2022-11-28/schema.json
View File

@@ -6174,13 +6174,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>The authenticated user must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>The authenticated user must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -9784,13 +9784,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Deletes a self-hosted runner group for an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -18657,13 +18657,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to configure your self-hosted runner:</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
]
],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to configure your self-hosted runner:</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -24803,13 +24803,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates an organization variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Response when creating a variable</p>"
}
]
],
"descriptionHTML": "<p>Creates an organization variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -24936,13 +24936,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a specific variable in an organization.</p>\n<p>The authenticated user must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets a specific variable in an organization.</p>\n<p>The authenticated user must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -27029,13 +27029,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deletes a repository variable using the variable name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Deletes a repository variable using the variable name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -157309,7 +157309,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n<p>The authenticated user must be an owner or security manager for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>security_events</code> or <code>repo</code>s cope to use this endpoint with private or public repositories, or the <code>public_repo</code> scope to use this endpoint with only public repositories.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -157323,7 +157322,8 @@
"httpStatusCode": "503",
"description": "<p>Service unavailable</p>"
}
]
],
"descriptionHTML": "<p>Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n<p>The authenticated user must be an owner or security manager for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>security_events</code> or <code>repo</code>s cope to use this endpoint with private or public repositories, or the <code>public_repo</code> scope to use this endpoint with only public repositories.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -203096,13 +203096,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -203159,13 +203159,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -203222,13 +203222,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -205602,13 +205602,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>This will trigger a <a href=\"https://docs.github.com/enterprise-server@3.14/webhooks/#ping-event\">ping event</a> to be sent to the webhook.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>This will trigger a <a href=\"https://docs.github.com/enterprise-server@3.14/webhooks/#ping-event\">ping event</a> to be sent to the webhook.</p>"
}
],
"ldap": [
@@ -207600,7 +207600,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Check the status of the license that is currently set for the enterprise.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -207614,7 +207613,8 @@
"httpStatusCode": "500",
"description": "<p>Internal error</p>"
}
]
],
"descriptionHTML": "<p>Check the status of the license that is currently set for the enterprise.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME",
@@ -211446,13 +211446,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -212614,13 +212614,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -218806,13 +218806,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -220159,13 +220159,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also <a href=\"https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user\">update the LDAP mapping</a> for the user.</p>\n<p>The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send <code>\"octo_cat\"</code> as the login, a user named <code>\"octo-cat\"</code> will be created.</p>\n<p>If the login name or email address is already associated with an account, the server will return a <code>422</code> response.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
]
],
"descriptionHTML": "<p>If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also <a href=\"https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user\">update the LDAP mapping</a> for the user.</p>\n<p>The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send <code>\"octo_cat\"</code> as the login, a user named <code>\"octo-cat\"</code> will be created.</p>\n<p>If the login name or email address is already associated with an account, the server will return a <code>422</code> response.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -343897,13 +343897,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -349492,13 +349492,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deletes a custom organization role. For more information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Deletes a custom organization role. For more information on custom organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles\">Managing people's access to your organization with roles</a>.\"</p>\n<p>To use this endpoint, the authenticated user must be one of:</p>\n<ul>\n<li>An administrator for the organization.</li>\n<li>A user, or a user on a team, with the fine-grained permissions of <code>write_organization_custom_org_role</code> in the organization.</li>\n</ul>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -350229,7 +350229,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists organization members that are assigned to an organization role. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>To use this endpoint, you must be an administrator for the organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -350243,7 +350242,8 @@
"httpStatusCode": "422",
"description": "<p>Response if the organization roles feature is not enabled or validation failed.</p>"
}
]
],
"descriptionHTML": "<p>Lists organization members that are assigned to an organization role. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>To use this endpoint, you must be an administrator for the organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
}
],
"outside-collaborators": [
@@ -361521,13 +361521,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists teams that are security managers for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n<p>The authenticated user must be an administrator or security manager for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists teams that are security managers for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n<p>The authenticated user must be an administrator or security manager for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -440661,13 +440661,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Users with push access to the repository can edit a release asset.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Users with push access to the repository can edit a release asset.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -505976,7 +505976,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a single secret scanning alert detected in an eligible repository.</p>\n<p>The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>security_events</code> scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the <code>public_repo</code> scope instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -505994,7 +505993,8 @@
"httpStatusCode": "503",
"description": "<p>Service unavailable</p>"
}
]
],
"descriptionHTML": "<p>Gets a single secret scanning alert detected in an eligible repository.</p>\n<p>The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>security_events</code> scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the <code>public_repo</code> scope instead.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -527907,13 +527907,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Get a specific discussion on a team's page.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Get a specific discussion on a team's page.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",

359
src/rest/data/ghes-3.15-2022-11-28/schema.json
View File

@@ -359250,6 +359250,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -361472,6 +361501,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -362711,6 +362769,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -364929,6 +365016,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -489252,6 +489368,61 @@
}
}
]
},
{
"allOf": [
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
},
{
"title": "repository ruleset data for rule",
"description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.",
"properties": {
"ruleset_source_type": {
"type": "string",
"description": "The type of source for the ruleset that includes this rule.",
"enum": [
"Repository",
"Organization"
]
},
"ruleset_source": {
"type": "string",
"description": "The name of the source of the ruleset that includes this rule."
},
"ruleset_id": {
"type": "integer",
"description": "The ID of the ruleset that includes this rule."
}
}
}
]
}
]
}
@@ -490498,6 +490669,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -491407,6 +491607,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -492612,6 +492848,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -493862,6 +494127,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -494776,6 +495070,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -495982,6 +496312,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}

459
src/rest/data/ghes-3.16-2022-11-28/schema.json
View File

@@ -1468,13 +1468,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -3503,13 +3503,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.</p>\n<p>If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as <code>allowed_actions</code> to <code>selected</code> actions, then you cannot override them for the organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.</p>\n<p>If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as <code>allowed_actions</code> to <code>selected</code> actions, then you cannot override them for the organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5112,13 +5112,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization\">Setting the permissions of the GITHUB_TOKEN for your organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization\">Setting the permissions of the GITHUB_TOKEN for your organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -28144,13 +28144,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a specific job in a workflow run.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets a specific job in a workflow run.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -39393,13 +39393,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Get all deployment environments for a workflow run that are waiting for protection rules to pass.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Get all deployment environments for a workflow run that are waiting for protection rules to pass.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -91999,13 +91999,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists repositories a user is watching.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists repositories a user is watching.</p>"
}
]
},
@@ -126397,13 +126397,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -131025,13 +131025,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -132163,13 +132163,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Disables the ability to restrict who can push to this branch.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Disables the ability to restrict who can push to this branch.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -184842,13 +184842,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the commit comments for a specified repository. Comments are ordered by ascending ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists the commit comments for a specified repository. Comments are ordered by ascending ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -196052,13 +196052,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a single organization secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets a single organization secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -197256,13 +197256,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists all repositories that have been selected when the <code>visibility</code>\nfor repository access to a secret is set to <code>selected</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists all repositories that have been selected when the <code>visibility</code>\nfor repository access to a secret is set to <code>selected</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -202384,13 +202384,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the deployment branch policies for an environment.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists the deployment branch policies for an environment.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -203790,13 +203790,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the environments for a repository.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists the environments for a repository.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -211402,13 +211402,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -219132,13 +219132,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "202",
"description": "<p>Accepted</p>"
}
]
],
"descriptionHTML": ""
}
],
"pre-receive-environments": [
@@ -220510,13 +220510,13 @@
}
],
"previews": [],
"descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -364609,6 +364609,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -366833,6 +366862,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -368073,6 +368131,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -370293,6 +370380,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -370643,13 +370759,13 @@
}
],
"previews": [],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/orgs/organization-roles\">Organization Roles</a>\" endpoints instead.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/orgs/organization-roles\">Organization Roles</a>\" endpoints instead.</p>\n</div>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -371991,13 +372107,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -386315,13 +386431,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets a specific package version for a public package owned by a specified user.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Gets a specific package version for a public package owned by a specified user.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -495248,6 +495364,61 @@
}
}
]
},
{
"allOf": [
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
},
{
"title": "repository ruleset data for rule",
"description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.",
"properties": {
"ruleset_source_type": {
"type": "string",
"description": "The type of source for the ruleset that includes this rule.",
"enum": [
"Repository",
"Organization"
]
},
"ruleset_source": {
"type": "string",
"description": "The name of the source of the ruleset that includes this rule."
},
"ruleset_id": {
"type": "integer",
"description": "The ID of the ruleset that includes this rule."
}
}
}
]
}
]
}
@@ -496495,6 +496666,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -497405,6 +497605,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -498611,6 +498847,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -499862,6 +500127,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -500777,6 +501071,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -501984,6 +502314,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -524535,13 +524894,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>To delete a team, the authenticated user must be an organization owner or team maintainer.</p>\n<p>If you are an organization owner, deleting a parent team will delete all of its child teams as well.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}</code>.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
]
],
"descriptionHTML": "<p>To delete a team, the authenticated user must be an organization owner or team maintainer.</p>\n<p>If you are an organization owner, deleting a parent team will delete all of its child teams as well.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>DELETE /organizations/{org_id}/team/{team_id}</code>.</p>\n</div>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -536590,13 +536949,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Edits the body text of a discussion comment.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Edits the body text of a discussion comment.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -543175,13 +543534,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists a connection between a team and an external group.</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists a connection between a team and an external group.</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -548078,7 +548437,6 @@
}
],
"previews": [],
"descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account. This method takes their durable user <code>ID</code> instead of their <code>login</code>, which can change over time.</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Server <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/rest/guides/getting-started-with-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/rest/users/emails\">Emails API</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -548088,7 +548446,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
]
],
"descriptionHTML": "<p>Provides publicly available information about someone with a GitHub account. This method takes their durable user <code>ID</code> instead of their <code>login</code>, which can change over time.</p>\n<p>The <code>email</code> key in the following response is the publicly visible email address from your GitHub Enterprise Server <a href=\"https://github.com/settings/profile\">profile page</a>. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/rest/guides/getting-started-with-the-rest-api#authentication\">Authentication</a>.</p>\n<p>The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/rest/users/emails\">Emails API</a>.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -551542,13 +551901,13 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists the people who the specified user follows.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
]
],
"descriptionHTML": "<p>Lists the people who the specified user follows.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",

359
src/rest/data/ghes-3.17-2022-11-28/schema.json
View File

@@ -366150,6 +366150,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -368641,6 +368670,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -370015,6 +370073,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -372502,6 +372589,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -497072,6 +497188,61 @@
}
}
]
},
{
"allOf": [
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
},
{
"title": "repository ruleset data for rule",
"description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.",
"properties": {
"ruleset_source_type": {
"type": "string",
"description": "The type of source for the ruleset that includes this rule.",
"enum": [
"Repository",
"Organization"
]
},
"ruleset_source": {
"type": "string",
"description": "The name of the source of the ruleset that includes this rule."
},
"ruleset_id": {
"type": "integer",
"description": "The ID of the ruleset that includes this rule."
}
}
}
]
}
]
}
@@ -498453,6 +498624,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -499496,6 +499696,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -500836,6 +501072,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -502221,6 +502486,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}
@@ -503269,6 +503563,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -504610,6 +504940,35 @@
]
}
}
},
{
"title": "copilot_code_review",
"description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"copilot_code_review"
]
},
"parameters": {
"type": "object",
"properties": {
"review_draft_pull_requests": {
"type": "boolean",
"description": "Copilot automatically reviews draft pull requests before they are marked as ready for review."
},
"review_on_push": {
"type": "boolean",
"description": "Copilot automatically reviews each new push to the pull request."
}
}
}
}
}
]
}

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

@@ -44,5 +44,5 @@
]
}
},
"sha": "b27d92b4094f9c4c6c60680325830982f04e5449"
"sha": "73684ea0156d151bb888c351ff7ce1544258a4b3"
}

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

@@ -236275,6 +236275,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -237382,6 +237418,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -238489,6 +238561,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -239567,6 +239675,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -240457,6 +240601,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -241352,6 +241532,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true

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

@@ -242725,6 +242725,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -243833,6 +243869,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -244941,6 +245013,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -246019,6 +246127,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -246909,6 +247053,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -247804,6 +247984,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true

216
src/webhooks/data/ghes-3.15/schema.json
View File

@@ -201670,6 +201670,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -202640,6 +202676,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -203610,6 +203682,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -204555,6 +204663,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -205312,6 +205456,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -206074,6 +206254,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true

216
src/webhooks/data/ghes-3.16/schema.json
View File

@@ -203675,6 +203675,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -204646,6 +204682,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -205617,6 +205689,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -206562,6 +206670,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -207319,6 +207463,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -208081,6 +208261,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true

216
src/webhooks/data/ghes-3.17/schema.json
View File

@@ -206507,6 +206507,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -207611,6 +207647,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -208715,6 +208787,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -209793,6 +209901,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -210683,6 +210827,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true
@@ -211578,6 +211758,42 @@
]
}
]
},
{
"type": "object",
"name": "copilot_code_review",
"description": "<p>Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.</p>",
"isRequired": [
"type"
],
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "",
"isRequired": true,
"enum": [
"copilot_code_review"
]
},
{
"type": "object",
"name": "parameters",
"description": "",
"childParamsGroups": [
{
"type": "boolean",
"name": "review_draft_pull_requests",
"description": "<p>Copilot automatically reviews draft pull requests before they are marked as ready for review.</p>"
},
{
"type": "boolean",
"name": "review_on_push",
"description": "<p>Copilot automatically reviews each new push to the pull request.</p>"
}
]
}
]
}
],
"oneOfObject": true

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

@@ -1,3 +1,3 @@
{
"sha": "b27d92b4094f9c4c6c60680325830982f04e5449"
"sha": "73684ea0156d151bb888c351ff7ce1544258a4b3"
}