jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-24 15:01:44 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #26913 from github/repo-sync

Browse Source 
Repo sync
This commit is contained in:
docs-bot
2023-07-19 13:00:52 -07:00
committed by GitHub
parent d6b3362e70 b8c4b21e45
commit 576fd0a3da
26 changed files with 572 additions and 294 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -363,7 +363,7 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing",
"requestPath": "/orgs/{org}/copilot/billing",
"additional-permissions": [],
"access": "write"
},
@@ -372,7 +372,7 @@
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing/seats",
"requestPath": "/orgs/{org}/copilot/billing/seats",
"additional-permissions": [],
"access": "write"
},
@@ -2182,6 +2182,15 @@
"additional-permissions": [],
"access": "write"
},
{
"category": "repos",
"slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
"additional-permissions": [],
"access": "write"
},
{
"category": "repos",
"slug": "enable-automated-security-fixes",

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

@@ -1754,13 +1754,13 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing"
"requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing/seats"
"requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "add-teams-to-the-copilot-for-business-subscription-for-an-organization",
@@ -3770,6 +3770,12 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}"
},
{
"slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes"
},
{
"slug": "enable-automated-security-fixes",
"subcategory": "repos",

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

@@ -437,7 +437,7 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing",
"requestPath": "/orgs/{org}/copilot/billing",
"access": "write",
"user-to-server": true,
"server-to-server": true,
@@ -448,7 +448,7 @@
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing/seats",
"requestPath": "/orgs/{org}/copilot/billing/seats",
"access": "write",
"user-to-server": true,
"server-to-server": true,
@@ -2730,6 +2730,17 @@
"server-to-server": true,
"additional-permissions": []
},
{
"category": "repos",
"slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": []
},
{
"category": "repos",
"slug": "enable-automated-security-fixes",

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

@@ -1538,13 +1538,13 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing"
"requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing/seats"
"requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "add-teams-to-the-copilot-for-business-subscription-for-an-organization",
@@ -3406,6 +3406,12 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}"
},
{
"slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes"
},
{
"slug": "enable-automated-security-fixes",
"subcategory": "repos",

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

@@ -1772,13 +1772,13 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing"
"requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing/seats"
"requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "add-teams-to-the-copilot-for-business-subscription-for-an-organization",
@@ -3836,6 +3836,12 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}"
},
{
"slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes"
},
{
"slug": "enable-automated-security-fixes",
"subcategory": "repos",

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

@@ -660,7 +660,7 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing",
"requestPath": "/orgs/{org}/copilot/billing",
"additional-permissions": [],
"access": "write"
},
@@ -669,7 +669,7 @@
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing/seats",
"requestPath": "/orgs/{org}/copilot/billing/seats",
"additional-permissions": [],
"access": "write"
},
@@ -2741,6 +2741,15 @@
"additional-permissions": [],
"access": "write"
},
{
"category": "repos",
"slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
"additional-permissions": [],
"access": "write"
},
{
"category": "repos",
"slug": "enable-automated-security-fixes",

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

@@ -1870,13 +1870,13 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing"
"requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing/seats"
"requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "add-teams-to-the-copilot-for-business-subscription-for-an-organization",
@@ -4020,6 +4020,12 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}"
},
{
"slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes"
},
{
"slug": "enable-automated-security-fixes",
"subcategory": "repos",

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

@@ -809,7 +809,7 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing",
"requestPath": "/orgs/{org}/copilot/billing",
"access": "write",
"user-to-server": true,
"server-to-server": true,
@@ -820,7 +820,7 @@
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing/seats",
"requestPath": "/orgs/{org}/copilot/billing/seats",
"access": "write",
"user-to-server": true,
"server-to-server": true,
@@ -3420,6 +3420,17 @@
"server-to-server": true,
"additional-permissions": []
},
{
"category": "repos",
"slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
"access": "write",
"user-to-server": true,
"server-to-server": true,
"additional-permissions": []
},
{
"category": "repos",
"slug": "enable-automated-security-fixes",

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

@@ -1654,13 +1654,13 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing"
"requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing/seats"
"requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "add-teams-to-the-copilot-for-business-subscription-for-an-organization",
@@ -3656,6 +3656,12 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}"
},
{
"slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes"
},
{
"slug": "enable-automated-security-fixes",
"subcategory": "repos",

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

@@ -1888,13 +1888,13 @@
"slug": "get-copilot-for-business-seat-information-and-settings-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing"
"requestPath": "/orgs/{org}/copilot/billing"
},
{
"slug": "list-all-copilot-for-business-seat-assignments-for-an-organization",
"subcategory": "copilot-for-business",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing/seats"
"requestPath": "/orgs/{org}/copilot/billing/seats"
},
{
"slug": "add-teams-to-the-copilot-for-business-subscription-for-an-organization",
@@ -4086,6 +4086,12 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/autolinks/{autolink_id}"
},
{
"slug": "check-if-automated-security-fixes-are-enabled-for-a-repository",
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes"
},
{
"slug": "enable-automated-security-fixes",
"subcategory": "repos",

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

@@ -60,5 +60,5 @@
"2022-11-28"
]
},
"sha": "19833171fa53a9a674f247f795f0cf44a65a05e4"
"sha": "1231d73f01884025424e5f512153b5183e4a847e"
}

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

@@ -5252,7 +5252,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/actions/secrets#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -5276,7 +5276,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
}
],
"enabledForGitHubApps": true,
@@ -6408,7 +6408,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"isRequired": true
}
],
@@ -6437,7 +6437,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -6502,7 +6502,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -6571,7 +6571,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -7093,7 +7093,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/actions/secrets#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -7613,7 +7613,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/reference/actions#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/rest/actions/secrets#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"isRequired": true
},
{
@@ -73932,7 +73932,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -73966,7 +73966,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -74980,7 +74980,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -75033,7 +75033,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -75129,7 +75129,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/rest/reference/activity#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/rest/activity/watching#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -75159,7 +75159,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -75267,7 +75267,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/rest/reference/activity#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -75297,7 +75297,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -75324,7 +75324,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/rest/reference/activity#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/rest/activity/notifications#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -76492,7 +76492,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/rest/reference/activity#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -84578,7 +84578,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/rest/reference/activity#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/rest/activity/watching#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -84633,7 +84633,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/rest/reference/activity#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/rest/activity/watching#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -213729,7 +213729,7 @@
{
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing",
"requestPath": "/orgs/{org}/copilot/billing",
"title": "Get Copilot for Business seat information and settings for an organization",
"category": "copilot",
"subcategory": "copilot-for-business",
@@ -213866,7 +213866,7 @@
{
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing/seats",
"requestPath": "/orgs/{org}/copilot/billing/seats",
"title": "List all Copilot for Business seat assignments for an organization",
"category": "copilot",
"subcategory": "copilot-for-business",
@@ -252275,7 +252275,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/rest/reference/git#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/rest/reference/git#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/rest/git/refs#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/rest/git/refs#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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": "201",
@@ -252735,7 +252735,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/rest/reference/git#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/rest/reference/git#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/rest/git/commits#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/rest/git/refs#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -351268,7 +351268,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/rest/reference/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -354415,7 +354415,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/rest/reference/orgs#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -366022,7 +366022,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/orgs#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -366273,7 +366273,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/orgs#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -366445,7 +366445,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -366582,7 +366582,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -458725,6 +458725,95 @@
}
]
},
{
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
"title": "Check if automated security fixes are enabled for a repository",
"category": "repos",
"subcategory": "repos",
"parameters": [
{
"name": "owner",
"description": "<p>The account owner of the repository. The name is not case sensitive.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"description": "<p>The name of the repository without the <code>.git</code> extension. The name is not case sensitive.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"bodyParameters": [],
"enabledForGitHubApps": true,
"codeExamples": [
{
"key": "default",
"request": {
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"parameters": {
"owner": "OWNER",
"repo": "REPO"
}
},
"response": {
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response if dependabot is enabled</p>",
"example": {
"enabled": true,
"paused": false
},
"schema": {
"title": "Check Automated Security Fixes",
"description": "Check Automated Security Fixes",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether automated security fixes are enabled for the repository.",
"examples": [
true
]
},
"paused": {
"type": "boolean",
"description": "Whether automated security fixes are paused for the repository.",
"examples": [
false
]
}
},
"required": [
"enabled",
"paused"
]
}
}
}
],
"previews": [],
"descriptionHTML": "<p>Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"<a href=\"https://docs.github.com/articles/configuring-automated-security-fixes\">Configuring automated security fixes</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>Response if dependabot is enabled</p>"
},
{
"httpStatusCode": "404",
"description": "<p>Not Found if dependabot is not enabled for the repository</p>"
}
]
},
{
"serverUrl": "https://api.github.com",
"verb": "put",
@@ -461122,7 +461211,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/articles/about-repository-transfers/\">about repository transfers</a>.</p>",
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/articles/about-repository-transfers/\">about repository transfers</a>.\nYou must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -471242,7 +471331,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/rest/reference/git#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -507767,6 +507856,18 @@
"closed",
"draft"
]
},
{
"type": "array of strings or null",
"name": "collaborating_users",
"in": "body",
"description": "<p>A list of usernames who have been granted write access to the advisory.</p>"
},
{
"type": "array of strings or null",
"name": "collaborating_teams",
"in": "body",
"description": "<p>A list of team slugs which have been granted write access to the advisory.</p>"
}
],
"enabledForGitHubApps": true,

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

