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 (#57475)

Browse Source 
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
Co-authored-by: Tom Elliott <13594679+tmelliottjr@users.noreply.github.com>
Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com>
Co-authored-by: isaacmbrown <isaacmbrown@github.com>
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
This commit is contained in:
docs-bot
2025-09-11 10:02:28 -07:00
committed by GitHub
parent fc9e832513
commit 701dddd5be
33 changed files with 23018 additions and 1316 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
View File

@@ -405,7 +405,7 @@ on:
> * {% data reusables.actions.branch-requirement %} > * {% data reusables.actions.branch-requirement %}
> * This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository. > * This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository.
Runs your workflow when a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to cards or columns in a {% data variables.projects.projects_v1_board %}, use the [`project_card`](#project_card) or [`project_column`](#project_column) events instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the {% data variables.projects.projects_v1_board %} APIs, see [AUTOTITLE](/graphql/reference/objects#project) in the GraphQL API documentation or [AUTOTITLE](/rest/projects). Runs your workflow when a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to cards or columns in a {% data variables.projects.projects_v1_board %}, use the [`project_card`](#project_card) or [`project_column`](#project_column) events instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the {% data variables.projects.projects_v1_board %} APIs, see [AUTOTITLE](/graphql/reference/objects#project) in the GraphQL API documentation or [AUTOTITLE](/rest/projects-classic).
For example, you can run a workflow when a project has been `created` or `deleted`. For example, you can run a workflow when a project has been `created` or `deleted`.
@@ -426,7 +426,7 @@ on:
> * {% data reusables.actions.branch-requirement %} > * {% data reusables.actions.branch-requirement %}
> * This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository. > * This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository.
Runs your workflow when a card on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or columns in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_column`](#project_column) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the project card APIs, see [AUTOTITLE](/graphql/reference/objects#projectcard) in the GraphQL API documentation or [AUTOTITLE](/rest/projects/cards). Runs your workflow when a card on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or columns in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_column`](#project_column) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the project card APIs, see [AUTOTITLE](/graphql/reference/objects#projectcard) in the GraphQL API documentation or [AUTOTITLE](/rest/projects-classic/cards).
For example, you can run a workflow when a project card has been `created` or `deleted`. For example, you can run a workflow when a project card has been `created` or `deleted`.
@@ -447,7 +447,7 @@ on:
> * {% data reusables.actions.branch-requirement %} > * {% data reusables.actions.branch-requirement %}
> * This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository. > * This event only occurs for projects owned by the workflow's repository, not for organization-owned or user-owned projects or for projects owned by another repository.
Runs your workflow when a column on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or cards in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_card`](#project_card) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the project column APIs, see [AUTOTITLE](/graphql/reference/objects#projectcolumn) in the GraphQL API documentation or [AUTOTITLE](/rest/projects#columns). Runs your workflow when a column on a {% data variables.projects.projects_v1_board %} is created or modified. For activity related to {% data variables.projects.projects_v1_boards %} or cards in a {% data variables.projects.projects_v1_board %}, use the [`project`](#project) or [`project_card`](#project_card) event instead. For more information about {% data variables.projects.projects_v1_boards %}, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). For information about the project column APIs, see [AUTOTITLE](/graphql/reference/objects#projectcolumn) in the GraphQL API documentation or [AUTOTITLE](/rest/projects-classic#columns).
For example, you can run a workflow when a project column has been `created` or `deleted`. For example, you can run a workflow when a project column has been `created` or `deleted`.
@@ -1002,7 +1002,7 @@ Notifications for scheduled workflows are sent to the user who last modified the
> [!NOTE] > [!NOTE]
> For an enterprise with {% data variables.product.prodname_emus %}, triggering a scheduled workflow requires that the status of the `actor` user account associated with the workflow is currently active (i.e. not suspended or deleted). > For an enterprise with {% data variables.product.prodname_emus %}, triggering a scheduled workflow requires that the status of the `actor` user account associated with the workflow is currently active (i.e. not suspended or deleted).
> * Scheduled workflows will not run if the last `actor` associated with the scheduled workflow has been deprovisioned by the {% data variables.product.prodname_emu %} identity provider (IdP). However, if the last `actor` {% data variables.product.prodname_emu %} has not been deprovisioned by the IdP, and has only been removed as a member from a given organization in the enterprise, scheduled workflows will still run with that user set as the `actor`. > * Scheduled workflows will not run if the last `actor` associated with the scheduled workflow has been deprovisioned by the {% data variables.product.prodname_emu %} identity provider (IdP). However, if the last `actor` {% data variables.product.prodname_emu %} has not been deprovisioned by the IdP, and has only been removed as a member from a given organization in the enterprise, scheduled workflows will still run with that user set as the `actor`.
> * Similarly, for an enterprise without {% data variables.product.prodname_emus %}, removing a user from an organization will not prevent scheduled workflows which had that user as their `actor` from running. > * Similarly, for an enterprise without {% data variables.product.prodname_emus %}, removing a user from an organization will not prevent scheduled workflows which had that user as their `actor` from running.
> * Thus, the _user account's_ status, in both {% data variables.product.prodname_emu %} and non-{% data variables.product.prodname_emu %} scenarios, is what's important, _not_ the user's _membership status_ in the organization where the scheduled workflow is located. > * Thus, the _user account's_ status, in both {% data variables.product.prodname_emu %} and non-{% data variables.product.prodname_emu %} scenarios, is what's important, _not_ the user's _membership status_ in the organization where the scheduled workflow is located.
## `status` ## `status`

3
content/rest/index.md
View File

@@ -23,7 +23,7 @@ featuredLinks:
- /rest/guides/using-the-rest-api-to-interact-with-checks - /rest/guides/using-the-rest-api-to-interact-with-checks
- /rest/using-the-rest-api/using-pagination-in-the-rest-api - /rest/using-the-rest-api/using-pagination-in-the-rest-api
changelog: changelog:
label: 'api, apis' label: api, apis
layout: product-landing layout: product-landing
redirect_from: redirect_from:
- /v3 - /v3
@@ -79,6 +79,7 @@ children:
- /packages - /packages
- /pages - /pages
- /private-registries - /private-registries
- /projects
- /projects-classic - /projects-classic
- /pulls - /pulls
- /rate-limit - /rate-limit

1
content/rest/projects-classic/index.md
View File

@@ -5,7 +5,6 @@ intro: 'Use the REST API to create, list, update, delete and customize {% data v
redirect_from: redirect_from:
- /v3/projects - /v3/projects
- /rest/reference/projects - /rest/reference/projects
- /rest/projects
topics: topics:
- API - API
autogenerated: rest autogenerated: rest

1
content/rest/projects-classic/projects.md
View File

@@ -13,7 +13,6 @@ topics:
- API - API
autogenerated: rest autogenerated: rest
redirect_from: redirect_from:
- /rest/projects/projects
- /v3/projects/projects - /v3/projects/projects
- /rest/reference/projects/projects - /rest/reference/projects/projects
--- ---

14
content/rest/projects/fields.md Normal file
View File

@@ -0,0 +1,14 @@
---
title: REST API endpoints for Project fields
shortTitle: Project fields
intro: Use the REST API to manage Project fields
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
---
<!-- Content after this section is automatically generated -->

15
content/rest/projects/index.md Normal file
View File

@@ -0,0 +1,15 @@
---
title: Projects
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
children:
- /fields
- /items
- /projects
versions:
fpt: '*'
ghec: '*'
---

14
content/rest/projects/items.md Normal file
View File

@@ -0,0 +1,14 @@
---
title: REST API endpoints for Project items
shortTitle: Project items
intro: Use the REST API to manage Project items
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
---
<!-- Content after this section is automatically generated -->

14
content/rest/projects/projects.md Normal file
View File

@@ -0,0 +1,14 @@
---
title: REST API endpoints for Projects
shortTitle: Projects
intro: Use the REST API to manage Projects
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
---
<!-- Content after this section is automatically generated -->

81
src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
View File

@@ -2133,6 +2133,87 @@
"additional-permissions": false, "additional-permissions": false,
"access": "write" "access": "write"
}, },
{
"category": "projects",
"slug": "list-projects-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2",
"additional-permissions": false,
"access": "read"
},
{
"category": "projects",
"slug": "get-project-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}",
"additional-permissions": false,
"access": "read"
},
{
"category": "projects",
"slug": "list-project-fields-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields",
"additional-permissions": false,
"access": "read"
},
{
"category": "projects",
"slug": "get-project-field-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "projects",
"slug": "list-items-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items",
"additional-permissions": false,
"access": "read"
},
{
"category": "projects",
"slug": "add-item-to-organization-owned-project",
"subcategory": "items",
"verb": "post",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items",
"additional-permissions": false,
"access": "write"
},
{
"category": "projects",
"slug": "get-an-item-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "projects",
"slug": "update-project-item-for-organization",
"subcategory": "items",
"verb": "patch",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
"additional-permissions": false,
"access": "write"
},
{
"category": "projects",
"slug": "delete-project-item-for-organization",
"subcategory": "items",
"verb": "delete",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
"additional-permissions": false,
"access": "write"
},
{ {
"category": "teams", "category": "teams",
"slug": "add-or-update-team-project-permissions", "slug": "add-or-update-team-project-permissions",

56
src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
View File

@@ -3653,6 +3653,62 @@
"requestPath": "/orgs/{org}/private-registries/{secret_name}" "requestPath": "/orgs/{org}/private-registries/{secret_name}"
} }
], ],
"projects": [
{
"slug": "list-projects-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2"
},
{
"slug": "get-project-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}"
},
{
"slug": "list-project-fields-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields"
},
{
"slug": "get-project-field-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}"
},
{
"slug": "list-items-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
},
{
"slug": "add-item-to-organization-owned-project",
"subcategory": "items",
"verb": "post",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
},
{
"slug": "get-an-item-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
},
{
"slug": "update-project-item-for-organization",
"subcategory": "items",
"verb": "patch",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
},
{
"slug": "delete-project-item-for-organization",
"subcategory": "items",
"verb": "delete",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
}
],
"projects-classic": [ "projects-classic": [
{ {
"slug": "list-organization-projects", "slug": "list-organization-projects",

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

@@ -2685,6 +2685,105 @@
"server-to-server": true, "server-to-server": true,
"additional-permissions": false "additional-permissions": false
}, },
{
"category": "projects",
"slug": "list-projects-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "get-project-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "list-project-fields-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "get-project-field-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "list-items-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "add-item-to-organization-owned-project",
"subcategory": "items",
"verb": "post",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "get-an-item-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "update-project-item-for-organization",
"subcategory": "items",
"verb": "patch",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "delete-project-item-for-organization",
"subcategory": "items",
"verb": "delete",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{ {
"category": "teams", "category": "teams",
"slug": "add-or-update-team-project-permissions", "slug": "add-or-update-team-project-permissions",

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

@@ -3747,6 +3747,62 @@
"requestPath": "/orgs/{org}/private-registries/{secret_name}" "requestPath": "/orgs/{org}/private-registries/{secret_name}"
} }
], ],
"projects": [
{
"slug": "list-projects-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2"
},
{
"slug": "get-project-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}"
},
{
"slug": "list-project-fields-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields"
},
{
"slug": "get-project-field-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}"
},
{
"slug": "list-items-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
},
{
"slug": "add-item-to-organization-owned-project",
"subcategory": "items",
"verb": "post",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
},
{
"slug": "get-an-item-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
},
{
"slug": "update-project-item-for-organization",
"subcategory": "items",
"verb": "patch",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
},
{
"slug": "delete-project-item-for-organization",
"subcategory": "items",
"verb": "delete",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
}
],
"projects-classic": [ "projects-classic": [
{ {
"slug": "list-organization-projects", "slug": "list-organization-projects",

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

@@ -4215,6 +4215,62 @@
"requestPath": "/orgs/{org}/private-registries/{secret_name}" "requestPath": "/orgs/{org}/private-registries/{secret_name}"
} }
], ],
"projects": [
{
"slug": "list-projects-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2"
},
{
"slug": "get-project-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}"
},
{
"slug": "list-project-fields-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields"
},
{
"slug": "get-project-field-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}"
},
{
"slug": "list-items-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
},
{
"slug": "add-item-to-organization-owned-project",
"subcategory": "items",
"verb": "post",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
},
{
"slug": "get-an-item-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
},
{
"slug": "update-project-item-for-organization",
"subcategory": "items",
"verb": "patch",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
},
{
"slug": "delete-project-item-for-organization",
"subcategory": "items",
"verb": "delete",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
}
],
"projects-classic": [ "projects-classic": [
{ {
"slug": "list-organization-projects", "slug": "list-organization-projects",

81
src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
View File

@@ -2826,6 +2826,87 @@
"additional-permissions": false, "additional-permissions": false,
"access": "write" "access": "write"
}, },
{
"category": "projects",
"slug": "list-projects-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2",
"additional-permissions": false,
"access": "read"
},
{
"category": "projects",
"slug": "get-project-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}",
"additional-permissions": false,
"access": "read"
},
{
"category": "projects",
"slug": "list-project-fields-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields",
"additional-permissions": false,
"access": "read"
},
{
"category": "projects",
"slug": "get-project-field-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "projects",
"slug": "list-items-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items",
"additional-permissions": false,
"access": "read"
},
{
"category": "projects",
"slug": "add-item-to-organization-owned-project",
"subcategory": "items",
"verb": "post",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items",
"additional-permissions": false,
"access": "write"
},
{
"category": "projects",
"slug": "get-an-item-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
"additional-permissions": false,
"access": "read"
},
{
"category": "projects",
"slug": "update-project-item-for-organization",
"subcategory": "items",
"verb": "patch",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
"additional-permissions": false,
"access": "write"
},
{
"category": "projects",
"slug": "delete-project-item-for-organization",
"subcategory": "items",
"verb": "delete",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
"additional-permissions": false,
"access": "write"
},
{ {
"category": "teams", "category": "teams",
"slug": "add-or-update-team-project-permissions", "slug": "add-or-update-team-project-permissions",

56
src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
View File

@@ -4017,6 +4017,62 @@
"requestPath": "/orgs/{org}/private-registries/{secret_name}" "requestPath": "/orgs/{org}/private-registries/{secret_name}"
} }
], ],
"projects": [
{
"slug": "list-projects-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2"
},
{
"slug": "get-project-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}"
},
{
"slug": "list-project-fields-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields"
},
{
"slug": "get-project-field-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}"
},
{
"slug": "list-items-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
},
{
"slug": "add-item-to-organization-owned-project",
"subcategory": "items",
"verb": "post",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
},
{
"slug": "get-an-item-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
},
{
"slug": "update-project-item-for-organization",
"subcategory": "items",
"verb": "patch",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
},
{
"slug": "delete-project-item-for-organization",
"subcategory": "items",
"verb": "delete",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
}
],
"projects-classic": [ "projects-classic": [
{ {
"slug": "list-organization-projects", "slug": "list-organization-projects",

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

@@ -3690,6 +3690,105 @@
"server-to-server": true, "server-to-server": true,
"additional-permissions": false "additional-permissions": false
}, },
{
"category": "projects",
"slug": "list-projects-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "get-project-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "list-project-fields-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "get-project-field-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "list-items-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "add-item-to-organization-owned-project",
"subcategory": "items",
"verb": "post",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "get-an-item-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
"access": "read",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "update-project-item-for-organization",
"subcategory": "items",
"verb": "patch",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "projects",
"slug": "delete-project-item-for-organization",
"subcategory": "items",
"verb": "delete",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{ {
"category": "teams", "category": "teams",
"slug": "add-or-update-team-project-permissions", "slug": "add-or-update-team-project-permissions",

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

@@ -4165,6 +4165,62 @@
"requestPath": "/orgs/{org}/private-registries/{secret_name}" "requestPath": "/orgs/{org}/private-registries/{secret_name}"
} }
], ],
"projects": [
{
"slug": "list-projects-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2"
},
{
"slug": "get-project-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}"
},
{
"slug": "list-project-fields-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields"
},
{
"slug": "get-project-field-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}"
},
{
"slug": "list-items-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
},
{
"slug": "add-item-to-organization-owned-project",
"subcategory": "items",
"verb": "post",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
},
{
"slug": "get-an-item-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
},
{
"slug": "update-project-item-for-organization",
"subcategory": "items",
"verb": "patch",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
},
{
"slug": "delete-project-item-for-organization",
"subcategory": "items",
"verb": "delete",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
}
],
"projects-classic": [ "projects-classic": [
{ {
"slug": "list-organization-projects", "slug": "list-organization-projects",

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

@@ -4633,6 +4633,62 @@
"requestPath": "/orgs/{org}/private-registries/{secret_name}" "requestPath": "/orgs/{org}/private-registries/{secret_name}"
} }
], ],
"projects": [
{
"slug": "list-projects-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2"
},
{
"slug": "get-project-for-organization",
"subcategory": "projects",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}"
},
{
"slug": "list-project-fields-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields"
},
{
"slug": "get-project-field-for-organization",
"subcategory": "fields",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}"
},
{
"slug": "list-items-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
},
{
"slug": "add-item-to-organization-owned-project",
"subcategory": "items",
"verb": "post",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items"
},
{
"slug": "get-an-item-for-an-organization-owned-project",
"subcategory": "items",
"verb": "get",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
},
{
"slug": "update-project-item-for-organization",
"subcategory": "items",
"verb": "patch",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
},
{
"slug": "delete-project-item-for-organization",
"subcategory": "items",
"verb": "delete",
"requestPath": "/orgs/{org}/projectsV2/{project_number}/items/{item_id}"
}
],
"projects-classic": [ "projects-classic": [
{ {
"slug": "list-organization-projects", "slug": "list-organization-projects",

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

@@ -60,5 +60,5 @@
"2022-11-28" "2022-11-28"
] ]
}, },
"sha": "f0dc156505ef3ea9ae0fd2f227aca5642c465e4f" "sha": "e605333115d5123d2ac50baf757e65cbb94a60c3"
} }

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

@@ -1080,13 +1080,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the GitHub Actions cache usage policy for an enterprise.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets the GitHub Actions cache usage policy for an enterprise.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2014,13 +2014,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2555,13 +2555,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2901,13 +2901,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -3100,13 +3100,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -4668,13 +4668,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5375,13 +5375,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.</p>\n<p>If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as <code>allowed_actions</code> to <code>selected</code> actions, then you cannot override them for the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.</p>\n<p>If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as <code>allowed_actions</code> to <code>selected</code> actions, then you cannot override them for the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -6499,13 +6499,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>Authenticated users 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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>Authenticated users 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -9421,13 +9421,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Creates a new 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": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Creates a new 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10871,13 +10871,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -11399,13 +11399,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an 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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -19901,13 +19901,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to 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. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to 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. If the repository is private, the <code>repo</code> scope is also required.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -26089,6 +26089,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all repositories that can access an organization variable\nthat is available to selected repositories.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -26098,8 +26099,7 @@
"httpStatusCode": "409", "httpStatusCode": "409",
"description": "<p>Response when the visibility of the variable is not set to <code>selected</code></p>" "description": "<p>Response when the visibility of the variable is not set to <code>selected</code></p>"
} }
], ]
"descriptionHTML": "<p>Lists all repositories that can access an organization variable\nthat is available to selected repositories.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -28183,13 +28183,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor <code>Location:</code> in the response header to find the URL for the download.</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": [ "statusCodes": [
{ {
"httpStatusCode": "302", "httpStatusCode": "302",
"description": "<p>Found</p>" "description": "<p>Found</p>"
} }
], ]
"descriptionHTML": "<p>Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor <code>Location:</code> in the response header to find the URL for the download.</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -29263,13 +29263,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see <a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see <a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</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>"
} }
], ],
"workflow-runs": [ "workflow-runs": [
@@ -32207,13 +32207,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see <a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</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>\n<p>This endpoint will return up to 1,000 results for each search when using the following parameters: <code>actor</code>, <code>branch</code>, <code>check_suite_id</code>, <code>created</code>, <code>event</code>, <code>head_sha</code>, <code>status</code>.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see <a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</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>\n<p>This endpoint will return up to 1,000 results for each search when using the following parameters: <code>actor</code>, <code>branch</code>, <code>check_suite_id</code>, <code>created</code>, <code>event</code>, <code>head_sha</code>, <code>status</code>.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -43881,13 +43881,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Enables a workflow and sets the <code>state</code> of the workflow to <code>active</code>. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Enables a workflow and sets the <code>state</code> of the workflow to <code>active</code>. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
} }
] ]
}, },
@@ -79332,13 +79332,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<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>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<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>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
} }
], ],
"feeds": [ "feeds": [
@@ -89064,13 +89064,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists repositories a user has starred.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/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.star+json</code></strong>: Includes a timestamp of when the star was created.</li>\n</ul>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists repositories a user has starred.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/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.star+json</code></strong>: Includes a timestamp of when the star was created.</li>\n</ul>"
} }
], ],
"watching": [ "watching": [
@@ -91795,13 +91795,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the\norganization level. Organization members may also see an enterprise-level announcement banner. To get an\nannouncement banner displayed at the enterprise level, use the enterprise-level endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -91980,13 +91980,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes the announcement banner currently set for the organization.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Removes the announcement banner currently set for the organization.</p>"
} }
] ]
}, },
@@ -176042,13 +176042,13 @@
} }
], ],
"previews": [], "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.14/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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "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.14/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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -188276,13 +188276,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code>\nfor repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret\">Create\nor update an organization secret</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code>\nfor repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret\">Create\nor update an organization secret</a>.</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -188897,6 +188897,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
@@ -188906,8 +188907,7 @@
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>Response when updating a secret</p>" "description": "<p>Response when updating a secret</p>"
} }
], ]
"descriptionHTML": "<p>Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n<a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/encrypting-secrets-for-the-rest-api\">Encrypting secrets for the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -202046,13 +202046,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -204615,13 +204615,13 @@
} }
], ],
"previews": [], "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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "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": [ "ldap": [
@@ -204748,13 +204748,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Updates the <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. <a href=\"https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync\">LDAP synchronization</a> must be enabled to map LDAP entries to a team. Use the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/teams/#create-a-team\">Create a team</a> endpoint to create a team with LDAP mapping.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -205266,13 +205266,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -209956,13 +209956,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -210339,13 +210339,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -210819,13 +210819,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>In addition to seeing the download status at the \"<a href=\"#get-a-pre-receive-environment\">Get a pre-receive environment</a>\" endpoint, there is also this separate endpoint for just the download status.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>In addition to seeing the download status at the \"<a href=\"#get-a-pre-receive-environment\">Get a pre-receive environment</a>\" endpoint, there is also this separate endpoint for just the download status.</p>"
} }
], ],
"pre-receive-hooks": [ "pre-receive-hooks": [
@@ -211412,13 +211412,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -211917,13 +211917,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -217869,13 +217869,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -238893,6 +238893,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>List all templates available to pass as an option when <a href=\"https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-for-the-authenticated-user\">creating a repository</a>.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -238902,8 +238903,7 @@
"httpStatusCode": "304", "httpStatusCode": "304",
"description": "<p>Not modified</p>" "description": "<p>Not modified</p>"
} }
], ]
"descriptionHTML": "<p>List all templates available to pass as an option when <a href=\"https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-for-the-authenticated-user\">creating a repository</a>.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -268799,13 +268799,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes one or more assignees from an issue.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Removes one or more assignees from an issue.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -339387,13 +339387,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -344990,13 +344990,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -353589,11 +353589,11 @@
}, },
"before_sha": { "before_sha": {
"type": "string", "type": "string",
"description": "The first commit sha before the push evaluation." "description": "The previous commit SHA of the ref."
}, },
"after_sha": { "after_sha": {
"type": "string", "type": "string",
"description": "The last commit sha in the push evaluation." "description": "The new commit SHA of the ref."
}, },
"ref": { "ref": {
"type": "string", "type": "string",
@@ -376212,13 +376212,13 @@
} }
], ],
"previews": [], "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.14/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "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.14/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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -431540,13 +431540,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<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 repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n</div>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<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 repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.</code></p>\n</div>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.14/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -482988,11 +482988,11 @@
}, },
"before_sha": { "before_sha": {
"type": "string", "type": "string",
"description": "The first commit sha before the push evaluation." "description": "The previous commit SHA of the ref."
}, },
"after_sha": { "after_sha": {
"type": "string", "type": "string",
"description": "The last commit sha in the push evaluation." "description": "The new commit SHA of the ref."
}, },
"ref": { "ref": {
"type": "string", "type": "string",
@@ -528531,13 +528531,13 @@
} }
], ],
"previews": [], "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>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion\"><code>Create a discussion</code></a> endpoint.</p>\n</div>\n<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</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>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion\"><code>Create a discussion</code></a> endpoint.</p>\n</div>\n<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -529950,13 +529950,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists external groups available in an organization. You can query the groups using the <code>display_name</code> parameter, only groups with a <code>group_name</code> containing the text provided in the <code>display_name</code> parameter will be returned. You can also limit your page results using the <code>per_page</code> parameter. GitHub Enterprise Server generates a url-encoded <code>page</code> token using a cursor value for where the next page begins. For more information on cursor pagination, see \"<a href=\"https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89\">Offset and Cursor Pagination explained</a>.\"</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.14/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists external groups available in an organization. You can query the groups using the <code>display_name</code> parameter, only groups with a <code>group_name</code> containing the text provided in the <code>display_name</code> parameter will be returned. You can also limit your page results using the <code>per_page</code> parameter. GitHub Enterprise Server generates a url-encoded <code>page</code> token using a cursor value for where the next page begins. For more information on cursor pagination, see \"<a href=\"https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89\">Offset and Cursor Pagination explained</a>.\"</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.14/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -538450,13 +538450,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists the people who the specified user follows.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists the people who the specified user follows.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",

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

@@ -1468,13 +1468,13 @@
} }
], ],
"previews": [], "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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2555,13 +2555,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2836,13 +2836,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -4668,13 +4668,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -4802,13 +4802,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an 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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5461,13 +5461,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\" and\n\"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository\">Allowing access to components in an internal repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\" and\n\"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository\">Allowing access to components in an internal repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5543,13 +5543,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\" and\n\"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository\">Allowing access to components in an internal repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\" and\n\"<a href=\"https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository\">Allowing access to components in an internal repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -8012,13 +8012,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all secrets available in a repository without revealing their encrypted\nvalues.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists all secrets available in a repository without revealing their encrypted\nvalues.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -8834,13 +8834,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a single environment secret without revealing its encrypted value.</p>\n<p>Authenticated users 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>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets a single environment secret without revealing its encrypted value.</p>\n<p>Authenticated users 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>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -9250,13 +9250,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all self-hosted runner groups 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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists all self-hosted runner groups 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -9563,13 +9563,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a specific 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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets a specific 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10537,13 +10537,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an enterprise runner group.</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -16236,13 +16236,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in 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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Gets a specific self-hosted runner configured in 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -22430,13 +22430,13 @@
} }
], ],
"previews": [], "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 repository to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "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 repository to use this endpoint.</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -26991,13 +26991,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Updates a repository 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 app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Updates a repository 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 app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -28144,13 +28144,13 @@
} }
], ],
"previews": [], "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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -40360,13 +40360,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Re-runs your workflow run using its <code>id</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Re-runs your workflow run using its <code>id</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -40453,13 +40453,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Re-run all of the failed jobs and their dependent jobs in a workflow run using the <code>id</code> of the workflow run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Re-run all of the failed jobs and their dependent jobs in a workflow run using the <code>id</code> of the workflow run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -101506,13 +101506,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.15/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -110612,13 +110612,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the GitHub Advanced Security active committers for an organization per repository.</p>\n<p>Each distinct user login across all repositories is counted as a single Advanced Security seat, so the <code>total_advanced_security_committers</code> is not the sum of advanced_security_committers for each repository.</p>\n<p>If this organization defers to an enterprise for billing, the <code>total_advanced_security_committers</code> returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.</p>\n<p>The total number of repositories with committer information is tracked by the <code>total_count</code> field.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>Success</p>" "description": "<p>Success</p>"
} }
], ]
"descriptionHTML": "<p>Gets the GitHub Advanced Security active committers for an organization per repository.</p>\n<p>Each distinct user login across all repositories is counted as a single Advanced Security seat, so the <code>total_advanced_security_committers</code> is not the sum of advanced_security_committers for each repository.</p>\n<p>If this organization defers to an enterprise for billing, the <code>total_advanced_security_committers</code> returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.</p>\n<p>The total number of repositories with committer information is tracked by the <code>total_count</code> field.</p>"
} }
] ]
}, },
@@ -129841,6 +129841,7 @@
} }
], ],
"previews": [], "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.15/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -129850,8 +129851,7 @@
"httpStatusCode": "404", "httpStatusCode": "404",
"description": "<p>Resource not found</p>" "description": "<p>Resource not found</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.15/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -131096,13 +131096,13 @@
} }
], ],
"previews": [], "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.15/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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "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.15/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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -133552,6 +133552,7 @@
} }
], ],
"previews": [], "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.15/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists the teams who have push access to this branch. The list includes child teams.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -133561,8 +133562,7 @@
"httpStatusCode": "404", "httpStatusCode": "404",
"description": "<p>Resource not found</p>" "description": "<p>Resource not found</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.15/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>\n<p>Lists the teams who have push access to this branch. The list includes child teams.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -143382,13 +143382,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists check runs for a check suite using its <code>id</code>.</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>\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists check runs for a check suite using its <code>id</code>.</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>\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -151942,13 +151942,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#check_suite\"><code>check_suite</code> webhook</a> event with the action <code>rerequested</code>. When a check suite is <code>rerequested</code>, its <code>status</code> is reset to <code>queued</code> and the <code>conclusion</code> is cleared.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the <a href=\"https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#check_suite\"><code>check_suite</code> webhook</a> event with the action <code>rerequested</code>. When a check suite is <code>rerequested</code>, its <code>status</code> is reset to <code>queued</code> and the <code>conclusion</code> is cleared.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -157032,6 +157032,7 @@
} }
], ],
"previews": [], "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.15/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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -157045,8 +157046,7 @@
"httpStatusCode": "503", "httpStatusCode": "503",
"description": "<p>Service unavailable</p>" "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.15/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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -192385,13 +192385,13 @@
} }
], ],
"previews": [], "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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -195509,13 +195509,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Simple filtering of deployments is available via query parameters:</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Simple filtering of deployments is available via query parameters:</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -199653,13 +199653,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<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>\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies#get-a-deployment-branch-policy\">Get a deployment branch policy</a>.\"</p>\n</div>\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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<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>\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies#get-a-deployment-branch-policy\">Get a deployment branch policy</a>.\"</p>\n</div>\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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -206332,13 +206332,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -206521,13 +206521,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -206642,13 +206642,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -206710,13 +206710,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -206788,13 +206788,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -207155,13 +207155,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Sets the message and expiration time for the global announcement banner in your enterprise.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Sets the message and expiration time for the global announcement banner in your enterprise.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -212471,13 +212471,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -213356,13 +213356,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -214814,13 +214814,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -221825,13 +221825,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Deletes a personal access token. Returns a <code>403 - Forbidden</code> status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Deletes a personal access token. Returns a <code>403 - Forbidden</code> status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -233387,6 +233387,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -233404,8 +233405,7 @@
"httpStatusCode": "404", "httpStatusCode": "404",
"description": "<p>Resource not found</p>" "description": "<p>Resource not found</p>"
} }
], ]
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -238924,6 +238924,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Updates a comment on a gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/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.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.base64+json</code></strong>: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.</li>\n</ul>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -238933,8 +238934,7 @@
"httpStatusCode": "404", "httpStatusCode": "404",
"description": "<p>Resource not found</p>" "description": "<p>Resource not found</p>"
} }
], ]
"descriptionHTML": "<p>Updates a comment on a gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/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.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.base64+json</code></strong>: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.</li>\n</ul>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -299173,13 +299173,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Deletes a label using the given label name.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Deletes a label using the given label name.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -319608,13 +319608,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -319851,13 +319851,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Get the octocat as ASCII art</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Get the octocat as ASCII art</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -344817,13 +344817,13 @@
} }
], ],
"previews": [], "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 the future. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization\">List custom repository roles</a>\" endpoint instead.</p>\n</div>\n<p>List the custom repository roles available in this organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/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 administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>Response - list of custom role names</p>" "description": "<p>Response - list of custom role names</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 the future. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization\">List custom repository roles</a>\" endpoint instead.</p>\n</div>\n<p>List the custom repository roles available in this organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/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 administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -346289,13 +346289,13 @@
} }
], ],
"previews": [], "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.15/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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "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.15/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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -346381,13 +346381,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/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 of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/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 of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>"
} }
], ],
"members": [ "members": [
@@ -356975,11 +356975,11 @@
}, },
"before_sha": { "before_sha": {
"type": "string", "type": "string",
"description": "The first commit sha before the push evaluation." "description": "The previous commit SHA of the ref."
}, },
"after_sha": { "after_sha": {
"type": "string", "type": "string",
"description": "The last commit sha in the push evaluation." "description": "The new commit SHA of the ref."
}, },
"ref": { "ref": {
"type": "string", "type": "string",
@@ -364278,13 +364278,13 @@
} }
], ],
"previews": [], "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.15/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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "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.15/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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -364342,13 +364342,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Adds a team as a security manager for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security for an organization</a> for an organization.\"</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>write:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Adds a team as a security manager for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security for an organization</a> for an organization.\"</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>write:org</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -364406,13 +364406,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes the security manager role from a team for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a> team from an organization.\"</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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Removes the security manager role from a team for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a> team from an organization.\"</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>"
} }
], ],
"webhooks": [ "webhooks": [
@@ -365544,13 +365544,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get 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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -381471,13 +381471,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.</p>\n<p>Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.</p>\n<p>Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -412299,13 +412299,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Edits the content of a specified review comment.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Edits the content of a specified review comment.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -431359,6 +431359,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.15/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -431368,8 +431369,7 @@
"httpStatusCode": "404", "httpStatusCode": "404",
"description": "<p>Resource not found</p>" "description": "<p>Resource not found</p>"
} }
], ]
"descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.15/rest/commits/comments#get-a-commit-comment\">commit comment</a>.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -434254,13 +434254,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<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 repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue\">issue</a>.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<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 repository by <code>repository_id</code> using the route <code>DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue\">issue</a>.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -463066,13 +463066,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/enterprise-server@3.15/articles/about-repository-transfers/\">about repository transfers</a>.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "202", "httpStatusCode": "202",
"description": "<p>Accepted</p>" "description": "<p>Accepted</p>"
} }
], ]
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/enterprise-server@3.15/articles/about-repository-transfers/\">about repository transfers</a>.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -480681,6 +480681,7 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Create new or update existing custom property values for a repository.\nUsing a value of <code>null</code> for a custom property will remove or 'unset' the property value from the repository.</p>\n<p>Repository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -480698,8 +480699,7 @@
"httpStatusCode": "422", "httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>" "description": "<p>Validation failed, or the endpoint has been spammed.</p>"
} }
], ]
"descriptionHTML": "<p>Create new or update existing custom property values for a repository.\nUsing a value of <code>null</code> for a custom property will remove or 'unset' the property value from the repository.</p>\n<p>Repository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.</p>"
} }
], ],
"forks": [ "forks": [
@@ -486569,13 +486569,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Disables Git LFS for a repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
], ]
"descriptionHTML": "<p>Disables Git LFS for a repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
} }
], ],
"rule-suites": [ "rule-suites": [
@@ -486943,11 +486943,11 @@
}, },
"before_sha": { "before_sha": {
"type": "string", "type": "string",
"description": "The first commit sha before the push evaluation." "description": "The previous commit SHA of the ref."
}, },
"after_sha": { "after_sha": {
"type": "string", "type": "string",
"description": "The last commit sha in the push evaluation." "description": "The new commit SHA of the ref."
}, },
"ref": { "ref": {
"type": "string", "type": "string",
@@ -497083,13 +497083,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:repo_hook</code> or <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
], ]
"descriptionHTML": "<p>Updates the webhook configuration for a repository. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/webhooks/repos#update-a-repository-webhook\">Update a repository webhook</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:repo_hook</code> or <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -519746,13 +519746,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists the child teams of the team specified by <code>{team_slug}</code>.</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}/teams</code>.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>if child teams exist</p>" "description": "<p>if child teams exist</p>"
} }
], ]
"descriptionHTML": "<p>Lists the child teams of the team specified by <code>{team_slug}</code>.</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}/teams</code>.</p>\n</div>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -531197,13 +531197,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</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>POST /organizations/{org_id}/team/{team_id}/discussions</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": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
], ]
"descriptionHTML": "<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.15/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</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>POST /organizations/{org_id}/team/{team_id}/discussions</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", "serverUrl": "http(s)://HOSTNAME/api/v3",

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

@@ -2836,13 +2836,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2901,13 +2901,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5461,13 +5461,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\" and\n\"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository\">Allowing access to components in an internal repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\" and\n\"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository\">Allowing access to components in an internal repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5543,13 +5543,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\" and\n\"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository\">Allowing access to components in an internal repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\" and\n\"<a href=\"https://docs.github.com/enterprise-server@3.16/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository\">Allowing access to components in an internal repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -8834,13 +8834,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a single environment secret without revealing its encrypted value.</p>\n<p>Authenticated users 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>repo</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Gets a single environment secret without revealing its encrypted value.</p>\n<p>Authenticated users 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>repo</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -9250,13 +9250,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all self-hosted runner groups 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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Lists all self-hosted runner groups 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -9563,13 +9563,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a specific 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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Gets a specific 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10153,13 +10153,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10462,13 +10462,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Lists the self-hosted runners that are in a specific enterprise group.</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10677,13 +10677,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -11411,13 +11411,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an 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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Updates the <code>name</code> and <code>visibility</code> of a self-hosted runner group in an 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -11475,13 +11475,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Deletes a self-hosted runner group for an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Deletes a self-hosted runner group for an organization.</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -13116,13 +13116,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists self-hosted runners that are in a specific organization group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Lists self-hosted runners that are in a specific organization group.</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -16060,13 +16060,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>Example using remove token:</p>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
] ],
"descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>Example using remove token:</p>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -16427,7 +16427,6 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists all labels for a self-hosted runner configured in 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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -16437,7 +16436,8 @@
"httpStatusCode": "404", "httpStatusCode": "404",
"description": "<p>Resource not found</p>" "description": "<p>Resource not found</p>"
} }
] ],
"descriptionHTML": "<p>Lists all labels for a self-hosted runner configured in 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -17379,13 +17379,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>Authenticated users must have admin access to 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. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Lists binaries for the runner application that you can download and run.</p>\n<p>Authenticated users must have admin access to 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. If the repository is private, the <code>repo</code> scope is also required.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -18681,13 +18681,13 @@
} }
], ],
"previews": [], "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": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -27468,13 +27468,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets a specific variable in an environment.</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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Gets a specific variable in an environment.</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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -55872,13 +55872,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<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>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<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>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -67733,13 +67733,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>This is the user's organization dashboard. You must be authenticated as the user to view this.</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>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>This is the user's organization dashboard. You must be authenticated as the user to view this.</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>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -82251,13 +82251,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: <a href=\"https://github.com/notifications\">https://github.com/notifications</a>.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No content</p>" "description": "<p>No content</p>"
} }
] ],
"descriptionHTML": "<p>Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: <a href=\"https://github.com/notifications\">https://github.com/notifications</a>.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -109665,7 +109665,6 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return <code>404 NOT FOUND</code>.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -109675,7 +109674,8 @@
"httpStatusCode": "422", "httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>" "description": "<p>Validation failed, or the endpoint has been spammed.</p>"
} }
] ],
"descriptionHTML": "<p>OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. Invalid tokens will return <code>404 NOT FOUND</code>.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -172341,13 +172341,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -183855,13 +183855,13 @@
} }
], ],
"previews": [], "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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -196269,13 +196269,13 @@
} }
], ],
"previews": [], "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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -210095,13 +210095,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -210536,13 +210536,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -210604,13 +210604,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": ""
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -213022,13 +213022,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the GitHub Advanced Security active committers for an enterprise per repository.</p>\n<p>Each distinct user login across all repositories is counted as a single Advanced Security seat, so the <code>total_advanced_security_committers</code> is not the sum of active_users for each repository.</p>\n<p>The total number of repositories with committer information is tracked by the <code>total_count</code> field.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>Success</p>" "description": "<p>Success</p>"
} }
] ],
"descriptionHTML": "<p>Gets the GitHub Advanced Security active committers for an enterprise per repository.</p>\n<p>Each distinct user login across all repositories is counted as a single Advanced Security seat, so the <code>total_advanced_security_committers</code> is not the sum of active_users for each repository.</p>\n<p>The total number of repositories with committer information is tracked by the <code>total_count</code> field.</p>"
} }
], ],
"code-security-and-analysis": [ "code-security-and-analysis": [
@@ -217795,13 +217795,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>For pre-receive hooks which are allowed to be configured at the org level, you can set <code>enforcement</code> and <code>allow_downstream_configuration</code></p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>For pre-receive hooks which are allowed to be configured at the org level, you can set <code>enforcement</code> and <code>allow_downstream_configuration</code></p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -247075,7 +247075,6 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>List all templates available to pass as an option when <a href=\"https://docs.github.com/enterprise-server@3.16/rest/repos/repos#create-a-repository-for-the-authenticated-user\">creating a repository</a>.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -247085,7 +247084,8 @@
"httpStatusCode": "304", "httpStatusCode": "304",
"description": "<p>Not modified</p>" "description": "<p>Not modified</p>"
} }
] ],
"descriptionHTML": "<p>List all templates available to pass as an option when <a href=\"https://docs.github.com/enterprise-server@3.16/rest/repos/repos#create-a-repository-for-the-authenticated-user\">creating a repository</a>.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -273868,13 +273868,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "201", "httpStatusCode": "201",
"description": "<p>Created</p>" "description": "<p>Created</p>"
} }
] ],
"descriptionHTML": "<p>Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -286397,7 +286397,6 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists events for a repository.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
@@ -286407,7 +286406,8 @@
"httpStatusCode": "422", "httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>" "description": "<p>Validation failed, or the endpoint has been spammed.</p>"
} }
] ],
"descriptionHTML": "<p>Lists events for a repository.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -324869,13 +324869,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -346930,13 +346930,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Gets the audit log for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization\">Reviewing the audit log for your organization</a>.\"</p>\n<p>By default, the response includes up to 30 events from the past three months. Use the <code>phrase</code> parameter to filter results and retrieve older events. For example, use the <code>phrase</code> parameter with the <code>created</code> qualifier to filter events based on when the events occurred. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log\">Reviewing the audit log for your organization</a>.\"</p>\n<p>Use pagination to retrieve fewer or more than 30 events. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/guides/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:audit_log</code> scope to use this endpoint.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Gets the audit log for an organization. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization\">Reviewing the audit log for your organization</a>.\"</p>\n<p>By default, the response includes up to 30 events from the past three months. Use the <code>phrase</code> parameter to filter results and retrieve older events. For example, use the <code>phrase</code> parameter with the <code>created</code> qualifier to filter events based on when the events occurred. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log\">Reviewing the audit log for your organization</a>.\"</p>\n<p>Use pagination to retrieve fewer or more than 30 events. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/rest/guides/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:audit_log</code> scope to use this endpoint.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -351644,13 +351644,13 @@
} }
], ],
"previews": [], "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.16/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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "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.16/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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -356239,13 +356239,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Removes an organization role from a team. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization 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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Removes an organization role from a team. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -356303,13 +356303,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Revokes all assigned organization roles from a user. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization 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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Revokes all assigned organization roles from a user. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -356459,13 +356459,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Remove an organization role from a user. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization 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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "description": "<p>No Content</p>"
} }
] ],
"descriptionHTML": "<p>Remove an organization role from a user. For more information on organization roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.16/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -362331,11 +362331,11 @@
}, },
"before_sha": { "before_sha": {
"type": "string", "type": "string",
"description": "The first commit sha before the push evaluation." "description": "The previous commit SHA of the ref."
}, },
"after_sha": { "after_sha": {
"type": "string", "type": "string",
"description": "The last commit sha in the push evaluation." "description": "The new commit SHA of the ref."
}, },
"ref": { "ref": {
"type": "string", "type": "string",
@@ -369706,13 +369706,13 @@
} }
], ],
"previews": [], "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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
"description": "<p>No Content</p>" "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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -370790,7 +370790,6 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Delete a webhook for an organization.</p>\n<p>The authenticated user 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": [ "statusCodes": [
{ {
"httpStatusCode": "204", "httpStatusCode": "204",
@@ -370800,7 +370799,8 @@
"httpStatusCode": "404", "httpStatusCode": "404",
"description": "<p>Resource not found</p>" "description": "<p>Resource not found</p>"
} }
] ],
"descriptionHTML": "<p>Delete a webhook for an organization.</p>\n<p>The authenticated user 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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -467060,13 +467060,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -492937,11 +492937,11 @@
}, },
"before_sha": { "before_sha": {
"type": "string", "type": "string",
"description": "The first commit sha before the push evaluation." "description": "The previous commit SHA of the ref."
}, },
"after_sha": { "after_sha": {
"type": "string", "type": "string",
"description": "The last commit sha in the push evaluation." "description": "The new commit SHA of the ref."
}, },
"ref": { "ref": {
"type": "string", "type": "string",
@@ -535185,13 +535185,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Get a specific comment on a team discussion.</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}/comments/{comment_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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Get a specific comment on a team discussion.</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}/comments/{comment_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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -535647,13 +535647,13 @@
} }
], ],
"previews": [], "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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -539113,13 +539113,13 @@
} }
], ],
"previews": [], "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": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "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", "serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -542823,13 +542823,13 @@
} }
], ],
"previews": [], "previews": [],
"descriptionHTML": "<p>Team members will include the members of child teams.</p>\n<p>To list members in a team, the team must be visible to the authenticated user.</p>",
"statusCodes": [ "statusCodes": [
{ {
"httpStatusCode": "200", "httpStatusCode": "200",
"description": "<p>OK</p>" "description": "<p>OK</p>"
} }
] ],
"descriptionHTML": "<p>Team members will include the members of child teams.</p>\n<p>To list members in a team, the team must be visible to the authenticated user.</p>"
}, },
{ {
"serverUrl": "http(s)://HOSTNAME/api/v3", "serverUrl": "http(s)://HOSTNAME/api/v3",

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

@@ -363738,11 +363738,11 @@
}, },
"before_sha": { "before_sha": {
"type": "string", "type": "string",
"description": "The first commit sha before the push evaluation." "description": "The previous commit SHA of the ref."
}, },
"after_sha": { "after_sha": {
"type": "string", "type": "string",
"description": "The last commit sha in the push evaluation." "description": "The new commit SHA of the ref."
}, },
"ref": { "ref": {
"type": "string", "type": "string",
@@ -494523,11 +494523,11 @@
}, },
"before_sha": { "before_sha": {
"type": "string", "type": "string",
"description": "The first commit sha before the push evaluation." "description": "The previous commit SHA of the ref."
}, },
"after_sha": { "after_sha": {
"type": "string", "type": "string",
"description": "The last commit sha in the push evaluation." "description": "The new commit SHA of the ref."
}, },
"ref": { "ref": {
"type": "string", "type": "string",

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

@@ -44,5 +44,5 @@
] ]
} }
}, },
"sha": "f0dc156505ef3ea9ae0fd2f227aca5642c465e4f" "sha": "e605333115d5123d2ac50baf757e65cbb94a60c3"
} }

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

298
src/webhooks/data/ghes-3.14/schema.json
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

@@ -1,3 +1,3 @@
{ {
"sha": "f0dc156505ef3ea9ae0fd2f227aca5642c465e4f" "sha": "e605333115d5123d2ac50baf757e65cbb94a60c3"
} }