jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-07 09:01:31 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #31765 from github/repo-sync

Browse Source 
Repo sync
This commit is contained in:
docs-bot
2024-02-21 14:58:23 -08:00
committed by GitHub
parent 95373c60cb a5275d9858
commit 4f01041220
27 changed files with 399 additions and 640 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
.github/workflows/triage-unallowed-contributions.yml vendored
View File

@@ -25,9 +25,6 @@ jobs:
- name: Check out repo
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
- name: Set up Node and dependencies
uses: ./.github/actions/node-npm-setup
- name: Get files changed
uses: dorny/paths-filter@0bc4621a3135347011ad047f9ecf449bf72ce2bd
id: filter
@@ -42,6 +39,10 @@ jobs:
# Returns list of changed files matching each filter
filters: 'src/workflows/unallowed-contribution-filters.yml'
- name: Set up Node and dependencies
if: ${{ steps.filter.outputs.notAllowed || steps.filter.outputs.contentTypes}}
uses: ./.github/actions/node-npm-setup
# When there are changes to files we can't accept, leave a comment
# explaining this to the PR author
- name: "Comment about changes we can't accept"
@@ -51,5 +52,6 @@ jobs:
REPO_OWNER_AND_NAME: ${{ github.repository }}
PR_NUMBER: ${{ github.event.number }}
FILE_PATHS_NOT_ALLOWED: ${{ steps.filter.outputs.notAllowed_files }}
FILE_PATHS_CONTENT_TYPES: ${{ steps.filter.outputs.contentTypes_files }}
CHANGED_FILE_PATHS: ${{ steps.filter.outputs.contentTypes_files }}
ADDED_CONTENT_FILES: ${{ steps.filter.outputs.added_files }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

7
content/rest/copilot/copilot-business.md → content/rest/copilot/copilot-user-management.md
View File

@@ -1,7 +1,7 @@
---
title: Copilot business
shortTitle: Copilot business
intro: 'Use the REST API to manage the {% data variables.product.prodname_copilot_for_business %} subscription for your organization.'
title: Copilot user management
shortTitle: Copilot user management
intro: 'Use the REST API to manage the {% data variables.product.prodname_copilot_for_business %} or {% data variables.product.prodname_copilot_enterprise %} subscription for your organization.'
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
fpt: '*'
ghec: '*'
@@ -11,6 +11,7 @@ autogenerated: rest
allowTitleToDifferFromFilename: true
redirect_from:
- /rest/copilot/copilot-for-business
- /rest/copilot/copilot-business
---
{% note %}

2
content/rest/copilot/index.md
View File

@@ -9,7 +9,7 @@ topics:
autogenerated: rest
allowTitleToDifferFromFilename: true
children:
- /copilot-business
- /copilot-user-management
versions:
fpt: '*'
ghec: '*'

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

@@ -503,8 +503,8 @@
"permissions": [
{
"category": "copilot",
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing",
"additional-permissions": false,
@@ -512,8 +512,8 @@
},
{
"category": "copilot",
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
"subcategory": "copilot-business",
"slug": "list-all-copilot-seat-assignments-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing/seats",
"additional-permissions": false,
@@ -521,8 +521,17 @@
},
{
"category": "copilot",
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
"additional-permissions": false,
"access": "write"
},
{
"category": "copilot",
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
"additional-permissions": false,
@@ -530,8 +539,17 @@
},
{
"category": "copilot",
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
"additional-permissions": false,
"access": "write"
},
{
"category": "copilot",
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
"additional-permissions": false,
@@ -539,8 +557,8 @@
},
{
"category": "copilot",
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-assignment-details-for-a-user",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot",
"additional-permissions": false,

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

@@ -1831,32 +1831,44 @@
],
"copilot": [
{
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
"subcategory": "copilot-business",
"slug": "list-all-copilot-seat-assignments-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
},
{
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
},
{
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-assignment-details-for-a-user",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot"
}

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

@@ -607,8 +607,8 @@
"permissions": [
{
"category": "copilot",
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing",
"access": "write",
@@ -618,8 +618,8 @@
},
{
"category": "copilot",
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
"subcategory": "copilot-business",
"slug": "list-all-copilot-seat-assignments-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing/seats",
"access": "write",
@@ -629,8 +629,19 @@
},
{
"category": "copilot",
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "copilot",
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
"access": "write",
@@ -640,8 +651,19 @@
},
{
"category": "copilot",
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "copilot",
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
"access": "write",
@@ -651,8 +673,8 @@
},
{
"category": "copilot",
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-assignment-details-for-a-user",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot",
"access": "write",

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

@@ -1559,32 +1559,44 @@
],
"copilot": [
{
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
"subcategory": "copilot-business",
"slug": "list-all-copilot-seat-assignments-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
},
{
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
},
{
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-assignment-details-for-a-user",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot"
}

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

@@ -1831,32 +1831,44 @@
],
"copilot": [
{
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
"subcategory": "copilot-business",
"slug": "list-all-copilot-seat-assignments-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
},
{
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
},
{
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-assignment-details-for-a-user",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot"
}

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

@@ -911,8 +911,8 @@
"permissions": [
{
"category": "copilot",
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing",
"additional-permissions": false,
@@ -920,8 +920,8 @@
},
{
"category": "copilot",
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
"subcategory": "copilot-business",
"slug": "list-all-copilot-seat-assignments-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing/seats",
"additional-permissions": false,
@@ -929,8 +929,17 @@
},
{
"category": "copilot",
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
"additional-permissions": false,
"access": "write"
},
{
"category": "copilot",
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
"additional-permissions": false,
@@ -938,8 +947,17 @@
},
{
"category": "copilot",
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
"additional-permissions": false,
"access": "write"
},
{
"category": "copilot",
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
"additional-permissions": false,
@@ -947,8 +965,8 @@
},
{
"category": "copilot",
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-assignment-details-for-a-user",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot",
"additional-permissions": false,

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

@@ -1947,32 +1947,44 @@
],
"copilot": [
{
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
"subcategory": "copilot-business",
"slug": "list-all-copilot-seat-assignments-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
},
{
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
},
{
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-assignment-details-for-a-user",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot"
}

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

@@ -1103,8 +1103,8 @@
"permissions": [
{
"category": "copilot",
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing",
"access": "write",
@@ -1114,8 +1114,8 @@
},
{
"category": "copilot",
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
"subcategory": "copilot-business",
"slug": "list-all-copilot-seat-assignments-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing/seats",
"access": "write",
@@ -1125,8 +1125,19 @@
},
{
"category": "copilot",
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "copilot",
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
"access": "write",
@@ -1136,8 +1147,19 @@
},
{
"category": "copilot",
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
},
{
"category": "copilot",
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
"access": "write",
@@ -1147,8 +1169,8 @@
},
{
"category": "copilot",
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-assignment-details-for-a-user",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot",
"access": "write",

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

@@ -1675,32 +1675,44 @@
],
"copilot": [
{
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
"subcategory": "copilot-business",
"slug": "list-all-copilot-seat-assignments-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
},
{
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
},
{
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-assignment-details-for-a-user",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot"
}

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

@@ -1947,32 +1947,44 @@
],
"copilot": [
{
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
"subcategory": "copilot-business",
"slug": "list-all-copilot-seat-assignments-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
},
{
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
},
{
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
"subcategory": "copilot-business",
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
"subcategory": "copilot-user-management",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
},
{
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
"subcategory": "copilot-business",
"slug": "get-copilot-seat-assignment-details-for-a-user",
"subcategory": "copilot-user-management",
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot"
}

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

@@ -60,5 +60,5 @@
"2022-11-28"
]
},
"sha": "e3b351abbafd1e19e95319d396f0513038f332b1"
"sha": "9c5dc4417755fe3dc6184095970a8314151aa8ca"
}

96
src/redirects/lib/static/developer.json
View File

@@ -15,37 +15,31 @@
"/enterprise/admin/articles/restricting-ssh-access-to-specific-hosts": "/enterprise-server@3.0/admin/configuration/configuring-your-enterprise",
"/enterprise-server@2.20/admin/articles/restricting-ssh-access-to-specific-hosts": "/enterprise-server@2.20/admin/configuration/configuring-your-enterprise",
"/enterprise/2.20/admin/articles/restricting-ssh-access-to-specific-hosts": "/enterprise-server@2.20/admin/configuration/configuring-your-enterprise",
"/github-ae@latest/admin/articles/restricting-ssh-access-to-specific-hosts": "/github-ae@latest/admin/configuration/configuring-your-enterprise",
"/admin/user-management/restricting-repository-creation-in-your-instance": "/enterprise-server@3.0/admin/policies/enforcing-repository-management-policies-in-your-enterprise",
"/enterprise/admin/user-management/restricting-repository-creation-in-your-instance": "/enterprise-server@3.0/admin/policies/enforcing-repository-management-policies-in-your-enterprise",
"/enterprise-server@2.20/admin/user-management/restricting-repository-creation-in-your-instance": "/enterprise-server@2.20/admin/policies/enforcing-repository-management-policies-in-your-enterprise",
"/enterprise/2.20/admin/user-management/restricting-repository-creation-in-your-instance": "/enterprise-server@2.20/admin/policies/enforcing-repository-management-policies-in-your-enterprise",
"/github-ae@latest/admin/user-management/restricting-repository-creation-in-your-instance": "/github-ae@latest/admin/policies/enforcing-repository-management-policies-in-your-enterprise",
"/v3/oauth": "/developers/apps/authorizing-oauth-apps",
"/free-pro-team@latest/v3/oauth": "/developers/apps/authorizing-oauth-apps",
"/enterprise/v3/oauth": "/enterprise-server@latest/developers/apps/authorizing-oauth-apps",
"/enterprise-server@2.20/v3/oauth": "/enterprise-server@2.20/developers/apps/authorizing-oauth-apps",
"/enterprise/2.20/v3/oauth": "/enterprise-server@2.20/developers/apps/authorizing-oauth-apps",
"/github-ae@latest/v3/oauth": "/github-ae@latest/developers/apps/authorizing-oauth-apps",
"/v3/integrations": "/developers/apps",
"/free-pro-team@latest/v3/integrations": "/developers/apps",
"/enterprise/v3/integrations": "/enterprise-server@latest/developers/apps",
"/enterprise-server@2.20/v3/integrations": "/enterprise-server@2.20/developers/apps",
"/enterprise/2.20/v3/integrations": "/enterprise-server@2.20/developers/apps",
"/github-ae@latest/v3/integrations": "/github-ae@latest/developers/apps",
"/free-pro-team@latest/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api": "/developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api",
"/v3/versions": "/developers/overview/about-githubs-apis",
"/free-pro-team@latest/v3/versions": "/developers/overview/about-githubs-apis",
"/enterprise/v3/versions": "/enterprise-server@latest/developers/overview/about-githubs-apis",
"/enterprise-server@2.20/v3/versions": "/enterprise-server@2.20/developers/overview/about-githubs-apis",
"/enterprise/2.20/v3/versions": "/enterprise-server@2.20/developers/overview/about-githubs-apis",
"/github-ae@latest/v3/versions": "/github-ae@latest/developers/overview/about-githubs-apis",
"/v3/guides/managing-deploy-keys": "/developers/overview/managing-deploy-keys",
"/free-pro-team@latest/v3/guides/managing-deploy-keys": "/developers/overview/managing-deploy-keys",
"/enterprise/v3/guides/managing-deploy-keys": "/enterprise-server@latest/developers/overview/managing-deploy-keys",
"/enterprise-server@2.20/v3/guides/managing-deploy-keys": "/enterprise-server@2.20/developers/overview/managing-deploy-keys",
"/enterprise/2.20/v3/guides/managing-deploy-keys": "/enterprise-server@2.20/developers/overview/managing-deploy-keys",
"/github-ae@latest/v3/guides/managing-deploy-keys": "/github-ae@latest/developers/overview/managing-deploy-keys",
"/v3/guides/automating-deployments-to-integrators": "/developers/overview/replacing-github-services",
"/free-pro-team@latest/v3/guides/automating-deployments-to-integrators": "/developers/overview/replacing-github-services",
"/v3/guides/replacing-github-services": "/developers/overview/replacing-github-services",
@@ -61,31 +55,26 @@
"/enterprise/v3/guides/using-ssh-agent-forwarding": "/enterprise-server@latest/developers/overview/using-ssh-agent-forwarding",
"/enterprise-server@2.20/v3/guides/using-ssh-agent-forwarding": "/enterprise-server@2.20/developers/overview/using-ssh-agent-forwarding",
"/enterprise/2.20/v3/guides/using-ssh-agent-forwarding": "/enterprise-server@2.20/developers/overview/using-ssh-agent-forwarding",
"/github-ae@latest/v3/guides/using-ssh-agent-forwarding": "/github-ae@latest/developers/overview/using-ssh-agent-forwarding",
"/v3/activity/event_types": "/developers/webhooks-and-events/github-event-types",
"/free-pro-team@latest/v3/activity/event_types": "/developers/webhooks-and-events/github-event-types",
"/enterprise/v3/activity/event_types": "/enterprise-server@latest/developers/webhooks-and-events/github-event-types",
"/enterprise-server@2.20/v3/activity/event_types": "/enterprise-server@2.20/developers/webhooks-and-events/github-event-types",
"/enterprise/2.20/v3/activity/event_types": "/enterprise-server@2.20/developers/webhooks-and-events/github-event-types",
"/github-ae@latest/v3/activity/event_types": "/github-ae@latest/developers/webhooks-and-events/github-event-types",
"/v3/issues/issue-event-types": "/developers/webhooks-and-events/issue-event-types",
"/free-pro-team@latest/v3/issues/issue-event-types": "/developers/webhooks-and-events/issue-event-types",
"/enterprise/v3/issues/issue-event-types": "/enterprise-server@latest/developers/webhooks-and-events/issue-event-types",
"/enterprise-server@2.20/v3/issues/issue-event-types": "/enterprise-server@2.20/developers/webhooks-and-events/issue-event-types",
"/enterprise/2.20/v3/issues/issue-event-types": "/enterprise-server@2.20/developers/webhooks-and-events/issue-event-types",
"/github-ae@latest/v3/issues/issue-event-types": "/github-ae@latest/developers/webhooks-and-events/issue-event-types",
"/v3/activity/events/types": "/developers/webhooks-and-events/webhook-events-and-payloads",
"/free-pro-team@latest/v3/activity/events/types": "/developers/webhooks-and-events/webhook-events-and-payloads",
"/enterprise/v3/activity/events/types": "/enterprise-server@latest/developers/webhooks-and-events/webhook-events-and-payloads",
"/enterprise-server@2.20/v3/activity/events/types": "/enterprise-server@2.20/developers/webhooks-and-events/webhook-events-and-payloads",
"/enterprise/2.20/v3/activity/events/types": "/enterprise-server@2.20/developers/webhooks-and-events/webhook-events-and-payloads",
"/github-ae@latest/v3/activity/events/types": "/github-ae@latest/developers/webhooks-and-events/webhook-events-and-payloads",
"/articles/restoring-branches-in-a-pull-request": "/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request",
"/free-pro-team@latest/articles/restoring-branches-in-a-pull-request": "/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request",
"/enterprise/articles/restoring-branches-in-a-pull-request": "/enterprise-server@3.0/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request",
"/enterprise-server@2.20/articles/restoring-branches-in-a-pull-request": "/enterprise-server@2.20/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request",
"/enterprise/2.20/articles/restoring-branches-in-a-pull-request": "/enterprise-server@2.20/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request",
"/github-ae@latest/articles/restoring-branches-in-a-pull-request": "/github-ae@latest/github/administering-a-repository/deleting-and-restoring-branches-in-a-pull-request",
"/free-pro-team@latest/github/administering-a-repository/restoring-a-deleted-repository": "/github/administering-a-repository/restoring-a-deleted-repository",
"/articles/restoring-a-deleted-repository": "/github/administering-a-repository/restoring-a-deleted-repository",
"/free-pro-team@latest/articles/restoring-a-deleted-repository": "/github/administering-a-repository/restoring-a-deleted-repository",
@@ -108,7 +97,6 @@
"/enterprise/2.20/user/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization": "/enterprise-server@2.20/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization",
"/enterprise-server@2.20/articles/restricting-repository-creation-in-your-organization": "/enterprise-server@2.20/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization",
"/enterprise/2.20/articles/restricting-repository-creation-in-your-organization": "/enterprise-server@2.20/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization",
"/github-ae@latest/articles/restricting-repository-creation-in-your-organization": "/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization",
"/free-pro-team@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization": "/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization",
"/articles/restricting-repository-visibility-changes-in-your-organization": "/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization",
"/free-pro-team@latest/articles/restricting-repository-visibility-changes-in-your-organization": "/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization",
@@ -118,13 +106,11 @@
"/enterprise/2.20/user/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization": "/enterprise-server@2.20/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization",
"/enterprise-server@2.20/articles/restricting-repository-visibility-changes-in-your-organization": "/enterprise-server@2.20/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization",
"/enterprise/2.20/articles/restricting-repository-visibility-changes-in-your-organization": "/enterprise-server@2.20/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization",
"/github-ae@latest/articles/restricting-repository-visibility-changes-in-your-organization": "/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/restricting-repository-visibility-changes-in-your-organization",
"/articles/restricting-the-ability-to-add-outside-collaborators-to-organization-repositories": "/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators",
"/free-pro-team@latest/articles/restricting-the-ability-to-add-outside-collaborators-to-organization-repositories": "/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators",
"/enterprise/articles/restricting-the-ability-to-add-outside-collaborators-to-organization-repositories": "/enterprise-server@3.0/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators",
"/enterprise-server@2.20/articles/restricting-the-ability-to-add-outside-collaborators-to-organization-repositories": "/enterprise-server@2.20/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators",
"/enterprise/2.20/articles/restricting-the-ability-to-add-outside-collaborators-to-organization-repositories": "/enterprise-server@2.20/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators",
"/github-ae@latest/articles/restricting-the-ability-to-add-outside-collaborators-to-organization-repositories": "/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/setting-permissions-for-adding-outside-collaborators",
"/free-pro-team@latest/github/setting-up-and-managing-your-enterprise/restricting-email-notifications-for-your-enterprise-account-to-approved-domains": "/github/setting-up-and-managing-your-enterprise/restricting-email-notifications-for-your-enterprise-account-to-approved-domains",
"/free-pro-team@latest/graphql/guides/forming-calls-with-graphql": "/graphql/guides/forming-calls-with-graphql",
"/v4/guides/forming-calls": "/graphql/guides/forming-calls-with-graphql",
@@ -139,8 +125,6 @@
"/enterprise/2.20/v4/guides/forming-calls": "/enterprise-server@2.20/graphql/guides/forming-calls-with-graphql",
"/enterprise-server@2.20/graphql/guides/forming-calls": "/enterprise-server@2.20/graphql/guides/forming-calls-with-graphql",
"/enterprise/2.20/graphql/guides/forming-calls": "/enterprise-server@2.20/graphql/guides/forming-calls-with-graphql",
"/github-ae@latest/v4/guides/forming-calls": "/github-ae@latest/graphql/guides/forming-calls-with-graphql",
"/github-ae@latest/graphql/guides/forming-calls": "/github-ae@latest/graphql/guides/forming-calls-with-graphql",
"/free-pro-team@latest/graphql/guides": "/graphql/guides",
"/v4/guides": "/graphql/guides",
"/free-pro-team@latest/v4/guides": "/graphql/guides",
@@ -149,7 +133,6 @@
"/enterprise/2.20/graphql/guides": "/enterprise-server@2.20/graphql/guides",
"/enterprise-server@2.20/v4/guides": "/enterprise-server@2.20/graphql/guides",
"/enterprise/2.20/v4/guides": "/enterprise-server@2.20/graphql/guides",
"/github-ae@latest/v4/guides": "/github-ae@latest/graphql/guides",
"/free-pro-team@latest/graphql/guides/introduction-to-graphql": "/graphql/guides/introduction-to-graphql",
"/v4/guides/intro-to-graphql": "/graphql/guides/introduction-to-graphql",
"/free-pro-team@latest/v4/guides/intro-to-graphql": "/graphql/guides/introduction-to-graphql",
@@ -163,8 +146,6 @@
"/enterprise/2.20/v4/guides/intro-to-graphql": "/enterprise-server@2.20/graphql/guides/introduction-to-graphql",
"/enterprise-server@2.20/graphql/guides/intro-to-graphql": "/enterprise-server@2.20/graphql/guides/introduction-to-graphql",
"/enterprise/2.20/graphql/guides/intro-to-graphql": "/enterprise-server@2.20/graphql/guides/introduction-to-graphql",
"/github-ae@latest/v4/guides/intro-to-graphql": "/github-ae@latest/graphql/guides/introduction-to-graphql",
"/github-ae@latest/graphql/guides/intro-to-graphql": "/github-ae@latest/graphql/guides/introduction-to-graphql",
"/free-pro-team@latest/graphql/guides/managing-enterprise-accounts": "/graphql/guides/managing-enterprise-accounts",
"/v4/guides/managing-enterprise-accounts": "/graphql/guides/managing-enterprise-accounts",
"/free-pro-team@latest/v4/guides/managing-enterprise-accounts": "/graphql/guides/managing-enterprise-accounts",
@@ -173,7 +154,6 @@
"/enterprise/2.20/graphql/guides/managing-enterprise-accounts": "/enterprise-server@2.20/graphql/guides/managing-enterprise-accounts",
"/enterprise-server@2.20/v4/guides/managing-enterprise-accounts": "/enterprise-server@2.20/graphql/guides/managing-enterprise-accounts",
"/enterprise/2.20/v4/guides/managing-enterprise-accounts": "/enterprise-server@2.20/graphql/guides/managing-enterprise-accounts",
"/github-ae@latest/v4/guides/managing-enterprise-accounts": "/github-ae@latest/graphql/guides/managing-enterprise-accounts",
"/free-pro-team@latest/graphql/guides/migrating-from-rest-to-graphql": "/graphql/guides/migrating-from-rest-to-graphql",
"/v4/guides/migrating-from-rest": "/graphql/guides/migrating-from-rest-to-graphql",
"/free-pro-team@latest/v4/guides/migrating-from-rest": "/graphql/guides/migrating-from-rest-to-graphql",
@@ -187,8 +167,6 @@
"/enterprise/2.20/v4/guides/migrating-from-rest": "/enterprise-server@2.20/graphql/guides/migrating-from-rest-to-graphql",
"/enterprise-server@2.20/graphql/guides/migrating-from-rest": "/enterprise-server@2.20/graphql/guides/migrating-from-rest-to-graphql",
"/enterprise/2.20/graphql/guides/migrating-from-rest": "/enterprise-server@2.20/graphql/guides/migrating-from-rest-to-graphql",
"/github-ae@latest/v4/guides/migrating-from-rest": "/github-ae@latest/graphql/guides/migrating-from-rest-to-graphql",
"/github-ae@latest/graphql/guides/migrating-from-rest": "/github-ae@latest/graphql/guides/migrating-from-rest-to-graphql",
"/free-pro-team@latest/graphql/guides/using-global-node-ids": "/graphql/guides/using-global-node-ids",
"/v4/guides/using-global-node-ids": "/graphql/guides/using-global-node-ids",
"/free-pro-team@latest/v4/guides/using-global-node-ids": "/graphql/guides/using-global-node-ids",
@@ -197,7 +175,6 @@
"/enterprise/2.20/graphql/guides/using-global-node-ids": "/enterprise-server@2.20/graphql/guides/using-global-node-ids",
"/enterprise-server@2.20/v4/guides/using-global-node-ids": "/enterprise-server@2.20/graphql/guides/using-global-node-ids",
"/enterprise/2.20/v4/guides/using-global-node-ids": "/enterprise-server@2.20/graphql/guides/using-global-node-ids",
"/github-ae@latest/v4/guides/using-global-node-ids": "/github-ae@latest/graphql/guides/using-global-node-ids",
"/free-pro-team@latest/graphql/guides/using-the-explorer": "/graphql/guides/using-the-explorer",
"/v4/guides/using-the-explorer": "/graphql/guides/using-the-explorer",
"/free-pro-team@latest/v4/guides/using-the-explorer": "/graphql/guides/using-the-explorer",
@@ -206,7 +183,6 @@
"/enterprise/2.20/graphql/guides/using-the-explorer": "/enterprise-server@2.20/graphql/guides/using-the-explorer",
"/enterprise-server@2.20/v4/guides/using-the-explorer": "/enterprise-server@2.20/graphql/guides/using-the-explorer",
"/enterprise/2.20/v4/guides/using-the-explorer": "/enterprise-server@2.20/graphql/guides/using-the-explorer",
"/github-ae@latest/v4/guides/using-the-explorer": "/github-ae@latest/graphql/guides/using-the-explorer",
"/free-pro-team@latest/graphql": "/graphql",
"/v4": "/graphql",
"/free-pro-team@latest/v4": "/graphql",
@@ -215,7 +191,6 @@
"/enterprise/2.20/graphql": "/enterprise-server@2.20/graphql",
"/enterprise-server@2.20/v4": "/enterprise-server@2.20/graphql",
"/enterprise/2.20/v4": "/enterprise-server@2.20/graphql",
"/github-ae@latest/v4": "/github-ae@latest/graphql",
"/free-pro-team@latest/graphql/overview/about-the-graphql-api": "/graphql/overview/about-the-graphql-api",
"/enterprise/graphql/overview/about-the-graphql-api": "/enterprise-server@latest/graphql/overview/about-the-graphql-api",
"/enterprise/2.20/graphql/overview/about-the-graphql-api": "/enterprise-server@2.20/graphql/overview/about-the-graphql-api",
@@ -227,7 +202,6 @@
"/enterprise/2.20/graphql/overview/breaking-changes": "/enterprise-server@2.20/graphql/overview/breaking-changes",
"/enterprise-server@2.20/v4/breaking_changes": "/enterprise-server@2.20/graphql/overview/breaking-changes",
"/enterprise/2.20/v4/breaking_changes": "/enterprise-server@2.20/graphql/overview/breaking-changes",
"/github-ae@latest/v4/breaking_changes": "/github-ae@latest/graphql/overview/breaking-changes",
"/free-pro-team@latest/graphql/overview/changelog": "/graphql/overview/changelog",
"/v4/changelog": "/graphql/overview/changelog",
"/free-pro-team@latest/v4/changelog": "/graphql/overview/changelog",
@@ -236,7 +210,6 @@
"/enterprise/2.20/graphql/overview/changelog": "/enterprise-server@2.20/graphql/overview/changelog",
"/enterprise-server@2.20/v4/changelog": "/enterprise-server@2.20/graphql/overview/changelog",
"/enterprise/2.20/v4/changelog": "/enterprise-server@2.20/graphql/overview/changelog",
"/github-ae@latest/v4/changelog": "/github-ae@latest/graphql/overview/changelog",
"/free-pro-team@latest/graphql/overview/explorer": "/graphql/overview/explorer",
"/v4/explorer": "/graphql/overview/explorer",
"/free-pro-team@latest/v4/explorer": "/graphql/overview/explorer",
@@ -250,8 +223,6 @@
"/enterprise/2.20/v4/explorer": "/enterprise-server@2.20/graphql/overview/explorer",
"/enterprise-server@2.20/v4/explorer-new": "/enterprise-server@2.20/graphql/overview/explorer",
"/enterprise/2.20/v4/explorer-new": "/enterprise-server@2.20/graphql/overview/explorer",
"/github-ae@latest/v4/explorer": "/github-ae@latest/graphql/overview/explorer",
"/github-ae@latest/v4/explorer-new": "/github-ae@latest/graphql/overview/explorer",
"/free-pro-team@latest/graphql/overview": "/graphql/overview",
"/enterprise/graphql/overview": "/enterprise-server@latest/graphql/overview",
"/enterprise/2.20/graphql/overview": "/enterprise-server@2.20/graphql/overview",
@@ -263,7 +234,6 @@
"/enterprise/2.20/graphql/overview/public-schema": "/enterprise-server@2.20/graphql/overview/public-schema",
"/enterprise-server@2.20/v4/public_schema": "/enterprise-server@2.20/graphql/overview/public-schema",
"/enterprise/2.20/v4/public_schema": "/enterprise-server@2.20/graphql/overview/public-schema",
"/github-ae@latest/v4/public_schema": "/github-ae@latest/graphql/overview/public-schema",
"/free-pro-team@latest/graphql/overview/resource-limitations": "/graphql/overview/resource-limitations",
"/v4/guides/resource-limitations": "/graphql/overview/resource-limitations",
"/free-pro-team@latest/v4/guides/resource-limitations": "/graphql/overview/resource-limitations",
@@ -272,7 +242,6 @@
"/enterprise/2.20/graphql/overview/resource-limitations": "/enterprise-server@2.20/graphql/overview/resource-limitations",
"/enterprise-server@2.20/v4/guides/resource-limitations": "/enterprise-server@2.20/graphql/overview/resource-limitations",
"/enterprise/2.20/v4/guides/resource-limitations": "/enterprise-server@2.20/graphql/overview/resource-limitations",
"/github-ae@latest/v4/guides/resource-limitations": "/github-ae@latest/graphql/overview/resource-limitations",
"/free-pro-team@latest/graphql/overview/schema-previews": "/graphql/overview/schema-previews",
"/v4/previews": "/graphql/overview/schema-previews",
"/free-pro-team@latest/v4/previews": "/graphql/overview/schema-previews",
@@ -281,7 +250,6 @@
"/enterprise/2.20/graphql/overview/schema-previews": "/enterprise-server@2.20/graphql/overview/schema-previews",
"/enterprise-server@2.20/v4/previews": "/enterprise-server@2.20/graphql/overview/schema-previews",
"/enterprise/2.20/v4/previews": "/enterprise-server@2.20/graphql/overview/schema-previews",
"/github-ae@latest/v4/previews": "/github-ae@latest/graphql/overview/schema-previews",
"/free-pro-team@latest/graphql/reference/enums": "/graphql/reference/enums",
"/v4/enum": "/graphql/reference/enums",
"/free-pro-team@latest/v4/enum": "/graphql/reference/enums",
@@ -295,8 +263,6 @@
"/enterprise/2.20/v4/enum": "/enterprise-server@2.20/graphql/reference/enums",
"/enterprise-server@2.20/v4/reference/enum": "/enterprise-server@2.20/graphql/reference/enums",
"/enterprise/2.20/v4/reference/enum": "/enterprise-server@2.20/graphql/reference/enums",
"/github-ae@latest/v4/enum": "/github-ae@latest/graphql/reference/enums",
"/github-ae@latest/v4/reference/enum": "/github-ae@latest/graphql/reference/enums",
"/free-pro-team@latest/graphql/reference": "/graphql/reference",
"/v4/reference": "/graphql/reference",
"/free-pro-team@latest/v4/reference": "/graphql/reference",
@@ -305,7 +271,6 @@
"/enterprise/2.20/graphql/reference": "/enterprise-server@2.20/graphql/reference",
"/enterprise-server@2.20/v4/reference": "/enterprise-server@2.20/graphql/reference",
"/enterprise/2.20/v4/reference": "/enterprise-server@2.20/graphql/reference",
"/github-ae@latest/v4/reference": "/github-ae@latest/graphql/reference",
"/free-pro-team@latest/graphql/reference/input-objects": "/graphql/reference/input-objects",
"/v4/input_object": "/graphql/reference/input-objects",
"/free-pro-team@latest/v4/input_object": "/graphql/reference/input-objects",
@@ -319,8 +284,6 @@
"/enterprise/2.20/v4/input_object": "/enterprise-server@2.20/graphql/reference/input-objects",
"/enterprise-server@2.20/v4/reference/input_object": "/enterprise-server@2.20/graphql/reference/input-objects",
"/enterprise/2.20/v4/reference/input_object": "/enterprise-server@2.20/graphql/reference/input-objects",
"/github-ae@latest/v4/input_object": "/github-ae@latest/graphql/reference/input-objects",
"/github-ae@latest/v4/reference/input_object": "/github-ae@latest/graphql/reference/input-objects",
"/free-pro-team@latest/graphql/reference/interfaces": "/graphql/reference/interfaces",
"/v4/interface": "/graphql/reference/interfaces",
"/free-pro-team@latest/v4/interface": "/graphql/reference/interfaces",
@@ -334,8 +297,6 @@
"/enterprise/2.20/v4/interface": "/enterprise-server@2.20/graphql/reference/interfaces",
"/enterprise-server@2.20/v4/reference/interface": "/enterprise-server@2.20/graphql/reference/interfaces",
"/enterprise/2.20/v4/reference/interface": "/enterprise-server@2.20/graphql/reference/interfaces",
"/github-ae@latest/v4/interface": "/github-ae@latest/graphql/reference/interfaces",
"/github-ae@latest/v4/reference/interface": "/github-ae@latest/graphql/reference/interfaces",
"/free-pro-team@latest/graphql/reference/mutations": "/graphql/reference/mutations",
"/v4/mutation": "/graphql/reference/mutations",
"/free-pro-team@latest/v4/mutation": "/graphql/reference/mutations",
@@ -349,8 +310,6 @@
"/enterprise/2.20/v4/mutation": "/enterprise-server@2.20/graphql/reference/mutations",
"/enterprise-server@2.20/v4/reference/mutation": "/enterprise-server@2.20/graphql/reference/mutations",
"/enterprise/2.20/v4/reference/mutation": "/enterprise-server@2.20/graphql/reference/mutations",
"/github-ae@latest/v4/mutation": "/github-ae@latest/graphql/reference/mutations",
"/github-ae@latest/v4/reference/mutation": "/github-ae@latest/graphql/reference/mutations",
"/free-pro-team@latest/graphql/reference/objects": "/graphql/reference/objects",
"/v4/object": "/graphql/reference/objects",
"/free-pro-team@latest/v4/object": "/graphql/reference/objects",
@@ -364,8 +323,6 @@
"/enterprise/2.20/v4/object": "/enterprise-server@2.20/graphql/reference/objects",
"/enterprise-server@2.20/v4/reference/object": "/enterprise-server@2.20/graphql/reference/objects",
"/enterprise/2.20/v4/reference/object": "/enterprise-server@2.20/graphql/reference/objects",
"/github-ae@latest/v4/object": "/github-ae@latest/graphql/reference/objects",
"/github-ae@latest/v4/reference/object": "/github-ae@latest/graphql/reference/objects",
"/free-pro-team@latest/graphql/reference/queries": "/graphql/reference/queries",
"/v4/query": "/graphql/reference/queries",
"/free-pro-team@latest/v4/query": "/graphql/reference/queries",
@@ -379,8 +336,6 @@
"/enterprise/2.20/v4/query": "/enterprise-server@2.20/graphql/reference/queries",
"/enterprise-server@2.20/v4/reference/query": "/enterprise-server@2.20/graphql/reference/queries",
"/enterprise/2.20/v4/reference/query": "/enterprise-server@2.20/graphql/reference/queries",
"/github-ae@latest/v4/query": "/github-ae@latest/graphql/reference/queries",
"/github-ae@latest/v4/reference/query": "/github-ae@latest/graphql/reference/queries",
"/free-pro-team@latest/graphql/reference/scalars": "/graphql/reference/scalars",
"/v4/scalar": "/graphql/reference/scalars",
"/free-pro-team@latest/v4/scalar": "/graphql/reference/scalars",
@@ -394,8 +349,6 @@
"/enterprise/2.20/v4/scalar": "/enterprise-server@2.20/graphql/reference/scalars",
"/enterprise-server@2.20/v4/reference/scalar": "/enterprise-server@2.20/graphql/reference/scalars",
"/enterprise/2.20/v4/reference/scalar": "/enterprise-server@2.20/graphql/reference/scalars",
"/github-ae@latest/v4/scalar": "/github-ae@latest/graphql/reference/scalars",
"/github-ae@latest/v4/reference/scalar": "/github-ae@latest/graphql/reference/scalars",
"/free-pro-team@latest/graphql/reference/unions": "/graphql/reference/unions",
"/v4/union": "/graphql/reference/unions",
"/free-pro-team@latest/v4/union": "/graphql/reference/unions",
@@ -409,8 +362,6 @@
"/enterprise/2.20/v4/union": "/enterprise-server@2.20/graphql/reference/unions",
"/enterprise-server@2.20/v4/reference/union": "/enterprise-server@2.20/graphql/reference/unions",
"/enterprise/2.20/v4/reference/union": "/enterprise-server@2.20/graphql/reference/unions",
"/github-ae@latest/v4/union": "/github-ae@latest/graphql/reference/unions",
"/github-ae@latest/v4/reference/union": "/github-ae@latest/graphql/reference/unions",
"/free-pro-team@latest/rest/guides/basics-of-authentication": "/rest/guides/basics-of-authentication",
"/v3/guides/basics-of-authentication": "/rest/guides/basics-of-authentication",
"/free-pro-team@latest/v3/guides/basics-of-authentication": "/rest/guides/basics-of-authentication",
@@ -424,8 +375,6 @@
"/enterprise/2.20/v3/guides/basics-of-authentication": "/enterprise-server@2.20/rest/guides/basics-of-authentication",
"/enterprise-server@2.20/rest/basics-of-authentication": "/enterprise-server@2.20/rest/guides/basics-of-authentication",
"/enterprise/2.20/rest/basics-of-authentication": "/enterprise-server@2.20/rest/guides/basics-of-authentication",
"/github-ae@latest/v3/guides/basics-of-authentication": "/github-ae@latest/rest/guides/basics-of-authentication",
"/github-ae@latest/rest/basics-of-authentication": "/github-ae@latest/rest/guides/basics-of-authentication",
"/free-pro-team@latest/rest/guides/best-practices-for-integrators": "/rest/guides/best-practices-for-integrators",
"/v3/guides/best-practices-for-integrators": "/rest/guides/best-practices-for-integrators",
"/free-pro-team@latest/v3/guides/best-practices-for-integrators": "/rest/guides/best-practices-for-integrators",
@@ -434,7 +383,6 @@
"/enterprise/2.20/rest/guides/best-practices-for-integrators": "/enterprise-server@2.20/rest/guides/best-practices-for-integrators",
"/enterprise-server@2.20/v3/guides/best-practices-for-integrators": "/enterprise-server@2.20/rest/guides/best-practices-for-integrators",
"/enterprise/2.20/v3/guides/best-practices-for-integrators": "/enterprise-server@2.20/rest/guides/best-practices-for-integrators",
"/github-ae@latest/v3/guides/best-practices-for-integrators": "/github-ae@latest/rest/guides/best-practices-for-integrators",
"/free-pro-team@latest/rest/guides/building-a-ci-server": "/rest/guides/building-a-ci-server",
"/v3/guides/building-a-ci-server": "/rest/guides/building-a-ci-server",
"/free-pro-team@latest/v3/guides/building-a-ci-server": "/rest/guides/building-a-ci-server",
@@ -443,7 +391,6 @@
"/enterprise/2.20/rest/guides/building-a-ci-server": "/enterprise-server@2.20/rest/guides/building-a-ci-server",
"/enterprise-server@2.20/v3/guides/building-a-ci-server": "/enterprise-server@2.20/rest/guides/building-a-ci-server",
"/enterprise/2.20/v3/guides/building-a-ci-server": "/enterprise-server@2.20/rest/guides/building-a-ci-server",
"/github-ae@latest/v3/guides/building-a-ci-server": "/github-ae@latest/rest/guides/building-a-ci-server",
"/free-pro-team@latest/rest/guides/delivering-deployments": "/rest/guides/delivering-deployments",
"/v3/guides/delivering-deployments": "/rest/guides/delivering-deployments",
"/free-pro-team@latest/v3/guides/delivering-deployments": "/rest/guides/delivering-deployments",
@@ -452,7 +399,6 @@
"/enterprise/2.20/rest/guides/delivering-deployments": "/enterprise-server@2.20/rest/guides/delivering-deployments",
"/enterprise-server@2.20/v3/guides/delivering-deployments": "/enterprise-server@2.20/rest/guides/delivering-deployments",
"/enterprise/2.20/v3/guides/delivering-deployments": "/enterprise-server@2.20/rest/guides/delivering-deployments",
"/github-ae@latest/v3/guides/delivering-deployments": "/github-ae@latest/rest/guides/delivering-deployments",
"/free-pro-team@latest/rest/guides/discovering-resources-for-a-user": "/rest/guides/discovering-resources-for-a-user",
"/v3/guides/discovering-resources-for-a-user": "/rest/guides/discovering-resources-for-a-user",
"/free-pro-team@latest/v3/guides/discovering-resources-for-a-user": "/rest/guides/discovering-resources-for-a-user",
@@ -461,7 +407,6 @@
"/enterprise/2.20/rest/guides/discovering-resources-for-a-user": "/enterprise-server@2.20/rest/guides/discovering-resources-for-a-user",
"/enterprise-server@2.20/v3/guides/discovering-resources-for-a-user": "/enterprise-server@2.20/rest/guides/discovering-resources-for-a-user",
"/enterprise/2.20/v3/guides/discovering-resources-for-a-user": "/enterprise-server@2.20/rest/guides/discovering-resources-for-a-user",
"/github-ae@latest/v3/guides/discovering-resources-for-a-user": "/github-ae@latest/rest/guides/discovering-resources-for-a-user",
"/free-pro-team@latest/rest/guides/getting-started-with-the-checks-api": "/rest/guides/getting-started-with-the-checks-api",
"/enterprise/rest/guides/getting-started-with-the-checks-api": "/enterprise-server@latest/rest/guides/getting-started-with-the-checks-api",
"/enterprise/2.20/rest/guides/getting-started-with-the-checks-api": "/enterprise-server@2.20/rest/guides/getting-started-with-the-checks-api",
@@ -476,7 +421,6 @@
"/enterprise/2.20/rest/guides/getting-started-with-the-rest-api": "/enterprise-server@2.20/rest/guides/getting-started-with-the-rest-api",
"/enterprise-server@2.20/v3/guides/getting-started": "/enterprise-server@2.20/rest/guides/getting-started-with-the-rest-api",
"/enterprise/2.20/v3/guides/getting-started": "/enterprise-server@2.20/rest/guides/getting-started-with-the-rest-api",
"/github-ae@latest/v3/guides/getting-started": "/github-ae@latest/rest/guides/getting-started-with-the-rest-api",
"/free-pro-team@latest/rest/guides": "/rest/guides",
"/v3/guides": "/rest/guides",
"/free-pro-team@latest/v3/guides": "/rest/guides",
@@ -485,7 +429,6 @@
"/enterprise/2.20/rest/guides": "/enterprise-server@2.20/rest/guides",
"/enterprise-server@2.20/v3/guides": "/enterprise-server@2.20/rest/guides",
"/enterprise/2.20/v3/guides": "/enterprise-server@2.20/rest/guides",
"/github-ae@latest/v3/guides": "/github-ae@latest/rest/guides",
"/free-pro-team@latest/rest/guides/rendering-data-as-graphs": "/rest/guides/rendering-data-as-graphs",
"/v3/guides/rendering-data-as-graphs": "/rest/guides/rendering-data-as-graphs",
"/free-pro-team@latest/v3/guides/rendering-data-as-graphs": "/rest/guides/rendering-data-as-graphs",
@@ -494,7 +437,6 @@
"/enterprise/2.20/rest/guides/rendering-data-as-graphs": "/enterprise-server@2.20/rest/guides/rendering-data-as-graphs",
"/enterprise-server@2.20/v3/guides/rendering-data-as-graphs": "/enterprise-server@2.20/rest/guides/rendering-data-as-graphs",
"/enterprise/2.20/v3/guides/rendering-data-as-graphs": "/enterprise-server@2.20/rest/guides/rendering-data-as-graphs",
"/github-ae@latest/v3/guides/rendering-data-as-graphs": "/github-ae@latest/rest/guides/rendering-data-as-graphs",
"/free-pro-team@latest/rest/guides/traversing-with-pagination": "/rest/guides/traversing-with-pagination",
"/v3/guides/traversing-with-pagination": "/rest/guides/traversing-with-pagination",
"/free-pro-team@latest/v3/guides/traversing-with-pagination": "/rest/guides/traversing-with-pagination",
@@ -503,7 +445,6 @@
"/enterprise/2.20/rest/guides/traversing-with-pagination": "/enterprise-server@2.20/rest/guides/traversing-with-pagination",
"/enterprise-server@2.20/v3/guides/traversing-with-pagination": "/enterprise-server@2.20/rest/guides/traversing-with-pagination",
"/enterprise/2.20/v3/guides/traversing-with-pagination": "/enterprise-server@2.20/rest/guides/traversing-with-pagination",
"/github-ae@latest/v3/guides/traversing-with-pagination": "/github-ae@latest/rest/guides/traversing-with-pagination",
"/free-pro-team@latest/rest/guides/working-with-comments": "/rest/guides/working-with-comments",
"/v3/guides/working-with-comments": "/rest/guides/working-with-comments",
"/free-pro-team@latest/v3/guides/working-with-comments": "/rest/guides/working-with-comments",
@@ -512,7 +453,6 @@
"/enterprise/2.20/rest/guides/working-with-comments": "/enterprise-server@2.20/rest/guides/working-with-comments",
"/enterprise-server@2.20/v3/guides/working-with-comments": "/enterprise-server@2.20/rest/guides/working-with-comments",
"/enterprise/2.20/v3/guides/working-with-comments": "/enterprise-server@2.20/rest/guides/working-with-comments",
"/github-ae@latest/v3/guides/working-with-comments": "/github-ae@latest/rest/guides/working-with-comments",
"/free-pro-team@latest/rest": "/rest",
"/v3": "/rest",
"/free-pro-team@latest/v3": "/rest",
@@ -521,7 +461,6 @@
"/enterprise/2.20/rest": "/enterprise-server@2.20/rest",
"/enterprise-server@2.20/v3": "/enterprise-server@2.20/rest",
"/enterprise/2.20/v3": "/enterprise-server@2.20/rest",
"/github-ae@latest/v3": "/github-ae@latest/rest",
"/free-pro-team@latest/rest/overview/api-previews": "/rest/overview/api-previews",
"/v3/previews": "/rest/overview/api-previews",
"/free-pro-team@latest/v3/previews": "/rest/overview/api-previews",
@@ -530,7 +469,6 @@
"/enterprise/2.20/rest/overview/api-previews": "/enterprise-server@2.20/rest/overview/api-previews",
"/enterprise-server@2.20/v3/previews": "/enterprise-server@2.20/rest/overview/api-previews",
"/enterprise/2.20/v3/previews": "/enterprise-server@2.20/rest/overview/api-previews",
"/github-ae@latest/v3/previews": "/github-ae@latest/rest/overview/api-previews",
"/free-pro-team@latest/rest/overview/endpoints-available-for-github-apps": "/rest/overview/endpoints-available-for-github-apps",
"/v3/apps/available-endpoints": "/rest/overview/endpoints-available-for-github-apps",
"/free-pro-team@latest/v3/apps/available-endpoints": "/rest/overview/endpoints-available-for-github-apps",
@@ -544,8 +482,6 @@
"/enterprise/2.20/v3/apps/available-endpoints": "/enterprise-server@2.20/rest/overview/endpoints-available-for-github-apps",
"/enterprise-server@2.20/rest/reference/endpoints-available-for-github-apps": "/enterprise-server@2.20/rest/overview/endpoints-available-for-github-apps",
"/enterprise/2.20/rest/reference/endpoints-available-for-github-apps": "/enterprise-server@2.20/rest/overview/endpoints-available-for-github-apps",
"/github-ae@latest/v3/apps/available-endpoints": "/github-ae@latest/rest/overview/endpoints-available-for-github-apps",
"/github-ae@latest/rest/reference/endpoints-available-for-github-apps": "/github-ae@latest/rest/overview/endpoints-available-for-github-apps",
"/free-pro-team@latest/rest/overview": "/rest/overview",
"/enterprise/rest/overview": "/enterprise-server@latest/rest/overview",
"/enterprise/2.20/rest/overview": "/enterprise-server@2.20/rest/overview",
@@ -557,7 +493,6 @@
"/enterprise/2.20/rest/overview/libraries": "/enterprise-server@2.20/rest/overview/libraries",
"/enterprise-server@2.20/v3/libraries": "/enterprise-server@2.20/rest/overview/libraries",
"/enterprise/2.20/v3/libraries": "/enterprise-server@2.20/rest/overview/libraries",
"/github-ae@latest/v3/libraries": "/github-ae@latest/rest/overview/libraries",
"/free-pro-team@latest/rest/overview/media-types": "/rest/overview/media-types",
"/v3/media": "/rest/overview/media-types",
"/free-pro-team@latest/v3/media": "/rest/overview/media-types",
@@ -566,7 +501,6 @@
"/enterprise/2.20/rest/overview/media-types": "/enterprise-server@2.20/rest/overview/media-types",
"/enterprise-server@2.20/v3/media": "/enterprise-server@2.20/rest/overview/media-types",
"/enterprise/2.20/v3/media": "/enterprise-server@2.20/rest/overview/media-types",
"/github-ae@latest/v3/media": "/github-ae@latest/rest/overview/media-types",
"/free-pro-team@latest/rest/overview/openapi-description": "/rest/overview/openapi-description",
"/enterprise/rest/overview/openapi-description": "/enterprise-server@latest/rest/overview/openapi-description",
"/enterprise/2.20/rest/overview/openapi-description": "/enterprise-server@2.20/rest/overview/openapi-description",
@@ -578,7 +512,6 @@
"/enterprise/2.20/rest/overview/other-authentication-methods": "/enterprise-server@2.20/rest/overview/other-authentication-methods",
"/enterprise-server@2.20/v3/auth": "/enterprise-server@2.20/rest/overview/other-authentication-methods",
"/enterprise/2.20/v3/auth": "/enterprise-server@2.20/rest/overview/other-authentication-methods",
"/github-ae@latest/v3/auth": "/github-ae@latest/rest/overview/other-authentication-methods",
"/free-pro-team@latest/rest/overview/resources-in-the-rest-api": "/rest/overview/resources-in-the-rest-api",
"/rest/initialize-the-repo": "/rest/overview/resources-in-the-rest-api",
"/free-pro-team@latest/rest/initialize-the-repo": "/rest/overview/resources-in-the-rest-api",
@@ -587,7 +520,6 @@
"/enterprise/2.20/rest/overview/resources-in-the-rest-api": "/enterprise-server@2.20/rest/overview/resources-in-the-rest-api",
"/enterprise-server@2.20/rest/initialize-the-repo": "/enterprise-server@2.20/rest/overview/resources-in-the-rest-api",
"/enterprise/2.20/rest/initialize-the-repo": "/enterprise-server@2.20/rest/overview/resources-in-the-rest-api",
"/github-ae@latest/rest/initialize-the-repo": "/github-ae@latest/rest/overview/resources-in-the-rest-api",
"/free-pro-team@latest/rest/overview/troubleshooting": "/rest/overview/troubleshooting",
"/v3/troubleshooting": "/rest/overview/troubleshooting",
"/free-pro-team@latest/v3/troubleshooting": "/rest/overview/troubleshooting",
@@ -596,7 +528,6 @@
"/enterprise/2.20/rest/overview/troubleshooting": "/enterprise-server@2.20/rest/overview/troubleshooting",
"/enterprise-server@2.20/v3/troubleshooting": "/enterprise-server@2.20/rest/overview/troubleshooting",
"/enterprise/2.20/v3/troubleshooting": "/enterprise-server@2.20/rest/overview/troubleshooting",
"/github-ae@latest/v3/troubleshooting": "/github-ae@latest/rest/overview/troubleshooting",
"/v3/actions": "/rest/actions",
"/free-pro-team@latest/v3/actions": "/rest/actions",
"/enterprise/rest/reference/actions": "/enterprise-server@latest/rest/actions",
@@ -608,7 +539,6 @@
"/enterprise/2.20/rest/reference/activity": "/enterprise-server@2.20/rest/reference/activity",
"/enterprise-server@2.20/v3/activity": "/enterprise-server@2.20/rest/reference/activity",
"/enterprise/2.20/v3/activity": "/enterprise-server@2.20/rest/reference/activity",
"/github-ae@latest/v3/activity": "/github-ae@latest/rest/activity",
"/v3/apps": "/rest/apps",
"/free-pro-team@latest/v3/apps": "/rest/apps",
"/enterprise/rest/reference/apps": "/enterprise-server@latest/rest/apps",
@@ -616,7 +546,6 @@
"/enterprise/2.20/rest/reference/apps": "/enterprise-server@2.20/rest/reference/apps",
"/enterprise-server@2.20/v3/apps": "/enterprise-server@2.20/rest/reference/apps",
"/enterprise/2.20/v3/apps": "/enterprise-server@2.20/rest/reference/apps",
"/github-ae@latest/v3/apps": "/github-ae@latest/rest/apps",
"/v3/checks": "/rest/checks",
"/free-pro-team@latest/v3/checks": "/rest/checks",
"/enterprise/rest/reference/checks": "/enterprise-server@latest/rest/checks",
@@ -624,7 +553,6 @@
"/enterprise/2.20/rest/reference/checks": "/enterprise-server@2.20/rest/reference/checks",
"/enterprise-server@2.20/v3/checks": "/enterprise-server@2.20/rest/reference/checks",
"/enterprise/2.20/v3/checks": "/enterprise-server@2.20/rest/reference/checks",
"/github-ae@latest/v3/checks": "/github-ae@latest/rest/checks",
"/v3/code-scanning": "/rest/code-scanning",
"/free-pro-team@latest/v3/code-scanning": "/rest/code-scanning",
"/enterprise/rest/reference/code-scanning": "/enterprise-server@latest/rest/code-scanning",
@@ -641,8 +569,6 @@
"/enterprise/2.20/v3/codes_of_conduct": "/enterprise-server@2.20/rest/reference/codes-of-conduct",
"/enterprise-server@2.20/v3/codes-of-conduct": "/enterprise-server@2.20/rest/reference/codes-of-conduct",
"/enterprise/2.20/v3/codes-of-conduct": "/enterprise-server@2.20/rest/reference/codes-of-conduct",
"/github-ae@latest/v3/codes_of_conduct": "/github-ae@latest/rest/codes-of-conduct",
"/github-ae@latest/v3/codes-of-conduct": "/github-ae@latest/rest/codes-of-conduct",
"/v3/emojis": "/rest/emojis",
"/free-pro-team@latest/v3/emojis": "/rest/emojis",
"/v3/misc": "/rest/emojis",
@@ -655,8 +581,6 @@
"/enterprise/2.20/v3/emojis": "/enterprise-server@2.20/rest/reference/emojis",
"/enterprise-server@2.20/v3/misc": "/enterprise-server@2.20/rest/reference/emojis",
"/enterprise/2.20/v3/misc": "/enterprise-server@2.20/rest/reference/emojis",
"/github-ae@latest/v3/emojis": "/github-ae@latest/rest/emojis",
"/github-ae@latest/v3/misc": "/github-ae@latest/rest/emojis",
"/free-pro-team@latest/rest/reference/enterprise-admin": "/rest/enterprise-admin",
"/v3/enterprise-admin": "/rest/enterprise-admin",
"/free-pro-team@latest/v3/enterprise-admin": "/rest/enterprise-admin",
@@ -670,8 +594,6 @@
"/enterprise/2.20/v3/enterprise-admin": "/enterprise-server@2.20/rest/reference/enterprise-admin",
"/enterprise-server@2.20/v3/enterprise": "/enterprise-server@2.20/rest/reference/enterprise-admin",
"/enterprise/2.20/v3/enterprise": "/enterprise-server@2.20/rest/reference/enterprise-admin",
"/github-ae@latest/v3/enterprise-admin": "/github-ae@latest/rest/enterprise-admin",
"/github-ae@latest/v3/enterprise": "/github-ae@latest/rest/enterprise-admin",
"/v3/gists": "/rest/gists",
"/free-pro-team@latest/v3/gists": "/rest/gists",
"/enterprise/rest/reference/gists": "/enterprise-server@latest/rest/gists",
@@ -679,7 +601,6 @@
"/enterprise/2.20/rest/reference/gists": "/enterprise-server@2.20/rest/reference/gists",
"/enterprise-server@2.20/v3/gists": "/enterprise-server@2.20/rest/reference/gists",
"/enterprise/2.20/v3/gists": "/enterprise-server@2.20/rest/reference/gists",
"/github-ae@latest/v3/gists": "/github-ae@latest/rest/gists",
"/v3/git": "/rest/git",
"/free-pro-team@latest/v3/git": "/rest/git",
"/enterprise/rest/reference/git": "/enterprise-server@latest/rest/git",
@@ -687,7 +608,6 @@
"/enterprise/2.20/rest/reference/git": "/enterprise-server@2.20/rest/reference/git",
"/enterprise-server@2.20/v3/git": "/enterprise-server@2.20/rest/reference/git",
"/enterprise/2.20/v3/git": "/enterprise-server@2.20/rest/reference/git",
"/github-ae@latest/v3/git": "/github-ae@latest/rest/git",
"/v3/gitignore": "/rest/gitignore",
"/free-pro-team@latest/v3/gitignore": "/rest/gitignore",
"/enterprise/rest/reference/gitignore": "/enterprise-server@latest/rest/gitignore",
@@ -695,7 +615,6 @@
"/enterprise/2.20/rest/reference/gitignore": "/enterprise-server@2.20/rest/reference/gitignore",
"/enterprise-server@2.20/v3/gitignore": "/enterprise-server@2.20/rest/reference/gitignore",
"/enterprise/2.20/v3/gitignore": "/enterprise-server@2.20/rest/reference/gitignore",
"/github-ae@latest/v3/gitignore": "/github-ae@latest/rest/gitignore",
"/free-pro-team@latest/rest/reference": "/rest/reference",
"/enterprise/rest/reference": "/enterprise-server@latest/rest/reference",
"/enterprise/2.20/rest/reference": "/enterprise-server@2.20/rest/reference",
@@ -708,7 +627,6 @@
"/enterprise/2.20/rest/reference/issues": "/enterprise-server@2.20/rest/reference/issues",
"/enterprise-server@2.20/v3/issues": "/enterprise-server@2.20/rest/reference/issues",
"/enterprise/2.20/v3/issues": "/enterprise-server@2.20/rest/reference/issues",
"/github-ae@latest/v3/issues": "/github-ae@latest/rest/issues",
"/v3/licenses": "/rest/licenses",
"/free-pro-team@latest/v3/licenses": "/rest/licenses",
"/enterprise/rest/reference/licenses": "/enterprise-server@latest/rest/licenses",
@@ -716,7 +634,6 @@
"/enterprise/2.20/rest/reference/licenses": "/enterprise-server@2.20/rest/reference/licenses",
"/enterprise-server@2.20/v3/licenses": "/enterprise-server@2.20/rest/reference/licenses",
"/enterprise/2.20/v3/licenses": "/enterprise-server@2.20/rest/reference/licenses",
"/github-ae@latest/v3/licenses": "/github-ae@latest/rest/licenses",
"/v3/markdown": "/rest/markdown",
"/free-pro-team@latest/v3/markdown": "/rest/markdown",
"/enterprise/rest/reference/markdown": "/enterprise-server@latest/rest/markdown",
@@ -724,7 +641,6 @@
"/enterprise/2.20/rest/reference/markdown": "/enterprise-server@2.20/rest/reference/markdown",
"/enterprise-server@2.20/v3/markdown": "/enterprise-server@2.20/rest/reference/markdown",
"/enterprise/2.20/v3/markdown": "/enterprise-server@2.20/rest/reference/markdown",
"/github-ae@latest/v3/markdown": "/github-ae@latest/rest/markdown",
"/v3/meta": "/rest/meta",
"/free-pro-team@latest/v3/meta": "/rest/meta",
"/enterprise/rest/reference/meta": "/enterprise-server@latest/rest/meta",
@@ -732,7 +648,6 @@
"/enterprise/2.20/rest/reference/meta": "/enterprise-server@2.20/rest/reference/meta",
"/enterprise-server@2.20/v3/meta": "/enterprise-server@2.20/rest/reference/meta",
"/enterprise/2.20/v3/meta": "/enterprise-server@2.20/rest/reference/meta",
"/github-ae@latest/v3/meta": "/github-ae@latest/rest/meta",
"/v3/migrations": "/rest/migrations",
"/free-pro-team@latest/v3/migrations": "/rest/migrations",
"/v3/migration": "/rest/migrations",
@@ -754,7 +669,6 @@
"/enterprise/2.20/rest/reference/orgs": "/enterprise-server@2.20/rest/reference/orgs",
"/enterprise-server@2.20/v3/orgs": "/enterprise-server@2.20/rest/reference/orgs",
"/enterprise/2.20/v3/orgs": "/enterprise-server@2.20/rest/reference/orgs",
"/github-ae@latest/v3/orgs": "/github-ae@latest/rest/orgs",
"/free-pro-team@latest/rest/reference/permissions-required-for-github-apps": "/rest/overview/permissions-required-for-github-apps",
"/v3/apps/permissions": "/rest/overview/permissions-required-for-github-apps",
"/free-pro-team@latest/v3/apps/permissions": "/rest/overview/permissions-required-for-github-apps",
@@ -763,7 +677,6 @@
"/enterprise/2.20/rest/reference/permissions-required-for-github-apps": "/enterprise-server@2.20/rest/reference/permissions-required-for-github-apps",
"/enterprise-server@2.20/v3/apps/permissions": "/enterprise-server@2.20/rest/reference/permissions-required-for-github-apps",
"/enterprise/2.20/v3/apps/permissions": "/enterprise-server@2.20/rest/reference/permissions-required-for-github-apps",
"/github-ae@latest/v3/apps/permissions": "/github-ae@latest/rest/overview/permissions-required-for-github-apps",
"/v3/projects": "/rest/projects",
"/free-pro-team@latest/v3/projects": "/rest/projects",
"/enterprise/rest/reference/projects": "/enterprise-server@latest/rest/projects",
@@ -771,7 +684,6 @@
"/enterprise/2.20/rest/reference/projects": "/enterprise-server@2.20/rest/reference/projects",
"/enterprise-server@2.20/v3/projects": "/enterprise-server@2.20/rest/reference/projects",
"/enterprise/2.20/v3/projects": "/enterprise-server@2.20/rest/reference/projects",
"/github-ae@latest/v3/projects": "/github-ae@latest/rest/projects",
"/v3/pulls": "/rest/pulls",
"/free-pro-team@latest/v3/pulls": "/rest/pulls",
"/enterprise/rest/reference/pulls": "/enterprise-server@latest/rest/pulls",
@@ -779,7 +691,6 @@
"/enterprise/2.20/rest/reference/pulls": "/enterprise-server@2.20/rest/reference/pulls",
"/enterprise-server@2.20/v3/pulls": "/enterprise-server@2.20/rest/reference/pulls",
"/enterprise/2.20/v3/pulls": "/enterprise-server@2.20/rest/reference/pulls",
"/github-ae@latest/v3/pulls": "/github-ae@latest/rest/pulls",
"/v3/rate_limit": "/rest/rate-limit",
"/free-pro-team@latest/v3/rate_limit": "/rest/rate-limit",
"/v3/rate-limit": "/rest/rate-limit",
@@ -792,8 +703,6 @@
"/enterprise/2.20/v3/rate_limit": "/enterprise-server@2.20/rest/reference/rate-limit",
"/enterprise-server@2.20/v3/rate-limit": "/enterprise-server@2.20/rest/reference/rate-limit",
"/enterprise/2.20/v3/rate-limit": "/enterprise-server@2.20/rest/reference/rate-limit",
"/github-ae@latest/v3/rate_limit": "/github-ae@latest/rest/rate-limit",
"/github-ae@latest/v3/rate-limit": "/github-ae@latest/rest/rate-limit",
"/v3/reactions": "/rest/reactions",
"/free-pro-team@latest/v3/reactions": "/rest/reactions",
"/enterprise/rest/reference/reactions": "/enterprise-server@latest/rest/reactions",
@@ -801,7 +710,6 @@
"/enterprise/2.20/rest/reference/reactions": "/enterprise-server@2.20/rest/reference/reactions",
"/enterprise-server@2.20/v3/reactions": "/enterprise-server@2.20/rest/reference/reactions",
"/enterprise/2.20/v3/reactions": "/enterprise-server@2.20/rest/reference/reactions",
"/github-ae@latest/v3/reactions": "/github-ae@latest/rest/reactions",
"/v3/repos": "/rest/repos",
"/free-pro-team@latest/v3/repos": "/rest/repos",
"/enterprise/rest/reference/repos": "/enterprise-server@latest/rest/repos",
@@ -809,7 +717,6 @@
"/enterprise/2.20/rest/reference/repos": "/enterprise-server@2.20/rest/reference/repos",
"/enterprise-server@2.20/v3/repos": "/enterprise-server@2.20/rest/reference/repos",
"/enterprise/2.20/v3/repos": "/enterprise-server@2.20/rest/reference/repos",
"/github-ae@latest/v3/repos": "/github-ae@latest/rest/repos",
"/v3/scim": "/enterprise-cloud@latest/rest/scim",
"/free-pro-team@latest/v3/scim": "/enterprise-cloud@latest/rest/scim",
"/v3/search": "/rest/search",
@@ -819,7 +726,6 @@
"/enterprise/2.20/rest/reference/search": "/enterprise-server@2.20/rest/reference/search",
"/enterprise-server@2.20/v3/search": "/enterprise-server@2.20/rest/reference/search",
"/enterprise/2.20/v3/search": "/enterprise-server@2.20/rest/reference/search",
"/github-ae@latest/v3/search": "/github-ae@latest/rest/search",
"/v3/teams": "/rest/teams",
"/free-pro-team@latest/v3/teams": "/rest/teams",
"/enterprise/rest/reference/teams": "/enterprise-server@latest/rest/teams",
@@ -827,7 +733,6 @@
"/enterprise/2.20/rest/reference/teams": "/enterprise-server@2.20/rest/reference/teams",
"/enterprise-server@2.20/v3/teams": "/enterprise-server@2.20/rest/reference/teams",
"/enterprise/2.20/v3/teams": "/enterprise-server@2.20/rest/reference/teams",
"/github-ae@latest/v3/teams": "/github-ae@latest/rest/teams",
"/v3/users": "/rest/users",
"/free-pro-team@latest/v3/users": "/rest/users",
"/enterprise/rest/reference/users": "/enterprise-server@latest/rest/users",
@@ -835,7 +740,6 @@
"/enterprise/2.20/rest/reference/users": "/enterprise-server@2.20/rest/reference/users",
"/enterprise-server@2.20/v3/users": "/enterprise-server@2.20/rest/reference/users",
"/enterprise/2.20/v3/users": "/enterprise-server@2.20/rest/reference/users",
"/github-ae@latest/v3/users": "/github-ae@latest/rest/users",
"/enterprise/2.20/v3/activity/events": "/enterprise-server@2.20/rest/reference/activity#events",
"/enterprise/2.20/v3/activity/feeds": "/enterprise-server@2.20/rest/reference/activity#feeds",
"/enterprise/2.20/v3/activity/notifications": "/enterprise-server@2.20/rest/reference/activity#notifications",

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

@@ -84283,7 +84283,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the <code>repository_ids</code> when creating the token. When you omit <code>repository_ids</code>, the response does not contain the <code>repositories</code> key.</p>\n<p>You must use a <a href=\"https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.</p>\n<p>Optionally, you can use the <code>repositories</code> or <code>repository_ids</code> body parameters to specify individual repositories that the installation access token can access. If you don't use <code>repositories</code> or <code>repository_ids</code> to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.</p>\n<p>Optionally, use the <code>permissions</code> body parameter to specify the permissions that the installation access token should have. If <code>permissions</code> is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.</p>\n<p>When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.</p>\n<p>You must use a <a href=\"https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -199508,7 +199508,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/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.diff</code></strong>: Returns the diff of the commit.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\" Pagination query parameters are not supported for these media types.</p>\n<ul>\n<li><strong><code>application/vnd.github.diff</code></strong>: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -206232,14 +206232,14 @@
]
},
"copilot": {
"copilot-business": [
"copilot-user-management": [
{
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing",
"title": "Get Copilot Business seat information and settings for an organization",
"title": "Get Copilot seat information and settings for an organization",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -206366,7 +206366,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Gets information about an organization's Copilot Business subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"<a href=\"https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization\">Managing policies for Copilot Business in your organization</a>\".</p>\n<p>Only organization owners can configure and view details about the organization's Copilot Business subscription.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Gets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"<a href=\"https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization\">Managing policies for Copilot in your organization</a>\".</p>\n<p>Only organization owners can configure and view details about the organization's Copilot Business subscription.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -206394,9 +206394,9 @@
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing/seats",
"title": "List all Copilot Business seat assignments for an organization",
"title": "List all Copilot seat assignments for an organization",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -206531,7 +206531,7 @@
"properties": {
"total_seats": {
"type": "integer",
"description": "Total number of Copilot For Business seats for the organization currently being billed."
"description": "Total number of Copilot seats for the organization currently being billed."
},
"seats": {
"type": "array",
@@ -207360,7 +207360,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).</p>\n<p>Only organization owners can configure and view details about the organization's Copilot Business subscription.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).</p>\n<p>Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -207388,9 +207388,9 @@
"serverUrl": "https://api.github.com",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
"title": "Add teams to the Copilot Business subscription for an organization",
"title": "Add teams to the Copilot subscription for an organization",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -207412,6 +207412,16 @@
}
],
"enabledForGitHubApps": true,
"progAccess": {
"userToServerRest": true,
"serverToServer": true,
"fineGrainedPat": true,
"permissions": [
{
"organization_copilot_seat_management": "write"
}
]
},
"codeExamples": [
{
"key": "default",
@@ -207453,7 +207463,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Purchases a GitHub Copilot Business seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot Business pricing, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business\">Pricing for GitHub Copilot Business</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot Business subscription, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization\">Setting up a Copilot Business subscription for your organization</a>\".\nFor more information about setting a suggestion matching policy, see \"<a href=\"https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization\">Configuring suggestion matching policies for GitHub Copilot in your organization</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Purchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot\">Pricing for GitHub Copilot</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise\">Setting up a Copilot subscription for your organization</a>\".\nFor more information about setting a suggestion matching policy, see \"<a href=\"https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization\">Configuring suggestion matching policies for GitHub Copilot in your organization</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -207473,7 +207483,7 @@
},
{
"httpStatusCode": "422",
"description": "<p>Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.</p>"
"description": "<p>Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.</p>"
},
{
"httpStatusCode": "500",
@@ -207485,9 +207495,9 @@
"serverUrl": "https://api.github.com",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
"title": "Remove teams from the Copilot Business subscription for an organization",
"title": "Remove teams from the Copilot subscription for an organization",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -207560,7 +207570,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Cancels the Copilot Business seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.</p>\n<p>For more information about Copilot Business pricing, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business\">Pricing for GitHub Copilot Business</a>\".</p>\n<p>For more information about disabling access to Copilot Business, see \"<a href=\"https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization\">Revoking access to GitHub Copilot for specific users in your organization</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Cancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.</p>\n<p>For more information about Copilot pricing, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot\">Pricing for GitHub Copilot</a>\".</p>\n<p>For more information about disabling access to Copilot Business or Enterprise, see \"<a href=\"https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization\">Revoking access to GitHub Copilot for specific users in your organization</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -207580,7 +207590,7 @@
},
{
"httpStatusCode": "422",
"description": "<p>Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.</p>"
"description": "<p>Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.</p>"
},
{
"httpStatusCode": "500",
@@ -207592,9 +207602,9 @@
"serverUrl": "https://api.github.com",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
"title": "Add users to the Copilot Business subscription for an organization",
"title": "Add users to the Copilot subscription for an organization",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -207616,6 +207626,16 @@
}
],
"enabledForGitHubApps": true,
"progAccess": {
"userToServerRest": true,
"serverToServer": true,
"fineGrainedPat": true,
"permissions": [
{
"organization_copilot_seat_management": "write"
}
]
},
"codeExamples": [
{
"key": "default",
@@ -207657,7 +207677,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Purchases a GitHub Copilot Business seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot Business pricing, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business\">Pricing for GitHub Copilot Business</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot Business subscription, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization\">Setting up a Copilot Business subscription for your organization</a>\".\nFor more information about setting a suggestion matching policy, see \"<a href=\"https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization\">Configuring suggestion matching policies for GitHub Copilot in your organization</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Purchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot\">Pricing for GitHub Copilot</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise\">Setting up a Copilot subscription for your organization</a>\".\nFor more information about setting a suggestion matching policy, see \"<a href=\"https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization\">Configuring suggestion matching policies for GitHub Copilot in your organization</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -207677,7 +207697,7 @@
},
{
"httpStatusCode": "422",
"description": "<p>Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.</p>"
"description": "<p>Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.</p>"
},
{
"httpStatusCode": "500",
@@ -207689,9 +207709,9 @@
"serverUrl": "https://api.github.com",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
"title": "Remove users from the Copilot Business subscription for an organization",
"title": "Remove users from the Copilot subscription for an organization",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -207764,7 +207784,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Cancels the Copilot Business seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.</p>\n<p>For more information about Copilot Business pricing, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business\">Pricing for GitHub Copilot Business</a>\"</p>\n<p>For more information about disabling access to Copilot Business, see \"<a href=\"https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization\">Revoking access to GitHub Copilot for specific users in your organization</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Cancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.</p>\n<p>For more information about Copilot pricing, see \"<a href=\"https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot\">Pricing for GitHub Copilot</a>\".</p>\n<p>For more information about disabling access to Copilot Business or Enterprise, see \"<a href=\"https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization\">Revoking access to GitHub Copilot for specific users in your organization</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -207784,7 +207804,7 @@
},
{
"httpStatusCode": "422",
"description": "<p>Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team.</p>"
"description": "<p>Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team.</p>"
},
{
"httpStatusCode": "500",
@@ -207796,9 +207816,9 @@
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot",
"title": "Get Copilot Business seat assignment details for a user",
"title": "Get Copilot seat assignment details for a user",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -208710,7 +208730,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot.</p>\n<p>Organization owners can view GitHub Copilot seat assignment details for members in their organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.</p>\n<p>Organization owners can view GitHub Copilot seat assignment details for members in their organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -208730,7 +208750,7 @@
},
{
"httpStatusCode": "422",
"description": "<p>Copilot Business is not enabled for this organization or the user has a pending organization invitation.</p>"
"description": "<p>Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation.</p>"
},
{
"httpStatusCode": "500",

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

@@ -93949,7 +93949,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the <code>repository_ids</code> when creating the token. When you omit <code>repository_ids</code>, the response does not contain the <code>repositories</code> key.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.</p>\n<p>Optionally, you can use the <code>repositories</code> or <code>repository_ids</code> body parameters to specify individual repositories that the installation access token can access. If you don't use <code>repositories</code> or <code>repository_ids</code> to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.</p>\n<p>Optionally, use the <code>permissions</code> body parameter to specify the permissions that the installation access token should have. If <code>permissions</code> is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.</p>\n<p>When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -211091,7 +211091,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//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.diff</code></strong>: Returns the diff of the commit.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\" Pagination query parameters are not supported for these media types.</p>\n<ul>\n<li><strong><code>application/vnd.github.diff</code></strong>: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -217827,14 +217827,14 @@
]
},
"copilot": {
"copilot-business": [
"copilot-user-management": [
{
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing",
"title": "Get Copilot Business seat information and settings for an organization",
"title": "Get Copilot seat information and settings for an organization",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -217961,7 +217961,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Gets information about an organization's Copilot Business subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization\">Managing policies for Copilot Business in your organization</a>\".</p>\n<p>Only organization owners can configure and view details about the organization's Copilot Business subscription.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Gets information about an organization's Copilot subscription, including seat breakdown\nand code matching policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization\">Managing policies for Copilot in your organization</a>\".</p>\n<p>Only organization owners can configure and view details about the organization's Copilot Business subscription.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -217989,9 +217989,9 @@
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/orgs/{org}/copilot/billing/seats",
"title": "List all Copilot Business seat assignments for an organization",
"title": "List all Copilot seat assignments for an organization",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -218126,7 +218126,7 @@
"properties": {
"total_seats": {
"type": "integer",
"description": "Total number of Copilot For Business seats for the organization currently being billed."
"description": "Total number of Copilot seats for the organization currently being billed."
},
"seats": {
"type": "array",
@@ -218955,7 +218955,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).</p>\n<p>Only organization owners can configure and view details about the organization's Copilot Business subscription.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).</p>\n<p>Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -218983,9 +218983,9 @@
"serverUrl": "https://api.github.com",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
"title": "Add teams to the Copilot Business subscription for an organization",
"title": "Add teams to the Copilot subscription for an organization",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -219007,6 +219007,16 @@
}
],
"enabledForGitHubApps": true,
"progAccess": {
"userToServerRest": true,
"serverToServer": true,
"fineGrainedPat": true,
"permissions": [
{
"organization_copilot_seat_management": "write"
}
]
},
"codeExamples": [
{
"key": "default",
@@ -219048,7 +219058,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Purchases a GitHub Copilot Business seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot Business pricing, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business\">Pricing for GitHub Copilot Business</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot Business subscription, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization\">Setting up a Copilot Business subscription for your organization</a>\".\nFor more information about setting a suggestion matching policy, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization\">Configuring suggestion matching policies for GitHub Copilot in your organization</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Purchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot\">Pricing for GitHub Copilot</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise\">Setting up a Copilot subscription for your organization</a>\".\nFor more information about setting a suggestion matching policy, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization\">Configuring suggestion matching policies for GitHub Copilot in your organization</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -219068,7 +219078,7 @@
},
{
"httpStatusCode": "422",
"description": "<p>Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.</p>"
"description": "<p>Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.</p>"
},
{
"httpStatusCode": "500",
@@ -219080,9 +219090,9 @@
"serverUrl": "https://api.github.com",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
"title": "Remove teams from the Copilot Business subscription for an organization",
"title": "Remove teams from the Copilot subscription for an organization",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -219155,7 +219165,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Cancels the Copilot Business seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.</p>\n<p>For more information about Copilot Business pricing, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business\">Pricing for GitHub Copilot Business</a>\".</p>\n<p>For more information about disabling access to Copilot Business, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization\">Revoking access to GitHub Copilot for specific users in your organization</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Cancels the Copilot seat assignment for all members of each team specified.\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.</p>\n<p>For more information about Copilot pricing, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot\">Pricing for GitHub Copilot</a>\".</p>\n<p>For more information about disabling access to Copilot Business or Enterprise, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization\">Revoking access to GitHub Copilot for specific users in your organization</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -219175,7 +219185,7 @@
},
{
"httpStatusCode": "422",
"description": "<p>Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.</p>"
"description": "<p>Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.</p>"
},
{
"httpStatusCode": "500",
@@ -219187,9 +219197,9 @@
"serverUrl": "https://api.github.com",
"verb": "post",
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
"title": "Add users to the Copilot Business subscription for an organization",
"title": "Add users to the Copilot subscription for an organization",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -219211,6 +219221,16 @@
}
],
"enabledForGitHubApps": true,
"progAccess": {
"userToServerRest": true,
"serverToServer": true,
"fineGrainedPat": true,
"permissions": [
{
"organization_copilot_seat_management": "write"
}
]
},
"codeExamples": [
{
"key": "default",
@@ -219252,7 +219272,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Purchases a GitHub Copilot Business seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot Business pricing, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business\">Pricing for GitHub Copilot Business</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot Business subscription, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization\">Setting up a Copilot Business subscription for your organization</a>\".\nFor more information about setting a suggestion matching policy, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization\">Configuring suggestion matching policies for GitHub Copilot in your organization</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Purchases a GitHub Copilot seat for each user specified.\nThe organization will be billed accordingly. For more information about Copilot pricing, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot\">Pricing for GitHub Copilot</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise\">Setting up a Copilot subscription for your organization</a>\".\nFor more information about setting a suggestion matching policy, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization\">Configuring suggestion matching policies for GitHub Copilot in your organization</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -219272,7 +219292,7 @@
},
{
"httpStatusCode": "422",
"description": "<p>Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.</p>"
"description": "<p>Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured.</p>"
},
{
"httpStatusCode": "500",
@@ -219284,9 +219304,9 @@
"serverUrl": "https://api.github.com",
"verb": "delete",
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
"title": "Remove users from the Copilot Business subscription for an organization",
"title": "Remove users from the Copilot subscription for an organization",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -219359,7 +219379,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Cancels the Copilot Business seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.</p>\n<p>For more information about Copilot Business pricing, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business\">Pricing for GitHub Copilot Business</a>\"</p>\n<p>For more information about disabling access to Copilot Business, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization\">Revoking access to GitHub Copilot for specific users in your organization</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Cancels the Copilot seat assignment for each user specified.\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.</p>\n<p>For more information about Copilot pricing, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot\">Pricing for GitHub Copilot</a>\".</p>\n<p>For more information about disabling access to Copilot Business or Enterprise, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization\">Revoking access to GitHub Copilot for specific users in your organization</a>\".</p>\n<p>Only organization owners can configure GitHub Copilot in their organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -219379,7 +219399,7 @@
},
{
"httpStatusCode": "422",
"description": "<p>Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team.</p>"
"description": "<p>Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team.</p>"
},
{
"httpStatusCode": "500",
@@ -219391,9 +219411,9 @@
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/orgs/{org}/members/{username}/copilot",
"title": "Get Copilot Business seat assignment details for a user",
"title": "Get Copilot seat assignment details for a user",
"category": "copilot",
"subcategory": "copilot-business",
"subcategory": "copilot-user-management",
"parameters": [
{
"name": "org",
@@ -220305,7 +220325,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot.</p>\n<p>Organization owners can view GitHub Copilot seat assignment details for members in their organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"descriptionHTML": "<p><strong>Note</strong>: This endpoint is in beta and is subject to change.</p>\n<p>Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.</p>\n<p>Organization owners can view GitHub Copilot seat assignment details for members in their organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_billing:copilot</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -220325,7 +220345,7 @@
},
{
"httpStatusCode": "422",
"description": "<p>Copilot Business is not enabled for this organization or the user has a pending organization invitation.</p>"
"description": "<p>Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation.</p>"
},
{
"httpStatusCode": "500",

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

@@ -93003,7 +93003,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the <code>repository_ids</code> when creating the token. When you omit <code>repository_ids</code>, the response does not contain the <code>repositories</code> key.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.</p>\n<p>Optionally, you can use the <code>repositories</code> or <code>repository_ids</code> body parameters to specify individual repositories that the installation access token can access. If you don't use <code>repositories</code> or <code>repository_ids</code> to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.</p>\n<p>Optionally, use the <code>permissions</code> body parameter to specify the permissions that the installation access token should have. If <code>permissions</code> is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.</p>\n<p>When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -163619,7 +163619,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/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.diff</code></strong>: Returns the diff of the commit.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\" Pagination query parameters are not supported for these media types.</p>\n<ul>\n<li><strong><code>application/vnd.github.diff</code></strong>: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",

4
src/rest/data/ghes-3.11-2022-11-28/schema.json
View File

@@ -93027,7 +93027,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the <code>repository_ids</code> when creating the token. When you omit <code>repository_ids</code>, the response does not contain the <code>repositories</code> key.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.</p>\n<p>Optionally, you can use the <code>repositories</code> or <code>repository_ids</code> body parameters to specify individual repositories that the installation access token can access. If you don't use <code>repositories</code> or <code>repository_ids</code> to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.</p>\n<p>Optionally, use the <code>permissions</code> body parameter to specify the permissions that the installation access token should have. If <code>permissions</code> is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.</p>\n<p>When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -163655,7 +163655,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.11/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.diff</code></strong>: Returns the diff of the commit.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\" Pagination query parameters are not supported for these media types.</p>\n<ul>\n<li><strong><code>application/vnd.github.diff</code></strong>: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",

4
src/rest/data/ghes-3.12-2022-11-28/schema.json
View File

@@ -93185,7 +93185,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the <code>repository_ids</code> when creating the token. When you omit <code>repository_ids</code>, the response does not contain the <code>repositories</code> key.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.12/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.</p>\n<p>Optionally, you can use the <code>repositories</code> or <code>repository_ids</code> body parameters to specify individual repositories that the installation access token can access. If you don't use <code>repositories</code> or <code>repository_ids</code> to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.</p>\n<p>Optionally, use the <code>permissions</code> body parameter to specify the permissions that the installation access token should have. If <code>permissions</code> is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.</p>\n<p>When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.12/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -163976,7 +163976,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.12/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.diff</code></strong>: Returns the diff of the commit.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.12/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\" Pagination query parameters are not supported for these media types.</p>\n<ul>\n<li><strong><code>application/vnd.github.diff</code></strong>: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -90900,7 +90900,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the <code>repository_ids</code> when creating the token. When you omit <code>repository_ids</code>, the response does not contain the <code>repositories</code> key.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.</p>\n<p>Optionally, you can use the <code>repositories</code> or <code>repository_ids</code> body parameters to specify individual repositories that the installation access token can access. If you don't use <code>repositories</code> or <code>repository_ids</code> to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.</p>\n<p>Optionally, use the <code>permissions</code> body parameter to specify the permissions that the installation access token should have. If <code>permissions</code> is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.</p>\n<p>When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.8/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -160466,7 +160466,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/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.diff</code></strong>: Returns the diff of the commit.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\" Pagination query parameters are not supported for these media types.</p>\n<ul>\n<li><strong><code>application/vnd.github.diff</code></strong>: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -91985,7 +91985,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the <code>repository_ids</code> when creating the token. When you omit <code>repository_ids</code>, the response does not contain the <code>repositories</code> key.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"descriptionHTML": "<p>Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of <code>401 - Unauthorized</code>, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.</p>\n<p>Optionally, you can use the <code>repositories</code> or <code>repository_ids</code> body parameters to specify individual repositories that the installation access token can access. If you don't use <code>repositories</code> or <code>repository_ids</code> to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.</p>\n<p>Optionally, use the <code>permissions</code> body parameter to specify the permissions that the installation access token should have. If <code>permissions</code> is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.</p>\n<p>When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -162261,7 +162261,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/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.diff</code></strong>: Returns the diff of the commit.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"descriptionHTML": "<p>Returns the contents of a single commit reference. You must have <code>read</code> access for the repository to use this endpoint.</p>\n<p><strong>Note:</strong> If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\" Pagination query parameters are not supported for these media types.</p>\n<ul>\n<li><strong><code>application/vnd.github.diff</code></strong>: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.patch</code></strong>: Returns the patch of the commit. Diffs with binary data will have no <code>patch</code> property. Larger diffs may time out and return a 5xx status code.</li>\n<li><strong><code>application/vnd.github.sha</code></strong>: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.</li>\n</ul>\n<p><strong>Signature verification object</strong></p>\n<p>The response will include a <code>verification</code> object that describes the result of verifying the commit's signature. The following fields are included in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Name</th><th scope=\"col\">Type</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>verified</code></td><td><code>boolean</code></td><td>Indicates whether GitHub considers the signature in this commit to be verified.</td></tr><tr><td><code>reason</code></td><td><code>string</code></td><td>The reason for verified value. Possible values and their meanings are enumerated in table below.</td></tr><tr><td><code>signature</code></td><td><code>string</code></td><td>The signature that was extracted from the commit.</td></tr><tr><td><code>payload</code></td><td><code>string</code></td><td>The value that was signed.</td></tr></tbody></table>\n<p>These are the possible values for <code>reason</code> in the <code>verification</code> object:</p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<table><thead><tr><th scope=\"col\">Value</th><th scope=\"col\">Description</th></tr></thead><tbody><tr><td><code>expired_key</code></td><td>The key that made the signature is expired.</td></tr><tr><td><code>not_signing_key</code></td><td>The \"signing\" flag is not among the usage flags in the GPG key that made the signature.</td></tr><tr><td><code>gpgverify_error</code></td><td>There was an error communicating with the signature verification service.</td></tr><tr><td><code>gpgverify_unavailable</code></td><td>The signature verification service is currently unavailable.</td></tr><tr><td><code>unsigned</code></td><td>The object does not include a signature.</td></tr><tr><td><code>unknown_signature_type</code></td><td>A non-PGP signature was found in the commit.</td></tr><tr><td><code>no_user</code></td><td>No user was associated with the <code>committer</code> email address in the commit.</td></tr><tr><td><code>unverified_email</code></td><td>The <code>committer</code> email address in the commit was associated with a user, but the email address is not verified on their account.</td></tr><tr><td><code>bad_email</code></td><td>The <code>committer</code> email address in the commit is not included in the identities of the PGP key that made the signature.</td></tr><tr><td><code>unknown_key</code></td><td>The key that made the signature has not been registered with any user's account.</td></tr><tr><td><code>malformed_signature</code></td><td>There was an error parsing the signature.</td></tr><tr><td><code>invalid</code></td><td>The signature could not be cryptographically verified using the key whose key-id was found in the signature.</td></tr><tr><td><code>valid</code></td><td>None of the above errors applied, so the signature is considered to be verified.</td></tr></tbody></table>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -44,5 +44,5 @@
]
}
},
"sha": "e3b351abbafd1e19e95319d396f0513038f332b1"
"sha": "9c5dc4417755fe3dc6184095970a8314151aa8ca"
}

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

@@ -215572,362 +215572,6 @@
"category": "team"
}
},
"user": {
"created": {
"descriptionHtml": "<p>A user account was added to the enterprise.</p>",
"summaryHtml": "<p>This event occurs when there is activity relating to user accounts in an enterprise.</p>",
"bodyParameters": [
{
"type": "string",
"name": "action",
"in": "body",
"description": "",
"isRequired": true,
"enum": [
"created"
],
"childParamsGroups": []
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "installation",
"in": "body",
"description": "<p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\">Using webhooks with GitHub Apps</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
"in": "body",
"description": "<p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "repository",
"in": "body",
"description": "<p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property\nwhen the event occurs from activity in a repository.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",
"in": "body",
"description": "<p>The GitHub user that triggered the event. This property is included in every webhook payload.</p>",
"childParamsGroups": []
},
{
"type": "object or null",
"name": "user",
"in": "body",
"description": "",
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url",
"description": ""
},
{
"type": "boolean",
"name": "deleted",
"description": ""
},
{
"type": "string or null",
"name": "email",
"description": ""
},
{
"type": "string",
"name": "events_url",
"description": ""
},
{
"type": "string",
"name": "followers_url",
"description": ""
},
{
"type": "string",
"name": "following_url",
"description": ""
},
{
"type": "string",
"name": "gists_url",
"description": ""
},
{
"type": "string",
"name": "gravatar_id",
"description": ""
},
{
"type": "string",
"name": "html_url",
"description": ""
},
{
"type": "integer",
"name": "id",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "login",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": ""
},
{
"type": "string",
"name": "node_id",
"description": ""
},
{
"type": "string",
"name": "organizations_url",
"description": ""
},
{
"type": "string",
"name": "received_events_url",
"description": ""
},
{
"type": "string",
"name": "repos_url",
"description": ""
},
{
"type": "boolean",
"name": "site_admin",
"description": ""
},
{
"type": "string",
"name": "starred_url",
"description": ""
},
{
"type": "string",
"name": "subscriptions_url",
"description": ""
},
{
"type": "string",
"name": "type",
"description": "",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url",
"description": ""
}
]
}
],
"availability": [
"business"
],
"action": "created",
"category": "user"
},
"deleted": {
"descriptionHtml": "<p>A user account was removed from the enterprise.</p>",
"summaryHtml": "<p>This event occurs when there is activity relating to user accounts in an enterprise.</p>",
"bodyParameters": [
{
"type": "string",
"name": "action",
"in": "body",
"description": "",
"isRequired": true,
"enum": [
"deleted"
],
"childParamsGroups": []
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "<p>An enterprise on GitHub. Webhook payloads contain the <code>enterprise</code> property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts\">About enterprise accounts</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "installation",
"in": "body",
"description": "<p>The GitHub App installation. Webhook payloads contain the <code>installation</code> property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"<a href=\"https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps\">Using webhooks with GitHub Apps</a>.\"</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "organization",
"in": "body",
"description": "<p>A GitHub organization. Webhook payloads contain the <code>organization</code> property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "repository",
"in": "body",
"description": "<p>The repository on GitHub where the event occurred. Webhook payloads contain the <code>repository</code> property\nwhen the event occurs from activity in a repository.</p>",
"childParamsGroups": []
},
{
"type": "object",
"name": "sender",
"in": "body",
"description": "<p>The GitHub user that triggered the event. This property is included in every webhook payload.</p>",
"childParamsGroups": []
},
{
"type": "object or null",
"name": "user",
"in": "body",
"description": "",
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url",
"description": ""
},
{
"type": "boolean",
"name": "deleted",
"description": ""
},
{
"type": "string or null",
"name": "email",
"description": ""
},
{
"type": "string",
"name": "events_url",
"description": ""
},
{
"type": "string",
"name": "followers_url",
"description": ""
},
{
"type": "string",
"name": "following_url",
"description": ""
},
{
"type": "string",
"name": "gists_url",
"description": ""
},
{
"type": "string",
"name": "gravatar_id",
"description": ""
},
{
"type": "string",
"name": "html_url",
"description": ""
},
{
"type": "integer",
"name": "id",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "login",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": ""
},
{
"type": "string",
"name": "node_id",
"description": ""
},
{
"type": "string",
"name": "organizations_url",
"description": ""
},
{
"type": "string",
"name": "received_events_url",
"description": ""
},
{
"type": "string",
"name": "repos_url",
"description": ""
},
{
"type": "boolean",
"name": "site_admin",
"description": ""
},
{
"type": "string",
"name": "starred_url",
"description": ""
},
{
"type": "string",
"name": "subscriptions_url",
"description": ""
},
{
"type": "string",
"name": "type",
"description": "",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url",
"description": ""
}
]
}
],
"availability": [
"business"
],
"action": "deleted",
"category": "user"
}
},
"watch": {
"started": {
"descriptionHtml": "<p>Someone started watching the repository.</p>",

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

@@ -1,3 +1,3 @@
{
"sha": "e3b351abbafd1e19e95319d396f0513038f332b1"
"sha": "9c5dc4417755fe3dc6184095970a8314151aa8ca"
}

3
src/workflows/unallowed-contribution-filters.yml
View File

@@ -14,3 +14,6 @@ notAllowed:
- 'content/actions/deployment/security-hardening-your-deployments/**'
contentTypes:
- 'content/**'
# allows getting a list of just added files from the dorny/paths-filter action
added:
- added: 'content/**'

27
src/workflows/unallowed-contributions.js
View File

@@ -3,6 +3,7 @@
import coreLib from '@actions/core'
import { readFileSync } from 'fs'
import yaml from 'js-yaml'
import { difference } from 'lodash-es'
import { checkContentType } from '#src/workflows/fm-utils.js'
import github from '#src/workflows/github.js'
@@ -10,8 +11,13 @@ import github from '#src/workflows/github.js'
const core = coreLib
const octokit = github()
const { PR_NUMBER, REPO_OWNER_AND_NAME, FILE_PATHS_NOT_ALLOWED, FILE_PATHS_CONTENT_TYPES } =
process.env
const {
PR_NUMBER,
REPO_OWNER_AND_NAME,
FILE_PATHS_NOT_ALLOWED,
CHANGED_FILE_PATHS,
ADDED_CONTENT_FILES,
} = process.env
const [owner, repo] = REPO_OWNER_AND_NAME.split('/')
const filters = yaml.load(readFileSync('src/workflows/unallowed-contribution-filters.yml', 'utf8'))
@@ -20,13 +26,20 @@ main()
async function main() {
// Files in the diff that match specific paths we don't allow
const unallowedChangedFiles = [...JSON.parse(FILE_PATHS_NOT_ALLOWED)]
// Any changes to a file in the content directory could potentially
// have `type: rai` so each changed content file's frontmatter needs
// to be checked.
unallowedChangedFiles.push(
...(await checkContentType(JSON.parse(FILE_PATHS_CONTENT_TYPES), 'rai')),
// Content files that are added in a forked repo won't be in the
// `github/docs` repo, so we don't need to check them. They will be
// reviewed manually by a content writer.
const contentFilesToCheck = difference(
JSON.parse(CHANGED_FILE_PATHS),
JSON.parse(ADDED_CONTENT_FILES),
)
// Any modifications or deletions to a file in the content directory
// could potentially have `type: rai` so each changed content file's
// frontmatter needs to be checked.
unallowedChangedFiles.push(...(await checkContentType(contentFilesToCheck, 'rai')))
if (unallowedChangedFiles.length === 0) return
// Format into Markdown bulleted list to use in the PR comment