@@ -4463,7 +4463,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/github-ae@latest/rest/actions/secrets#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -4487,7 +4487,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/github-ae@latest/rest/actions/secrets#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/github-ae@latest/rest/actions/secrets#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/github-ae@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
}
],
"enabledForGitHubApps": true,
@@ -5619,7 +5619,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/github-ae@latest/rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/github-ae@latest/rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/github-ae@latest/rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"isRequired": true
}
],
@@ -5648,7 +5648,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/github-ae@latest/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -5713,7 +5713,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/github-ae@latest/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -5782,7 +5782,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/github-ae@latest/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -6304,7 +6304,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/github-ae@latest/rest/actions/secrets#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -46421,7 +46421,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -46455,7 +46455,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -47469,7 +47469,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -47522,7 +47522,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -47618,7 +47618,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/github-ae@latest/rest/reference/activity#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/github-ae@latest/rest/activity/watching#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -47648,7 +47648,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -47756,7 +47756,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/activity#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/github-ae@latest/rest/activity/notifications#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -47786,7 +47786,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -47813,7 +47813,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/activity#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/github-ae@latest/rest/activity/notifications#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -48981,7 +48981,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/activity#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/github-ae@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -56727,7 +56727,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/github-ae@latest/rest/reference/activity#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/github-ae@latest/rest/activity/watching#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -56782,7 +56782,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/github-ae@latest/rest/reference/activity#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/github-ae@latest/rest/activity/watching#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -151929,7 +151929,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deleting a user will delete all their repositories, gists, applications, and personal settings. <a href=\"https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#suspend-a-user\">Suspending a user</a> is often a better option.</p>\n<p>You can delete any user account except your own.</p>",
"descriptionHTML": "<p>Deleting a user will delete all their repositories, gists, applications, and personal settings. <a href=\"https://docs.github.com/github-ae@latest/rest/enterprise-admin/users#suspend-a-user\">Suspending a user</a> is often a better option.</p>\n<p>You can delete any user account except your own.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -169587,7 +169587,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/github-ae@latest/rest/reference/git#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/github-ae@latest/rest/reference/git#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/github-ae@latest/rest/git/refs#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/github-ae@latest/rest/git/refs#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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": "201",
@@ -170047,7 +170047,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/git#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/git#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/github-ae@latest/rest/git/commits#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/git/refs#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -261493,7 +261493,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/github-ae@latest/articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/github-ae@latest/articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/github-ae@latest/rest/orgs/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -262776,7 +262776,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/github-ae@latest/rest/reference/orgs#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/github-ae@latest/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -265299,7 +265299,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/orgs#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -265550,7 +265550,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/orgs#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -265722,7 +265722,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -265859,7 +265859,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -343595,7 +343595,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/github-ae@latest/articles/about-repository-transfers/\">about repository transfers</a>.</p>",
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/github-ae@latest/articles/about-repository-transfers/\">about repository transfers</a>.\nYou must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -352335,7 +352335,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/github-ae@latest/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/git#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. </p>\n</li>\n<li>\n<p>This API supports files up to 1 megabyte in size.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/github-ae@latest/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/github-ae@latest/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. </p>\n</li>\n<li>\n<p>This API supports files up to 1 megabyte in size.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -6192,7 +6192,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -6216,7 +6216,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/actions#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/actions#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
}
],
"enabledForGitHubApps": true,
@@ -7348,7 +7348,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"isRequired": true
}
],
@@ -7377,7 +7377,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -7442,7 +7442,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -7511,7 +7511,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -8033,7 +8033,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -8553,7 +8553,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/actions#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"isRequired": true
},
{
@@ -83546,7 +83546,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -83580,7 +83580,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -84594,7 +84594,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -84647,7 +84647,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -84743,7 +84743,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -84773,7 +84773,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -84881,7 +84881,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -84911,7 +84911,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -84938,7 +84938,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -86106,7 +86106,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -94192,7 +94192,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -94247,7 +94247,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/activity#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -225428,7 +225428,7 @@
{
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing",
"requestPath": "/orgs/{org}/copilot/billing",
"title": "Get Copilot for Business seat information and settings for an organization",
"category": "copilot",
"subcategory": "copilot-for-business",
@@ -225565,7 +225565,7 @@
{
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/organizations/{org}/copilot/billing/seats",
"requestPath": "/orgs/{org}/copilot/billing/seats",
"title": "List all Copilot for Business seat assignments for an organization",
"category": "copilot",
"subcategory": "copilot-for-business",
@@ -265830,7 +265830,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/git#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/git#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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": "201",
@@ -266290,7 +266290,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/git#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/git#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -365407,7 +365407,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/enterprise-cloud@latest//articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/enterprise-cloud@latest//articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -371455,7 +371455,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/orgs#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -383062,7 +383062,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/orgs#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -383313,7 +383313,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/orgs#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -383485,7 +383485,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -383622,7 +383622,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -475772,6 +475772,95 @@
}
]
},
{
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/automated-security-fixes",
"title": "Check if automated security fixes are enabled for a repository",
"category": "repos",
"subcategory": "repos",
"parameters": [
{
"name": "owner",
"description": "<p>The account owner of the repository. The name is not case sensitive.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"description": "<p>The name of the repository without the <code>.git</code> extension. The name is not case sensitive.</p>",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"bodyParameters": [],
"enabledForGitHubApps": true,
"codeExamples": [
{
"key": "default",
"request": {
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"parameters": {
"owner": "OWNER",
"repo": "REPO"
}
},
"response": {
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response if dependabot is enabled</p>",
"example": {
"enabled": true,
"paused": false
},
"schema": {
"title": "Check Automated Security Fixes",
"description": "Check Automated Security Fixes",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether automated security fixes are enabled for the repository.",
"examples": [
true
]
},
"paused": {
"type": "boolean",
"description": "Whether automated security fixes are paused for the repository.",
"examples": [
false
]
}
},
"required": [
"enabled",
"paused"
]
}
}
}
],
"previews": [],
"descriptionHTML": "<p>Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes\">Configuring automated security fixes</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>Response if dependabot is enabled</p>"
},
{
"httpStatusCode": "404",
"description": "<p>Not Found if dependabot is not enabled for the repository</p>"
}
]
},
{
"serverUrl": "https://api.github.com",
"verb": "put",
@@ -478169,7 +478258,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/enterprise-cloud@latest//articles/about-repository-transfers/\">about repository transfers</a>.</p>",
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/enterprise-cloud@latest//articles/about-repository-transfers/\">about repository transfers</a>.\nYou must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -488289,7 +488378,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/git#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -505390,7 +505479,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/scim#update-an-attribute-for-a-scim-user\">Update an attribute for a SCIM user</a> endpoint instead.</p>\n<p>You must at least provide the required values for the user: <code>userName</code>, <code>name</code>, and <code>emails</code>.</p>\n<p><strong>Warning:</strong> Setting <code>active: false</code> removes the user from the organization, deletes the external identity, and deletes the associated <code>{scim_user_id}</code>.</p>",
"descriptionHTML": "<p>Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user\">Update an attribute for a SCIM user</a> endpoint instead.</p>\n<p>You must at least provide the required values for the user: <code>userName</code>, <code>name</code>, and <code>emails</code>.</p>\n<p><strong>Warning:</strong> Setting <code>active: false</code> removes the user from the organization, deletes the external identity, and deletes the associated <code>{scim_user_id}</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -527300,6 +527389,18 @@
"closed",
"draft"
]
},
{
"type": "array of strings or null",
"name": "collaborating_users",
"in": "body",
"description": "<p>A list of usernames who have been granted write access to the advisory.</p>"
},
{
"type": "array of strings or null",
"name": "collaborating_teams",
"in": "body",
"description": "<p>A list of team slugs which have been granted write access to the advisory.</p>"
}
],
"enabledForGitHubApps": true,

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

@@ -5614,7 +5614,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/actions/secrets#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -5638,7 +5638,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/actions#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/actions#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/actions/secrets#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/enterprise-server@3.6/rest/actions/secrets#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/enterprise-server@3.6/rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
}
],
"enabledForGitHubApps": true,
@@ -6709,7 +6709,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/enterprise-server@3.6/rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"isRequired": true
}
],
@@ -6738,7 +6738,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.6/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -6803,7 +6803,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.6/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -6872,7 +6872,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.6/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -7263,7 +7263,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/actions/secrets#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -7783,7 +7783,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/actions#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/actions/secrets#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"isRequired": true
},
{
@@ -77905,7 +77905,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/activity/notifications#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -77939,7 +77939,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -78892,7 +78892,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -78945,7 +78945,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -79041,7 +79041,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/activity#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/enterprise-server@3.6/rest/activity/watching#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -79071,7 +79071,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -79179,7 +79179,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/activity#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/activity/notifications#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -79209,7 +79209,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -79236,7 +79236,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/activity#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/activity/notifications#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -80343,7 +80343,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -88397,7 +88397,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/activity#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-server@3.6/rest/activity/watching#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -88452,7 +88452,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/activity#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/enterprise-server@3.6/rest/activity/watching#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -188482,7 +188482,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the settings for your instance. To change settings, see the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#set-settings\">Set settings endpoint</a>.</p>\n<p><strong>Note:</strong> You cannot retrieve the management console password with the Enterprise administration API.</p>",
"descriptionHTML": "<p>Gets the settings for your instance. To change settings, see the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/management-console#set-settings\">Set settings endpoint</a>.</p>\n<p><strong>Note:</strong> You cannot retrieve the management console password with the Enterprise administration API.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -188507,7 +188507,7 @@
"type": "string",
"name": "settings",
"in": "body",
"description": "<p>A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#get-settings\">Get settings endpoint</a>.</p>",
"description": "<p>A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/management-console#get-settings\">Get settings endpoint</a>.</p>",
"isRequired": true
}
],
@@ -188530,7 +188530,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Applies settings on your instance. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#get-settings\">Get settings endpoint</a>.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>The request body for this operation must be submitted as <code>application/x-www-form-urlencoded</code> data. You can submit a parameter value as a string, or you can use a tool such as <code>curl</code> to submit a parameter value as the contents of a text file. For more information, see the <a href=\"https://curl.se/docs/manpage.html#--data-urlencode\"><code>curl</code> documentation</a>.</li>\n<li>You cannot set the management console password with the Enterprise administration API. Use the <code>ghe-set-password</code> utility to change the management console password. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password\">Command-line utilities</a>.\"</li>\n</ul>",
"descriptionHTML": "<p>Applies settings on your instance. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/management-console#get-settings\">Get settings endpoint</a>.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>The request body for this operation must be submitted as <code>application/x-www-form-urlencoded</code> data. You can submit a parameter value as a string, or you can use a tool such as <code>curl</code> to submit a parameter value as the contents of a text file. For more information, see the <a href=\"https://curl.se/docs/manpage.html#--data-urlencode\"><code>curl</code> documentation</a>.</li>\n<li>You cannot set the management console password with the Enterprise administration API. Use the <code>ghe-set-password</code> utility to change the management console password. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password\">Command-line utilities</a>.\"</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -188787,7 +188787,7 @@
"type": "string",
"name": "settings",
"in": "body",
"description": "<p>An optional JSON string containing the installation settings. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#get-settings\">Get settings endpoint</a>.</p>"
"description": "<p>An optional JSON string containing the installation settings. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/management-console#get-settings\">Get settings endpoint</a>.</p>"
}
],
"enabledForGitHubApps": false,
@@ -188810,7 +188810,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.</p>\n<p>Note that you need to <code>POST</code> to <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#start-a-configuration-process\"><code>/setup/api/configure</code></a> to start the actual configuration process.</p>\n<p>When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:</p>\n<ol>\n<li>If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.</li>\n<li>If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.</li>\n</ol>\n<p><strong>Note:</strong> The request body for this operation must be submitted as <code>multipart/form-data</code> data. You can can reference the license file by prefixing the filename with the <code>@</code> symbol using <code>curl</code>. For more information, see the <a href=\"https://curl.se/docs/manpage.html#-F\"><code>curl</code> documentation</a>.</p>",
"descriptionHTML": "<p>When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.</p>\n<p>Note that you need to <code>POST</code> to <a href=\"https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/management-console#start-a-configuration-process\"><code>/setup/api/configure</code></a> to start the actual configuration process.</p>\n<p>When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:</p>\n<ol>\n<li>If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.</li>\n<li>If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.</li>\n</ol>\n<p><strong>Note:</strong> The request body for this operation must be submitted as <code>multipart/form-data</code> data. You can can reference the license file by prefixing the filename with the <code>@</code> symbol using <code>curl</code>. For more information, see the <a href=\"https://curl.se/docs/manpage.html#-F\"><code>curl</code> documentation</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -197062,7 +197062,7 @@
"url": "https://enterprise.octocat.com/api/v3/authorizations/2",
"app": {
"name": "My personal access token",
"url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens",
"url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens",
"client_id": "00000000000000000000"
},
"token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a",
@@ -198141,7 +198141,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user\">update the LDAP mapping</a> for the user.</p>\n<p>The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send <code>\"octo_cat\"</code> as the login, a user named <code>\"octo-cat\"</code> will be created.</p>\n<p>If the login name or email address is already associated with an account, the server will return a <code>422</code> response.</p>",
"descriptionHTML": "<p>If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also <a href=\"https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user\">update the LDAP mapping</a> for the user.</p>\n<p>The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send <code>\"octo_cat\"</code> as the login, a user named <code>\"octo-cat\"</code> will be created.</p>\n<p>If the login name or email address is already associated with an account, the server will return a <code>422</code> response.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -198259,7 +198259,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deleting a user will delete all their repositories, gists, applications, and personal settings. <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#suspend-a-user\">Suspending a user</a> is often a better option.</p>\n<p>You can delete any user account except your own.</p>",
"descriptionHTML": "<p>Deleting a user will delete all their repositories, gists, applications, and personal settings. <a href=\"https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/users#suspend-a-user\">Suspending a user</a> is often a better option.</p>\n<p>You can delete any user account except your own.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -216007,7 +216007,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/git#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/git#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/enterprise-server@3.6/rest/git/refs#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/enterprise-server@3.6/rest/git/refs#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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": "201",
@@ -216467,7 +216467,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/git#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/git#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/git/commits#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/git/refs#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -306018,7 +306018,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.6/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -306465,7 +306465,7 @@
"url": "https://enterprise.octocat.com/api/v3/authorizations/2",
"app": {
"name": "My personal access token",
"url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens",
"url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens",
"client_id": "00000000000000000000"
},
"token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a",
@@ -316405,7 +316405,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/enterprise-server@3.6/articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/enterprise-server@3.6/articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/orgs/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -317783,7 +317783,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.6/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -320729,7 +320729,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/orgs#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -320980,7 +320980,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/orgs#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -321152,7 +321152,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -321289,7 +321289,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -401400,7 +401400,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/enterprise-server@3.6/articles/about-repository-transfers/\">about repository transfers</a>.</p>",
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/enterprise-server@3.6/articles/about-repository-transfers/\">about repository transfers</a>.\nYou must use a personal access token or an OAuth token for this endpoint. An installation access token cannot be used because it is only granted access to a single account.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -411186,7 +411186,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/git#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.6/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.6/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -432741,7 +432741,7 @@
"type": "string",
"name": "ldap_dn",
"in": "body",
"description": "<p>The <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team\">Update LDAP mapping for a team</a>\" endpoint to change the LDAP DN. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync\">Using LDAP</a>.\"</p>"
"description": "<p>The <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team\">Update LDAP mapping for a team</a>\" endpoint to change the LDAP DN. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync\">Using LDAP</a>.\"</p>"
}
],
"enabledForGitHubApps": true,

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

@@ -6380,7 +6380,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/actions/secrets#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -6404,7 +6404,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/actions#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/actions#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/actions/secrets#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/enterprise-server@3.7/rest/actions/secrets#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/enterprise-server@3.7/rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
}
],
"enabledForGitHubApps": true,
@@ -7478,7 +7478,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/enterprise-server@3.7/rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"isRequired": true
}
],
@@ -7507,7 +7507,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.7/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -7572,7 +7572,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.7/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -7641,7 +7641,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.7/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -8032,7 +8032,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/actions/secrets#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -8552,7 +8552,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/actions#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/actions/secrets#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"isRequired": true
},
{
@@ -78808,7 +78808,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/activity#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/activity/notifications#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -78842,7 +78842,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -79798,7 +79798,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -79851,7 +79851,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -79947,7 +79947,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/activity#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/enterprise-server@3.7/rest/activity/watching#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -79977,7 +79977,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -80085,7 +80085,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/activity#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/activity/notifications#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -80115,7 +80115,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -80142,7 +80142,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/activity#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/activity/notifications#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -81252,7 +81252,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/activity#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -89338,7 +89338,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/activity#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-server@3.7/rest/activity/watching#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -89393,7 +89393,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/activity#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/enterprise-server@3.7/rest/activity/watching#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -191291,7 +191291,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the settings for your instance. To change settings, see the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/enterprise-admin#set-settings\">Set settings endpoint</a>.</p>\n<p><strong>Note:</strong> You cannot retrieve the management console password with the Enterprise administration API.</p>",
"descriptionHTML": "<p>Gets the settings for your instance. To change settings, see the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/management-console#set-settings\">Set settings endpoint</a>.</p>\n<p><strong>Note:</strong> You cannot retrieve the management console password with the Enterprise administration API.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -191316,7 +191316,7 @@
"type": "string",
"name": "settings",
"in": "body",
"description": "<p>A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/enterprise-admin#get-settings\">Get settings endpoint</a>.</p>",
"description": "<p>A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/management-console#get-settings\">Get settings endpoint</a>.</p>",
"isRequired": true
}
],
@@ -191339,7 +191339,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Applies settings on your instance. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/enterprise-admin#get-settings\">Get settings endpoint</a>.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>The request body for this operation must be submitted as <code>application/x-www-form-urlencoded</code> data. You can submit a parameter value as a string, or you can use a tool such as <code>curl</code> to submit a parameter value as the contents of a text file. For more information, see the <a href=\"https://curl.se/docs/manpage.html#--data-urlencode\"><code>curl</code> documentation</a>.</li>\n<li>You cannot set the management console password with the Enterprise administration API. Use the <code>ghe-set-password</code> utility to change the management console password. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password\">Command-line utilities</a>.\"</li>\n</ul>",
"descriptionHTML": "<p>Applies settings on your instance. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/management-console#get-settings\">Get settings endpoint</a>.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>The request body for this operation must be submitted as <code>application/x-www-form-urlencoded</code> data. You can submit a parameter value as a string, or you can use a tool such as <code>curl</code> to submit a parameter value as the contents of a text file. For more information, see the <a href=\"https://curl.se/docs/manpage.html#--data-urlencode\"><code>curl</code> documentation</a>.</li>\n<li>You cannot set the management console password with the Enterprise administration API. Use the <code>ghe-set-password</code> utility to change the management console password. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password\">Command-line utilities</a>.\"</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -191596,7 +191596,7 @@
"type": "string",
"name": "settings",
"in": "body",
"description": "<p>An optional JSON string containing the installation settings. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/enterprise-admin#get-settings\">Get settings endpoint</a>.</p>"
"description": "<p>An optional JSON string containing the installation settings. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/management-console#get-settings\">Get settings endpoint</a>.</p>"
}
],
"enabledForGitHubApps": false,
@@ -191619,7 +191619,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.</p>\n<p>Note that you need to <code>POST</code> to <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/enterprise-admin#start-a-configuration-process\"><code>/setup/api/configure</code></a> to start the actual configuration process.</p>\n<p>When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:</p>\n<ol>\n<li>If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.</li>\n<li>If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.</li>\n</ol>\n<p><strong>Note:</strong> The request body for this operation must be submitted as <code>multipart/form-data</code> data. You can can reference the license file by prefixing the filename with the <code>@</code> symbol using <code>curl</code>. For more information, see the <a href=\"https://curl.se/docs/manpage.html#-F\"><code>curl</code> documentation</a>.</p>",
"descriptionHTML": "<p>When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.</p>\n<p>Note that you need to <code>POST</code> to <a href=\"https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/management-console#start-a-configuration-process\"><code>/setup/api/configure</code></a> to start the actual configuration process.</p>\n<p>When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:</p>\n<ol>\n<li>If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.</li>\n<li>If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.</li>\n</ol>\n<p><strong>Note:</strong> The request body for this operation must be submitted as <code>multipart/form-data</code> data. You can can reference the license file by prefixing the filename with the <code>@</code> symbol using <code>curl</code>. For more information, see the <a href=\"https://curl.se/docs/manpage.html#-F\"><code>curl</code> documentation</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -199884,7 +199884,7 @@
"url": "https://enterprise.octocat.com/api/v3/authorizations/2",
"app": {
"name": "My personal access token",
"url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens",
"url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens",
"client_id": "00000000000000000000"
},
"token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a",
@@ -200970,7 +200970,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user\">update the LDAP mapping</a> for the user.</p>\n<p>The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send <code>\"octo_cat\"</code> as the login, a user named <code>\"octo-cat\"</code> will be created.</p>\n<p>If the login name or email address is already associated with an account, the server will return a <code>422</code> response.</p>",
"descriptionHTML": "<p>If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also <a href=\"https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user\">update the LDAP mapping</a> for the user.</p>\n<p>The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send <code>\"octo_cat\"</code> as the login, a user named <code>\"octo-cat\"</code> will be created.</p>\n<p>If the login name or email address is already associated with an account, the server will return a <code>422</code> response.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -201088,7 +201088,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deleting a user will delete all their repositories, gists, applications, and personal settings. <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/enterprise-admin#suspend-a-user\">Suspending a user</a> is often a better option.</p>\n<p>You can delete any user account except your own.</p>",
"descriptionHTML": "<p>Deleting a user will delete all their repositories, gists, applications, and personal settings. <a href=\"https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/users#suspend-a-user\">Suspending a user</a> is often a better option.</p>\n<p>You can delete any user account except your own.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -218836,7 +218836,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/git#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/git#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/refs#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/refs#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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": "201",
@@ -219296,7 +219296,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/git#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/git#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/commits#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/refs#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -308989,7 +308989,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -309436,7 +309436,7 @@
"url": "https://enterprise.octocat.com/api/v3/authorizations/2",
"app": {
"name": "My personal access token",
"url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens",
"url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens",
"client_id": "00000000000000000000"
},
"token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a",
@@ -319589,7 +319589,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/enterprise-server@3.7/articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/enterprise-server@3.7/articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/orgs/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -320967,7 +320967,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/orgs#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.7/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -324198,7 +324198,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/orgs#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -324449,7 +324449,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/orgs#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -324621,7 +324621,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -324758,7 +324758,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -405143,7 +405143,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/enterprise-server@3.7/articles/about-repository-transfers/\">about repository transfers</a>.</p>",
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/enterprise-server@3.7/articles/about-repository-transfers/\">about repository transfers</a>.\nYou must use a personal access token or an OAuth token for this endpoint. An installation access token cannot be used because it is only granted access to a single account.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -414986,7 +414986,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/git#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.7/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.7/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -436639,7 +436639,7 @@
"type": "string",
"name": "ldap_dn",
"in": "body",
"description": "<p>The <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team\">Update LDAP mapping for a team</a>\" endpoint to change the LDAP DN. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync\">Using LDAP</a>.\"</p>"
"description": "<p>The <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.7/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team\">Update LDAP mapping for a team</a>\" endpoint to change the LDAP DN. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.7/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync\">Using LDAP</a>.\"</p>"
}
],
"enabledForGitHubApps": true,

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

@@ -6401,7 +6401,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -6425,7 +6425,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/actions#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/actions#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
}
],
"enabledForGitHubApps": true,
@@ -7499,7 +7499,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"isRequired": true
}
],
@@ -7528,7 +7528,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -7593,7 +7593,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -7662,7 +7662,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -8053,7 +8053,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -8573,7 +8573,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/actions#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/actions/secrets#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"isRequired": true
},
{
@@ -81580,7 +81580,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/activity#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/activity/notifications#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -81614,7 +81614,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -82570,7 +82570,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -82623,7 +82623,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -82719,7 +82719,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/activity#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/enterprise-server@3.8/rest/activity/watching#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -82749,7 +82749,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -82857,7 +82857,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/activity#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/activity/notifications#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -82887,7 +82887,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -82914,7 +82914,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/activity#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/activity/notifications#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -84024,7 +84024,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/activity#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -92110,7 +92110,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/activity#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-server@3.8/rest/activity/watching#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -92165,7 +92165,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/activity#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/enterprise-server@3.8/rest/activity/watching#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -201304,7 +201304,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the settings for your instance. To change settings, see the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/enterprise-admin#set-settings\">Set settings endpoint</a>.</p>\n<p><strong>Note:</strong> You cannot retrieve the management console password with the Enterprise administration API.</p>",
"descriptionHTML": "<p>Gets the settings for your instance. To change settings, see the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/management-console#set-settings\">Set settings endpoint</a>.</p>\n<p><strong>Note:</strong> You cannot retrieve the management console password with the Enterprise administration API.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -201329,7 +201329,7 @@
"type": "string",
"name": "settings",
"in": "body",
"description": "<p>A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/enterprise-admin#get-settings\">Get settings endpoint</a>.</p>",
"description": "<p>A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/management-console#get-settings\">Get settings endpoint</a>.</p>",
"isRequired": true
}
],
@@ -201352,7 +201352,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Applies settings on your instance. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/enterprise-admin#get-settings\">Get settings endpoint</a>.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>The request body for this operation must be submitted as <code>application/x-www-form-urlencoded</code> data. You can submit a parameter value as a string, or you can use a tool such as <code>curl</code> to submit a parameter value as the contents of a text file. For more information, see the <a href=\"https://curl.se/docs/manpage.html#--data-urlencode\"><code>curl</code> documentation</a>.</li>\n<li>You cannot set the management console password with the Enterprise administration API. Use the <code>ghe-set-password</code> utility to change the management console password. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password\">Command-line utilities</a>.\"</li>\n</ul>",
"descriptionHTML": "<p>Applies settings on your instance. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/management-console#get-settings\">Get settings endpoint</a>.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>The request body for this operation must be submitted as <code>application/x-www-form-urlencoded</code> data. You can submit a parameter value as a string, or you can use a tool such as <code>curl</code> to submit a parameter value as the contents of a text file. For more information, see the <a href=\"https://curl.se/docs/manpage.html#--data-urlencode\"><code>curl</code> documentation</a>.</li>\n<li>You cannot set the management console password with the Enterprise administration API. Use the <code>ghe-set-password</code> utility to change the management console password. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password\">Command-line utilities</a>.\"</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -201609,7 +201609,7 @@
"type": "string",
"name": "settings",
"in": "body",
"description": "<p>An optional JSON string containing the installation settings. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/enterprise-admin#get-settings\">Get settings endpoint</a>.</p>"
"description": "<p>An optional JSON string containing the installation settings. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/management-console#get-settings\">Get settings endpoint</a>.</p>"
}
],
"enabledForGitHubApps": false,
@@ -201632,7 +201632,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.</p>\n<p>Note that you need to <code>POST</code> to <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/enterprise-admin#start-a-configuration-process\"><code>/setup/api/configure</code></a> to start the actual configuration process.</p>\n<p>When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:</p>\n<ol>\n<li>If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.</li>\n<li>If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.</li>\n</ol>\n<p><strong>Note:</strong> The request body for this operation must be submitted as <code>multipart/form-data</code> data. You can can reference the license file by prefixing the filename with the <code>@</code> symbol using <code>curl</code>. For more information, see the <a href=\"https://curl.se/docs/manpage.html#-F\"><code>curl</code> documentation</a>.</p>",
"descriptionHTML": "<p>When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.</p>\n<p>Note that you need to <code>POST</code> to <a href=\"https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/management-console#start-a-configuration-process\"><code>/setup/api/configure</code></a> to start the actual configuration process.</p>\n<p>When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:</p>\n<ol>\n<li>If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.</li>\n<li>If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.</li>\n</ol>\n<p><strong>Note:</strong> The request body for this operation must be submitted as <code>multipart/form-data</code> data. You can can reference the license file by prefixing the filename with the <code>@</code> symbol using <code>curl</code>. For more information, see the <a href=\"https://curl.se/docs/manpage.html#-F\"><code>curl</code> documentation</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -209897,7 +209897,7 @@
"url": "https://enterprise.octocat.com/api/v3/authorizations/2",
"app": {
"name": "My personal access token",
"url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens",
"url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens",
"client_id": "00000000000000000000"
},
"token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a",
@@ -210991,7 +210991,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user\">update the LDAP mapping</a> for the user.</p>\n<p>The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send <code>\"octo_cat\"</code> as the login, a user named <code>\"octo-cat\"</code> will be created.</p>\n<p>If the login name or email address is already associated with an account, the server will return a <code>422</code> response.</p>",
"descriptionHTML": "<p>If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also <a href=\"https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user\">update the LDAP mapping</a> for the user.</p>\n<p>The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send <code>\"octo_cat\"</code> as the login, a user named <code>\"octo-cat\"</code> will be created.</p>\n<p>If the login name or email address is already associated with an account, the server will return a <code>422</code> response.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -211109,7 +211109,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deleting a user will delete all their repositories, gists, applications, and personal settings. <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/enterprise-admin#suspend-a-user\">Suspending a user</a> is often a better option.</p>\n<p>You can delete any user account except your own.</p>",
"descriptionHTML": "<p>Deleting a user will delete all their repositories, gists, applications, and personal settings. <a href=\"https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/users#suspend-a-user\">Suspending a user</a> is often a better option.</p>\n<p>You can delete any user account except your own.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -228873,7 +228873,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/git#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/git#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/refs#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/refs#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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": "201",
@@ -229333,7 +229333,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/git#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/git#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/commits#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/refs#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -319026,7 +319026,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -319473,7 +319473,7 @@
"url": "https://enterprise.octocat.com/api/v3/authorizations/2",
"app": {
"name": "My personal access token",
"url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens",
"url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens",
"client_id": "00000000000000000000"
},
"token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a",
@@ -329748,7 +329748,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/enterprise-server@3.8/articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/enterprise-server@3.8/articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/orgs/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -331126,7 +331126,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/orgs#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.8/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -334357,7 +334357,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/orgs#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -334608,7 +334608,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/orgs#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -334780,7 +334780,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -334917,7 +334917,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -415332,7 +415332,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/enterprise-server@3.8/articles/about-repository-transfers/\">about repository transfers</a>.</p>",
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/enterprise-server@3.8/articles/about-repository-transfers/\">about repository transfers</a>.\nYou must use a personal access token or an OAuth token for this endpoint. An installation access token cannot be used because it is only granted access to a single account.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -425175,7 +425175,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/git#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.8/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.8/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -446932,7 +446932,7 @@
"type": "string",
"name": "ldap_dn",
"in": "body",
"description": "<p>The <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team\">Update LDAP mapping for a team</a>\" endpoint to change the LDAP DN. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync\">Using LDAP</a>.\"</p>"
"description": "<p>The <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.8/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team\">Update LDAP mapping for a team</a>\" endpoint to change the LDAP DN. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.8/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync\">Using LDAP</a>.\"</p>"
}
],
"enabledForGitHubApps": true,

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

@@ -6401,7 +6401,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/actions#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-organization-public-key\">Get an organization public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -6425,7 +6425,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/actions#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/actions#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can manage the list of selected repositories using the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-selected-repositories-for-an-organization-secret\">List selected repositories for an organization secret</a>, <a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#set-selected-repositories-for-an-organization-secret\">Set selected repositories for an organization secret</a>, and <a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>"
}
],
"enabledForGitHubApps": true,
@@ -7543,7 +7543,7 @@
"type": "array of integers",
"name": "selected_repository_ids",
"in": "body",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/actions#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"description": "<p>An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the <code>visibility</code> is set to <code>selected</code>. You can add and remove individual repositories using the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#add-selected-repository-to-an-organization-secret\">Add selected repository to an organization secret</a> and <a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#remove-selected-repository-from-an-organization-secret\">Remove selected repository from an organization secret</a> endpoints.</p>",
"isRequired": true
}
],
@@ -7572,7 +7572,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -7637,7 +7637,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Adds a repository to an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -7706,7 +7706,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/actions#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"descriptionHTML": "<p>Removes a repository from an organization secret when the <code>visibility</code> for repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret\">Create or update an organization secret</a>. You must authenticate using an access token with the <code>admin:org</code> scope to use this endpoint. GitHub Apps must have the <code>secrets</code> organization permission to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -8228,7 +8228,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/actions#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-a-repository-public-key\">Get a repository public key</a> endpoint.</p>"
},
{
"type": "string",
@@ -8748,7 +8748,7 @@
"type": "string",
"name": "encrypted_value",
"in": "body",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/actions#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"description": "<p>Value for your secret, encrypted with <a href=\"https://libsodium.gitbook.io/doc/bindings_for_other_languages\">LibSodium</a> using the public key retrieved from the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-public-key\">Get an environment public key</a> endpoint.</p>",
"isRequired": true
},
{
@@ -82414,7 +82414,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/activity#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user\">List notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -82448,7 +82448,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -83448,7 +83448,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -83501,7 +83501,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -83597,7 +83597,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/activity#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"descriptionHTML": "<p>This checks to see if the current user is subscribed to a thread. You can also <a href=\"https://docs.github.com/enterprise-server@3.9/rest/activity/watching#get-a-repository-subscription\">get a repository subscription</a>.</p>\n<p>Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were <strong>@mentioned</strong>, or manually subscribe to a thread.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -83627,7 +83627,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -83735,7 +83735,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/activity#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"descriptionHTML": "<p>If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an <strong>@mention</strong>.</p>\n<p>You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.</p>\n<p>Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#delete-a-thread-subscription\">Delete a thread subscription</a> endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -83765,7 +83765,7 @@
"parameters": [
{
"name": "thread_id",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/activity#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"description": "<p>The unique identifier of the notification thread. This corresponds to the value returned in the <code>id</code> field when you retrieve notifications (for example with the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user\"><code>GET /notifications</code> operation</a>).</p>",
"in": "path",
"required": true,
"schema": {
@@ -83792,7 +83792,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/activity#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"descriptionHTML": "<p>Mutes all future notifications for a conversation until you comment on the thread or get an <strong>@mention</strong>. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#set-a-thread-subscription\">Set a thread subscription</a> endpoint and set <code>ignore</code> to <code>true</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -84946,7 +84946,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/activity#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"descriptionHTML": "<p>Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a <code>202 Accepted</code> status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user\">List repository notifications for the authenticated user</a> endpoint and pass the query parameter <code>all=false</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -93032,7 +93032,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/activity#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"descriptionHTML": "<p>If you would like to watch a repository, set <code>subscribed</code> to <code>true</code>. If you would like to ignore notifications made within a repository, set <code>ignored</code> to <code>true</code>. If you would like to stop watching a repository, <a href=\"https://docs.github.com/enterprise-server@3.9/rest/activity/watching#delete-a-repository-subscription\">delete the repository's subscription</a> completely.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -93087,7 +93087,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/activity#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"descriptionHTML": "<p>This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, <a href=\"https://docs.github.com/enterprise-server@3.9/rest/activity/watching#set-a-repository-subscription\">set the repository's subscription manually</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -203954,7 +203954,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the settings for your instance. To change settings, see the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/enterprise-admin#set-settings\">Set settings endpoint</a>.</p>\n<p><strong>Note:</strong> You cannot retrieve the management console password with the Enterprise administration API.</p>",
"descriptionHTML": "<p>Gets the settings for your instance. To change settings, see the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#set-settings\">Set settings endpoint</a>.</p>\n<p><strong>Note:</strong> You cannot retrieve the management console password with the Enterprise administration API.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -203979,7 +203979,7 @@
"type": "string",
"name": "settings",
"in": "body",
"description": "<p>A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/enterprise-admin#get-settings\">Get settings endpoint</a>.</p>",
"description": "<p>A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings\">Get settings endpoint</a>.</p>",
"isRequired": true
}
],
@@ -204002,7 +204002,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Applies settings on your instance. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/enterprise-admin#get-settings\">Get settings endpoint</a>.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>The request body for this operation must be submitted as <code>application/x-www-form-urlencoded</code> data. You can submit a parameter value as a string, or you can use a tool such as <code>curl</code> to submit a parameter value as the contents of a text file. For more information, see the <a href=\"https://curl.se/docs/manpage.html#--data-urlencode\"><code>curl</code> documentation</a>.</li>\n<li>You cannot set the management console password with the Enterprise administration API. Use the <code>ghe-set-password</code> utility to change the management console password. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password\">Command-line utilities</a>.\"</li>\n</ul>",
"descriptionHTML": "<p>Applies settings on your instance. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings\">Get settings endpoint</a>.</p>\n<p><strong>Notes:</strong></p>\n<ul>\n<li>The request body for this operation must be submitted as <code>application/x-www-form-urlencoded</code> data. You can submit a parameter value as a string, or you can use a tool such as <code>curl</code> to submit a parameter value as the contents of a text file. For more information, see the <a href=\"https://curl.se/docs/manpage.html#--data-urlencode\"><code>curl</code> documentation</a>.</li>\n<li>You cannot set the management console password with the Enterprise administration API. Use the <code>ghe-set-password</code> utility to change the management console password. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password\">Command-line utilities</a>.\"</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -204259,7 +204259,7 @@
"type": "string",
"name": "settings",
"in": "body",
"description": "<p>An optional JSON string containing the installation settings. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/enterprise-admin#get-settings\">Get settings endpoint</a>.</p>"
"description": "<p>An optional JSON string containing the installation settings. For a list of the available settings, see the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings\">Get settings endpoint</a>.</p>"
}
],
"enabledForGitHubApps": false,
@@ -204282,7 +204282,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.</p>\n<p>Note that you need to <code>POST</code> to <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/enterprise-admin#start-a-configuration-process\"><code>/setup/api/configure</code></a> to start the actual configuration process.</p>\n<p>When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:</p>\n<ol>\n<li>If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.</li>\n<li>If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.</li>\n</ol>\n<p><strong>Note:</strong> The request body for this operation must be submitted as <code>multipart/form-data</code> data. You can can reference the license file by prefixing the filename with the <code>@</code> symbol using <code>curl</code>. For more information, see the <a href=\"https://curl.se/docs/manpage.html#-F\"><code>curl</code> documentation</a>.</p>",
"descriptionHTML": "<p>When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.</p>\n<p>Note that you need to <code>POST</code> to <a href=\"https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#start-a-configuration-process\"><code>/setup/api/configure</code></a> to start the actual configuration process.</p>\n<p>When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:</p>\n<ol>\n<li>If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.</li>\n<li>If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.</li>\n</ol>\n<p><strong>Note:</strong> The request body for this operation must be submitted as <code>multipart/form-data</code> data. You can can reference the license file by prefixing the filename with the <code>@</code> symbol using <code>curl</code>. For more information, see the <a href=\"https://curl.se/docs/manpage.html#-F\"><code>curl</code> documentation</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -212547,7 +212547,7 @@
"url": "https://enterprise.octocat.com/api/v3/authorizations/2",
"app": {
"name": "My personal access token",
"url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens",
"url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens",
"client_id": "00000000000000000000"
},
"token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a",
@@ -213649,7 +213649,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user\">update the LDAP mapping</a> for the user.</p>\n<p>The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send <code>\"octo_cat\"</code> as the login, a user named <code>\"octo-cat\"</code> will be created.</p>\n<p>If the login name or email address is already associated with an account, the server will return a <code>422</code> response.</p>",
"descriptionHTML": "<p>If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also <a href=\"https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user\">update the LDAP mapping</a> for the user.</p>\n<p>The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send <code>\"octo_cat\"</code> as the login, a user named <code>\"octo-cat\"</code> will be created.</p>\n<p>If the login name or email address is already associated with an account, the server will return a <code>422</code> response.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -213767,7 +213767,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Deleting a user will delete all their repositories, gists, applications, and personal settings. <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/enterprise-admin#suspend-a-user\">Suspending a user</a> is often a better option.</p>\n<p>You can delete any user account except your own.</p>",
"descriptionHTML": "<p>Deleting a user will delete all their repositories, gists, applications, and personal settings. <a href=\"https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#suspend-a-user\">Suspending a user</a> is often a better option.</p>\n<p>You can delete any user account except your own.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -231547,7 +231547,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/git#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/git#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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>Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then <a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference\">create</a> the <code>refs/tags/[tag]</code> reference. If you want to create a lightweight tag, you only have to <a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference\">create</a> the tag reference - this call would be unnecessary.</p>\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": "201",
@@ -232007,7 +232007,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/git#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/git#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"descriptionHTML": "<p>The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.</p>\n<p>If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/commits#create-a-commit\">Create a commit</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/refs#update-a-reference\">Update a reference</a>.\"</p>\n<p>Returns an error if you try to delete a file that does not exist.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -321810,7 +321810,7 @@
}
],
"previews": [],
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"descriptionHTML": "<p><strong>Deprecation Notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -322257,7 +322257,7 @@
"url": "https://enterprise.octocat.com/api/v3/authorizations/2",
"app": {
"name": "My personal access token",
"url": "https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens",
"url": "https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens",
"client_id": "00000000000000000000"
},
"token": "ghp_16C7e42F292c6912E7710c838347Ae178B4a",
@@ -332663,7 +332663,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/enterprise-server@3.9/articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"descriptionHTML": "<p>List <a href=\"https://docs.github.com/enterprise-server@3.9/articles/publicizing-or-concealing-organization-membership\">public organization memberships</a> for the specified user.</p>\n<p>This method only lists <em>public</em> memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#list-organizations-for-the-authenticated-user\">List organizations for the authenticated user</a> API instead.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -335724,7 +335724,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/orgs#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"descriptionHTML": "<p>Only authenticated organization owners can add a member to the organization or update the member's role.</p>\n<ul>\n<li>If the authenticated user is <em>adding</em> a member to the organization, the invited user will receive an email inviting them to the organization. The user's <a href=\"https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-organization-membership-for-a-user\">membership status</a> will be <code>pending</code> until they accept the invitation.</li>\n<li>Authenticated users can <em>update</em> a user's membership by passing the <code>role</code> parameter. If the authenticated user changes a member's role to <code>admin</code>, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to <code>member</code>, no email will be sent.</li>\n</ul>\n<p><strong>Rate limits</strong></p>\n<p>To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -338955,7 +338955,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/reference/orgs#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Returns a webhook configured in an organization. To get only the webhook <code>config</code> properties, see \"<a href=\"/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization\">Get a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -339206,7 +339206,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/reference/orgs#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"descriptionHTML": "<p>Updates a webhook configured in an organization. When you update a webhook, the <code>secret</code> will be overwritten. If you previously had a <code>secret</code> set, you must provide the same <code>secret</code> or set a new <code>secret</code> or the secret will be removed. If you are only updating individual webhook <code>config</code> properties, use \"<a href=\"/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization\">Update a webhook configuration for an organization</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -339378,7 +339378,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:read</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -339515,7 +339515,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/reference/orgs#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>Access tokens must have the <code>admin:org_hook</code> scope, and GitHub Apps must have the <code>organization_hooks:write</code> permission.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -433319,7 +433319,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/enterprise-server@3.9/articles/about-repository-transfers/\">about repository transfers</a>.</p>",
"descriptionHTML": "<p>A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original <code>owner</code>, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see <a href=\"https://docs.github.com/enterprise-server@3.9/articles/about-repository-transfers/\">about repository transfers</a>.\nYou must use a personal access token or an OAuth token for this endpoint. An installation access token cannot be used because it is only granted access to a single account.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -443430,7 +443430,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/git#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.9/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"descriptionHTML": "<p>Gets the contents of a file or directory in a repository. Specify the file path or directory in <code>:path</code>. If you omit\n<code>:path</code>, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. </p>\n<p>Files and symlinks support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#custom-media-types\">a custom media type</a> for\nretrieving the raw content or rendered HTML (when supported). All content types support <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/repos#custom-media-types\">a custom media\ntype</a> to ensure the content is returned in a consistent\nobject format.</p>\n<p><strong>Notes</strong>:</p>\n<ul>\n<li>\n<p>To get a repository's contents recursively, you can <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/git#trees\">recursively get the tree</a>.</p>\n</li>\n<li>\n<p>This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the <a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree\">Git Trees\nAPI</a>.</p>\n</li>\n<li>\n<p>Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.\nSize limits:\nIf the requested file's size is:</p>\n</li>\n<li>\n<p>1 MB or smaller: All features of this endpoint are supported.</p>\n</li>\n<li>\n<p>Between 1-100 MB: Only the <code>raw</code> or <code>object</code> <a href=\"https://docs.github.com/enterprise-server@3.9/rest/repos/contents#custom-media-types-for-repository-contents\">custom media types</a> are supported. Both will work as normal, except that when using the <code>object</code> media type, the <code>content</code> field will be an empty string and the <code>encoding</code> field will be <code>\"none\"</code>. To get the contents of these larger files, use the <code>raw</code> media type.</p>\n</li>\n<li>\n<p>Greater than 100 MB: This endpoint is not supported.</p>\n<p> If the content is a directory:\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n<em>should</em> be \"submodule\". This behavior exists in API v3 <a href=\"https://git.io/v1YCW\">for backwards compatibility purposes</a>.\nIn the next major version of the API, the type will be returned as \"submodule\".</p>\n<p> If the content is a symlink:\nIf the requested <code>:path</code> points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object\ndescribing the symlink itself.</p>\n<p> If the content is a submodule:\nThe <code>submodule_git_url</code> identifies the location of the submodule repository, and the <code>sha</code> identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.</p>\n</li>\n</ul>\n<p>If the submodule repository is not hosted on github.com, the Git URLs (<code>git_url</code> and <code>_links[\"git\"]</code>) and the\ngithub.com URLs (<code>html_url</code> and <code>_links[\"html\"]</code>) will have null values.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -465319,7 +465319,7 @@
"type": "string",
"name": "ldap_dn",
"in": "body",
"description": "<p>The <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team\">Update LDAP mapping for a team</a>\" endpoint to change the LDAP DN. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync\">Using LDAP</a>.\"</p>"
"description": "<p>The <a href=\"https://www.ldap.com/ldap-dns-and-rdns\">distinguished name</a> (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team\">Update LDAP mapping for a team</a>\" endpoint to change the LDAP DN. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync\">Using LDAP</a>.\"</p>"
}
],
"enabledForGitHubApps": true,

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

@@ -33,5 +33,5 @@
]
}
},
"sha": "19833171fa53a9a674f247f795f0cf44a65a05e4"
"sha": "1231d73f01884025424e5f512153b5183e4a847e"
}

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

@@ -14712,7 +14712,7 @@
"type": "string",
"name": "ref",
"in": "body",
"description": "<p>The <a href=\"https://docs.github.com/rest/reference/git#get-a-reference\"><code>git ref</code></a> resource.</p>",
"description": "<p>The <a href=\"https://docs.github.com/rest/git/refs#get-a-reference\"><code>git ref</code></a> resource.</p>",
"isRequired": true
},
{
@@ -14789,7 +14789,7 @@
"type": "string",
"name": "ref",
"in": "body",
"description": "<p>The <a href=\"https://docs.github.com/rest/reference/git#get-a-reference\"><code>git ref</code></a> resource.</p>",
"description": "<p>The <a href=\"https://docs.github.com/rest/git/refs#get-a-reference\"><code>git ref</code></a> resource.</p>",
"isRequired": true
},
{

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

@@ -14712,7 +14712,7 @@
"type": "string",
"name": "ref",
"in": "body",
"description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/git#get-a-reference\"><code>git ref</code></a> resource.</p>",
"description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/git/refs#get-a-reference\"><code>git ref</code></a> resource.</p>",
"isRequired": true
},
{
@@ -14789,7 +14789,7 @@
"type": "string",
"name": "ref",
"in": "body",
"description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/reference/git#get-a-reference\"><code>git ref</code></a> resource.</p>",
"description": "<p>The <a href=\"https://docs.github.com/github-ae@latest/rest/git/refs#get-a-reference\"><code>git ref</code></a> resource.</p>",
"isRequired": true
},
{

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

@@ -14712,7 +14712,7 @@
"type": "string",
"name": "ref",
"in": "body",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/git#get-a-reference\"><code>git ref</code></a> resource.</p>",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference\"><code>git ref</code></a> resource.</p>",
"isRequired": true
},
{
@@ -14789,7 +14789,7 @@
"type": "string",
"name": "ref",
"in": "body",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/git#get-a-reference\"><code>git ref</code></a> resource.</p>",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference\"><code>git ref</code></a> resource.</p>",
"isRequired": true
},
{

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

@@ -14491,7 +14491,7 @@
"type": "string",
"name": "ref",
"in": "body",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/git#get-a-reference\"><code>git ref</code></a> resource.</p>",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/refs#get-a-reference\"><code>git ref</code></a> resource.</p>",
"isRequired": true
},
{
@@ -14568,7 +14568,7 @@
"type": "string",
"name": "ref",
"in": "body",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/reference/git#get-a-reference\"><code>git ref</code></a> resource.</p>",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.7/rest/git/refs#get-a-reference\"><code>git ref</code></a> resource.</p>",
"isRequired": true
},
{

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

@@ -14491,7 +14491,7 @@
"type": "string",
"name": "ref",
"in": "body",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/git#get-a-reference\"><code>git ref</code></a> resource.</p>",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/refs#get-a-reference\"><code>git ref</code></a> resource.</p>",
"isRequired": true
},
{
@@ -14568,7 +14568,7 @@
"type": "string",
"name": "ref",
"in": "body",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/reference/git#get-a-reference\"><code>git ref</code></a> resource.</p>",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.8/rest/git/refs#get-a-reference\"><code>git ref</code></a> resource.</p>",
"isRequired": true
},
{

4
src/webhooks/data/ghes-3.9/schema.json
View File

@@ -14711,7 +14711,7 @@
"type": "string",
"name": "ref",
"in": "body",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/git#get-a-reference\"><code>git ref</code></a> resource.</p>",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/refs#get-a-reference\"><code>git ref</code></a> resource.</p>",
"isRequired": true
},
{
@@ -14788,7 +14788,7 @@
"type": "string",
"name": "ref",
"in": "body",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/reference/git#get-a-reference\"><code>git ref</code></a> resource.</p>",
"description": "<p>The <a href=\"https://docs.github.com/enterprise-server@3.9/rest/git/refs#get-a-reference\"><code>git ref</code></a> resource.</p>",
"isRequired": true
},
{

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

@@ -1,3 +1,3 @@
{
"sha": "19833171fa53a9a674f247f795f0cf44a65a05e4"
"sha": "1231d73f01884025424e5f512153b5183e4a847e"
}