diff --git a/.gitignore b/.gitignore index 5ad99e78e7a4..20a95464ff62 100644 --- a/.gitignore +++ b/.gitignore @@ -37,9 +37,6 @@ # TypeScript incremental build info *.tsbuildinfo -# Early access images from docs-early-access repo -assets/images/early-access/ - # Accidentally committed file that should be ignored assets/images/help/writing/unordered-list-rendered (1).png @@ -52,15 +49,14 @@ blc_output_internal.log # Old broken links report broken_links.md -# Early access content from docs-early-access repo -content/early-access/ +# Directories from the docs-early-access repo. Used for symlinks in local docs-internal checkouts. Don't add trailing slashes. +content/early-access +data/early-access +assets/images/early-access # Test coverage reports coverage/ -# Early access data from docs-early-access repo -data/early-access/ - # Cloned for Elasticsearch indexing data docs-internal-data/ diff --git a/content/billing/concepts/enterprise-billing/combined-enterprise-use.md b/content/billing/concepts/enterprise-billing/combined-enterprise-use.md index f01cc34c7c11..ef4acac2872e 100644 --- a/content/billing/concepts/enterprise-billing/combined-enterprise-use.md +++ b/content/billing/concepts/enterprise-billing/combined-enterprise-use.md @@ -32,7 +32,7 @@ To use a {% data variables.product.prodname_ghe_server %} instance, you must upl There are two types of {% data variables.product.prodname_enterprise %} (GHE) licensing models, with different processes for enabling combined use of {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_server %}. * **GHE (Usage-based, also called metered)**: A cloud-first license where users must first be assigned to a {% data variables.product.prodname_ghe_cloud %} organization. - * All Cloud users automatically receive a use right for {% data variables.product.prodname_ghe_server %}. + * All Cloud users automatically receive a right to use {% data variables.product.prodname_ghe_server %}. * Billing is based on the number of active users each month. * Users can generate their own Server license, which covers the number of assigned Cloud seats at the time of generation and is valid for one year. * Server-only users will be added to GHE (Metered) billing. These users are de-duplicated with email matching to avoid double billing. diff --git a/content/billing/how-tos/manage-plan-and-licenses/manage-user-licenses.md b/content/billing/how-tos/manage-plan-and-licenses/manage-user-licenses.md index f699acf15046..ba064e66faaa 100644 --- a/content/billing/how-tos/manage-plan-and-licenses/manage-user-licenses.md +++ b/content/billing/how-tos/manage-plan-and-licenses/manage-user-licenses.md @@ -57,6 +57,6 @@ Enterprise **owners** or **billing managers** can add or remove user licenses. 1. Navigate to your enterprise account. {% data reusables.billing.enterprise-billing-menu %} -1. In the left sidebar, click **Licensing**. +1. In the left sidebar, click {% octicon "law" aria-hidden="true" aria-label="law" %} **Licensing**. 1. Next to "Enterprise Cloud", click **{% octicon "kebab-horizontal" aria-hidden="true" aria-label="kebab-horizontal" %}**, then click **Manage licenses**. 1. Choose your number of licenses, then click **Confirm licenses**. diff --git a/data/reusables/billing/usage-based-billing.md b/data/reusables/billing/usage-based-billing.md index 7e4abc044f2a..b1100be88da8 100644 --- a/data/reusables/billing/usage-based-billing.md +++ b/data/reusables/billing/usage-based-billing.md @@ -1,5 +1,5 @@ {% ifversion enhanced-billing-platform %} -> [!NOTE] If you currently pay for your {% data variables.product.prodname_enterprise %} licenses through a volume, subscription, or prepaid agreement, you will continue to be billed in this way until your agreement expires. At renewal, you have the option to switch to the metered billing model. +> [!NOTE] If you currently pay for your {% data variables.product.prodname_enterprise %} licenses through a volume, subscription, or prepaid agreement, you will continue to be billed in this way until your agreement expires or you are invited to transition. At renewal, you have the option to switch to the metered billing model. {% endif %} diff --git a/src/frame/middleware/index.ts b/src/frame/middleware/index.ts index 8f6afe911897..1b9de2e6a309 100644 --- a/src/frame/middleware/index.ts +++ b/src/frame/middleware/index.ts @@ -66,6 +66,7 @@ import { MAX_REQUEST_TIMEOUT } from '@/frame/lib/constants' import { initLoggerContext } from '@/observability/logger/lib/logger-context' import { getAutomaticRequestLogger } from '@/observability/logger/middleware/get-automatic-request-logger' import appRouterGateway from './app-router-gateway' +import urlDecode from './url-decode' const { NODE_ENV } = process.env const isTest = NODE_ENV === 'test' || process.env.GITHUB_ACTIONS === 'true' @@ -199,6 +200,7 @@ export default function (app: Express) { app.set('etag', false) // We will manage our own ETags if desired // *** Config and context for redirects *** + app.use(urlDecode) // Must come before detectLanguage to decode @ symbols in version segments app.use(detectLanguage) // Must come before context, breadcrumbs, find-page, handle-errors, homepages app.use(asyncMiddleware(reloadTree)) // Must come before context app.use(asyncMiddleware(context)) // Must come before early-access-*, handle-redirects diff --git a/src/frame/middleware/url-decode.ts b/src/frame/middleware/url-decode.ts new file mode 100644 index 000000000000..bc3d2cc25c24 --- /dev/null +++ b/src/frame/middleware/url-decode.ts @@ -0,0 +1,28 @@ +import type { NextFunction, Response } from 'express' +import type { ExtendedRequest } from '@/types' + +/** + * Middleware to decode URL-encoded @ symbols. + * + * SharePoint and other systems automatically encode @ symbols to %40, + * which breaks our versioned URLs like /en/enterprise-cloud@latest. + * This middleware decodes @ symbols anywhere in the URL. + */ +export default function urlDecode(req: ExtendedRequest, res: Response, next: NextFunction) { + const originalUrl = req.url + + // Only process URLs that contain %40 (encoded @) + if (!originalUrl.includes('%40')) { + return next() + } + + try { + // Decode the entire URL, replacing %40 with @ + const decodedUrl = originalUrl.replace(/%40/g, '@') + req.url = decodedUrl + return next() + } catch { + // If decoding fails for any reason, continue with original URL + return next() + } +} diff --git a/src/frame/tests/url-encoding.ts b/src/frame/tests/url-encoding.ts new file mode 100644 index 000000000000..327066098ffa --- /dev/null +++ b/src/frame/tests/url-encoding.ts @@ -0,0 +1,72 @@ +import { describe, expect, test } from 'vitest' +import { get } from '@/tests/helpers/e2etest' + +describe('URL encoding for version paths', () => { + test('handles URL-encoded @ symbol in enterprise-cloud version', async () => { + // SharePoint encodes @ as %40, so /en/enterprise-cloud@latest becomes /en/enterprise-cloud%40latest + const encodedUrl = '/en/enterprise-cloud%40latest/copilot/concepts/chat' + const res = await get(encodedUrl) + + // Should either: + // 1. Work directly (200) - the encoded URL should decode and work + // 2. Redirect (301/302) to the proper decoded URL + // Should NOT return 404 + expect([200, 301, 302]).toContain(res.statusCode) + + if (res.statusCode === 301 || res.statusCode === 302) { + // If it redirects, it should redirect to the decoded version + expect(res.headers.location).toBe('/en/enterprise-cloud@latest/copilot/concepts/chat') + } + }) + + test('handles URL-encoded @ symbol in enterprise-server version', async () => { + const encodedUrl = + '/en/enterprise-server%403.17/admin/managing-github-actions-for-your-enterprise' + const res = await get(encodedUrl) + + expect([200, 301, 302]).toContain(res.statusCode) + + if (res.statusCode === 301 || res.statusCode === 302) { + expect(res.headers.location).toBe( + '/en/enterprise-server@3.17/admin/managing-github-actions-for-your-enterprise', + ) + } + }) + + test('handles URL-encoded @ symbol in second path segment', async () => { + // When no language prefix is present + const encodedUrl = '/enterprise-cloud%40latest/copilot/concepts/chat' + const res = await get(encodedUrl) + + // Should redirect to add language prefix and decode + expect([301, 302]).toContain(res.statusCode) + expect(res.headers.location).toBe('/en/enterprise-cloud@latest/copilot/concepts/chat') + }) + + test('normal @ symbol paths continue to work', async () => { + // Ensure we don't break existing functionality + const normalUrl = '/en/enterprise-cloud@latest/copilot/concepts/chat' + const res = await get(normalUrl) + + expect(res.statusCode).toBe(200) + }) + + test('URL encoding in other parts of URL is preserved', async () => { + // Only @ symbols in version paths should be decoded, other encoding should be preserved + const encodedUrl = '/en/enterprise-cloud@latest/copilot/concepts/some%20page' + const res = await get(encodedUrl) + + // This might 404 if the page doesn't exist, but shouldn't break due to encoding + expect(res.statusCode).not.toBe(500) + }) + + test('Express URL properties are correctly updated after decoding', async () => { + // Test that req.path, req.query, etc. are properly updated when req.url is modified + const encodedUrl = '/en/enterprise-cloud%40latest/copilot/concepts/chat?test=value' + const res = await get(encodedUrl) + + // Should work correctly (200 or redirect) - the middleware should properly update + // req.path from '/en/enterprise-cloud%40latest/...' to '/en/enterprise-cloud@latest/...' + expect([200, 301, 302]).toContain(res.statusCode) + }) +}) diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index 03576fcaf487..fa8d728b7b21 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -962,21 +962,48 @@ "permissions": [ { "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "additional-permissions": false, "access": "read" }, { "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "additional-permissions": false, - "access": "write" + "access": "admin" + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "admin" + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "admin" } ] }, diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index 39ad24261576..c90b3ee3b3f7 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -3349,16 +3349,34 @@ "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index 2eaa98e7cfb8..27b5b88baec9 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -1168,10 +1168,10 @@ "permissions": [ { "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "access": "read", "user-to-server": true, "server-to-server": true, @@ -1179,11 +1179,44 @@ }, { "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", - "access": "write", + "requestPath": "/orgs/{org}/properties/schema", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "admin", "user-to-server": true, "server-to-server": true, "additional-permissions": false diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index aee06408a35b..a4fa3069126e 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -3303,16 +3303,34 @@ "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index 4ee0b61c6d28..102f0a291aac 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -3783,16 +3783,34 @@ "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index c06ea676a55f..e733d8f12898 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -1280,21 +1280,48 @@ "permissions": [ { "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "additional-permissions": false, "access": "read" }, { "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "additional-permissions": false, - "access": "write" + "access": "admin" + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "admin" + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "admin" } ] }, diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index 43de873d6a9f..cef498788397 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -3707,16 +3707,34 @@ "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index d95bd21c6b44..4d3b119eab23 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -1720,10 +1720,10 @@ "permissions": [ { "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "access": "read", "user-to-server": true, "server-to-server": true, @@ -1731,11 +1731,44 @@ }, { "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", - "access": "write", + "requestPath": "/orgs/{org}/properties/schema", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "admin", "user-to-server": true, "server-to-server": true, "additional-permissions": false diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index 073670ccc0eb..7d62913c48e0 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -3715,16 +3715,34 @@ "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index 54a0de0289cd..4dd0c61833e2 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -4195,16 +4195,34 @@ "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json index aaa6365caee7..695b458f7d36 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json @@ -491,21 +491,48 @@ "permissions": [ { "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "additional-permissions": false, "access": "read" }, { "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "additional-permissions": false, - "access": "write" + "access": "admin" + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "admin" + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "admin" } ] }, diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json index 5e94c8abffda..e9b2b695d383 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat.json @@ -2495,16 +2495,34 @@ "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json index e9d402fb5def..65e326bb1c20 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json @@ -595,10 +595,10 @@ "permissions": [ { "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "access": "read", "user-to-server": true, "server-to-server": true, @@ -606,11 +606,44 @@ }, { "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", - "access": "write", + "requestPath": "/orgs/{org}/properties/schema", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "admin", "user-to-server": true, "server-to-server": true, "additional-permissions": false diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json index 49976d0f3cca..56de287662b3 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-rest.json @@ -2665,16 +2665,34 @@ "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json index 0f43b26d176b..37cb41e75606 100644 --- a/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.14-2022-11-28/user-to-server-rest.json @@ -2853,16 +2853,34 @@ "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json index a3af5e5c3b06..2a7ef1188df3 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json @@ -581,21 +581,48 @@ "permissions": [ { "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "additional-permissions": false, "access": "read" }, { "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "additional-permissions": false, - "access": "write" + "access": "admin" + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "admin" + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "admin" } ] }, diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json index 1672a5dadd13..6bf335f2dc7b 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat.json @@ -2563,16 +2563,34 @@ "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json index f17e6d35085b..75df6ab3a241 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json @@ -705,10 +705,10 @@ "permissions": [ { "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "access": "read", "user-to-server": true, "server-to-server": true, @@ -716,11 +716,44 @@ }, { "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", - "access": "write", + "requestPath": "/orgs/{org}/properties/schema", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "admin", "user-to-server": true, "server-to-server": true, "additional-permissions": false diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json index 33c779631da9..cc0c3c24060d 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-rest.json @@ -2733,16 +2733,34 @@ "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json index 9c4ed4683e2d..8bbd7da37a3d 100644 --- a/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.15-2022-11-28/user-to-server-rest.json @@ -2921,16 +2921,34 @@ "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json index f38934f606d2..a4c89004df63 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json @@ -581,21 +581,48 @@ "permissions": [ { "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "additional-permissions": false, "access": "read" }, { "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "additional-permissions": false, - "access": "write" + "access": "admin" + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "admin" + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "admin" } ] }, diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json index 3eee3fc38e02..1e543b4cbe11 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat.json @@ -2563,16 +2563,34 @@ "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json index 0d08cc22b4af..a24f3f3d5ae3 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json @@ -705,10 +705,10 @@ "permissions": [ { "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "access": "read", "user-to-server": true, "server-to-server": true, @@ -716,11 +716,44 @@ }, { "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", - "access": "write", + "requestPath": "/orgs/{org}/properties/schema", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "admin", "user-to-server": true, "server-to-server": true, "additional-permissions": false diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json index 8bd98b94c7b2..aa4c3bd1b8dd 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-rest.json @@ -2733,16 +2733,34 @@ "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json index b2445798471d..7cceb8ae07d4 100644 --- a/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.16-2022-11-28/user-to-server-rest.json @@ -2921,16 +2921,34 @@ "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json index adec1a449b4a..75a1f93af68a 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json @@ -590,21 +590,48 @@ "permissions": [ { "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "additional-permissions": false, "access": "read" }, { "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "additional-permissions": false, - "access": "write" + "access": "admin" + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "admin" + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "additional-permissions": false, + "access": "admin" } ] }, diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json index 1fd635a9152c..0d2146361e41 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat.json @@ -2569,16 +2569,34 @@ "requestPath": "/orgs/{org}/outside_collaborators/{username}" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json index 285e3ed8a2c0..6db7a4cc1ba7 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json @@ -716,10 +716,10 @@ "permissions": [ { "category": "orgs", - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values", + "requestPath": "/orgs/{org}/properties/schema", "access": "read", "user-to-server": true, "server-to-server": true, @@ -727,11 +727,44 @@ }, { "category": "orgs", - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values", - "access": "write", + "requestPath": "/orgs/{org}/properties/schema", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "admin", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "orgs", + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}", + "access": "admin", "user-to-server": true, "server-to-server": true, "additional-permissions": false diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json index 83414ae2b83e..503be680a649 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-rest.json @@ -2739,16 +2739,34 @@ "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json index 367243f9d56e..51eacef9e860 100644 --- a/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghes-3.17-2022-11-28/user-to-server-rest.json @@ -2927,16 +2927,34 @@ "requestPath": "/orgs/{org}/personal-access-tokens/{pat_id}/repositories" }, { - "slug": "list-custom-property-values-for-organization-repositories", + "slug": "get-all-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "get", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" }, { - "slug": "create-or-update-custom-property-values-for-organization-repositories", + "slug": "create-or-update-custom-properties-for-an-organization", "subcategory": "custom-properties", "verb": "patch", - "requestPath": "/orgs/{org}/properties/values" + "requestPath": "/orgs/{org}/properties/schema" + }, + { + "slug": "get-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "get", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "create-or-update-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "put", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" + }, + { + "slug": "remove-a-custom-property-for-an-organization", + "subcategory": "custom-properties", + "verb": "delete", + "requestPath": "/orgs/{org}/properties/schema/{custom_property_name}" }, { "slug": "list-public-organization-members", diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 5a964317ba8b..06b7daf6eb70 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -421986,6 +421986,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -422244,6 +422254,16 @@ ] } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -422465,6 +422485,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -422691,6 +422721,16 @@ ] } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -422879,6 +422919,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -422959,16 +423009,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -423144,16 +423184,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index e4096387f2f1..1e7b1511b81d 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -3660,13 +3660,13 @@ } ], "previews": [], - "descriptionHTML": "

Updates a GitHub-hosted runner for an enterprise.\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Updates a GitHub-hosted runner for an enterprise.\nOAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -6675,13 +6675,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -31855,7 +31855,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists all labels for a self-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -31865,7 +31864,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Lists all labels for a self-hosted runner configured in a repository.

\n

Authenticated users must have admin access to the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -37282,13 +37282,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" } ], "workflow-runs": [ @@ -43723,7 +43723,6 @@ } ], "previews": [], - "descriptionHTML": "

Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see \"Approving workflow runs from public forks.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", @@ -43737,7 +43736,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see \"Approving workflow runs from public forks.\"

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -46602,13 +46602,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific workflow run attempt.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific workflow run attempt.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" }, { "serverUrl": "https://api.github.com", @@ -46770,7 +46770,6 @@ } ], "previews": [], - "descriptionHTML": "

Cancels a workflow run using its id.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "202", @@ -46780,7 +46779,8 @@ "httpStatusCode": "409", "description": "

Conflict

" } - ] + ], + "descriptionHTML": "

Cancels a workflow run using its id.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -46854,13 +46854,13 @@ } ], "previews": [], - "descriptionHTML": "

Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"

\n

Note

\n

\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.

\n
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"Using environments for deployment.\"

\n

Note

\n

\nGitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments.

\n
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" }, { "serverUrl": "https://api.github.com", @@ -110833,13 +110833,13 @@ } ], "previews": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -123496,13 +123496,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.

\n

Paid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.

\n

Paid minutes only apply to packages stored for private repositories. For more information, see \"Managing billing for GitHub Packages.\"

\n

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

" } ], "enhanced-billing": [ @@ -235939,13 +235939,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all development environment secrets available for a user's codespaces without revealing their\nencrypted values.

\n

The authenticated user must have Codespaces access to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the codespace or codespace:secrets scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all development environment secrets available for a user's codespaces without revealing their\nencrypted values.

\n

The authenticated user must have Codespaces access to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the codespace or codespace:secrets scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -312133,13 +312133,13 @@ } ], "previews": [], - "descriptionHTML": "

To create an enterprise team, the authenticated user must be an owner of the enterprise.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

To create an enterprise team, the authenticated user must be an owner of the enterprise.

" }, { "serverUrl": "https://api.github.com", @@ -402429,13 +402429,13 @@ } ], "previews": [], - "descriptionHTML": "

Deletes a label using the given label name.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Deletes a label using the given label name.

" }, { "serverUrl": "https://api.github.com", @@ -438763,13 +438763,13 @@ } ], "previews": [], - "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

" }, { "serverUrl": "https://api.github.com", @@ -439232,7 +439232,6 @@ } ], "previews": [], - "descriptionHTML": "

Get all supported GitHub Enterprise Cloud API versions.

", "statusCodes": [ { "httpStatusCode": "200", @@ -439242,7 +439241,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Get all supported GitHub Enterprise Cloud API versions.

" }, { "serverUrl": "https://api.github.com", @@ -440553,7 +440553,6 @@ } ], "previews": [], - "descriptionHTML": "

Each array contains the day number, hour number, and number of commits:

\n\n

For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

", "statusCodes": [ { "httpStatusCode": "200", @@ -440563,7 +440562,8 @@ "httpStatusCode": "204", "description": "

A header with no content is returned.

" } - ] + ], + "descriptionHTML": "

Each array contains the day number, hour number, and number of commits:

\n\n

For example, [2, 14, 25] indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.

" } ], "traffic": [ @@ -440938,7 +440938,6 @@ } ], "previews": [], - "descriptionHTML": "

Get the top 10 popular contents over the last 14 days.

", "statusCodes": [ { "httpStatusCode": "200", @@ -440948,7 +440947,8 @@ "httpStatusCode": "403", "description": "

Forbidden

" } - ] + ], + "descriptionHTML": "

Get the top 10 popular contents over the last 14 days.

" }, { "serverUrl": "https://api.github.com", @@ -453533,7 +453533,6 @@ } ], "previews": [], - "descriptionHTML": "

Unlocks a repository. You can lock repositories when you start a user migration. Once the migration is complete you can unlock each repository to begin using it again or delete the repository if you no longer need the source data. Returns a status of 404 Not Found if the repository is not locked.

", "statusCodes": [ { "httpStatusCode": "204", @@ -453555,7 +453554,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Unlocks a repository. You can lock repositories when you start a user migration. Once the migration is complete you can unlock each repository to begin using it again or delete the repository if you no longer need the source data. Returns a status of 404 Not Found if the repository is not locked.

" }, { "serverUrl": "https://api.github.com", @@ -460337,13 +460337,13 @@ } ], "previews": [], - "descriptionHTML": "

Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.

" }, { "serverUrl": "https://api.github.com", @@ -462032,6 +462032,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -462290,6 +462300,16 @@ ] } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -462511,6 +462531,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -462737,6 +462767,16 @@ ] } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -462925,6 +462965,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -463005,16 +463055,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -463190,16 +463230,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -466478,7 +466508,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -466488,7 +466517,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -472298,13 +472328,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a hosted compute network configuration configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a hosted compute network configuration configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the read:network_configurations scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -499167,13 +499197,13 @@ } ], "previews": [], - "descriptionHTML": "

Gets a specific package for a package owned by the authenticated user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Gets a specific package for a package owned by the authenticated user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

" }, { "serverUrl": "https://api.github.com", @@ -508130,7 +508160,6 @@ } ], "previews": [], - "descriptionHTML": "

Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -508140,7 +508169,8 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ] + ], + "descriptionHTML": "

Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -590207,13 +590237,13 @@ } ], "previews": [], - "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ] + ], + "descriptionHTML": "

Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" }, { "serverUrl": "https://api.github.com", @@ -606966,7 +606996,6 @@ } ], "previews": [], - "descriptionHTML": "

Create a reaction to a team discussion comment.

\n

A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -606976,7 +607005,8 @@ "httpStatusCode": "201", "description": "

Created

" } - ] + ], + "descriptionHTML": "

Create a reaction to a team discussion comment.

\n

A response with an HTTP 200 status means that you already added the reaction type to this team discussion comment.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" }, { "serverUrl": "https://api.github.com", @@ -627554,7 +627584,6 @@ } ], "previews": [], - "descriptionHTML": "

Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

\n

OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.

", "statusCodes": [ { "httpStatusCode": "201", @@ -627568,7 +627597,8 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ] + ], + "descriptionHTML": "

Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

\n

OAuth app tokens and personal access tokens (classic) need the public_repo or repo scope to create a public repository, and repo scope to create a private repository.

" }, { "serverUrl": "https://api.github.com", @@ -638406,13 +638436,13 @@ } ], "previews": [], - "descriptionHTML": "

Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see \"Configuring Dependabot security updates\".

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see \"Configuring Dependabot security updates\".

" }, { "serverUrl": "https://api.github.com", @@ -702298,7 +702328,6 @@ } ], "previews": [], - "descriptionHTML": "

Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.

\n

By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the type parameter in your request, with the value malware. For more information about the different types of security advisories, see \"About the GitHub Advisory database.\"

", "statusCodes": [ { "httpStatusCode": "200", @@ -702312,7 +702341,8 @@ "httpStatusCode": "429", "description": "

Too many requests

" } - ] + ], + "descriptionHTML": "

Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware.

\n

By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the type parameter in your request, with the value malware. For more information about the different types of security advisories, see \"About the GitHub Advisory database.\"

" }, { "serverUrl": "https://api.github.com", @@ -728995,7 +729025,6 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", "statusCodes": [ { "httpStatusCode": "204", @@ -729005,7 +729034,8 @@ "httpStatusCode": "403", "description": "

Forbidden if the project is not owned by the organization

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
" }, { "serverUrl": "https://api.github.com", @@ -729074,13 +729104,13 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.

\n
" }, { "serverUrl": "https://api.github.com", @@ -748155,7 +748185,6 @@ } ], "previews": [], - "descriptionHTML": "

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

\n

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Note

\n

\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"

\n
\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.

\n
", "statusCodes": [ { "httpStatusCode": "204", @@ -748165,7 +748194,8 @@ "httpStatusCode": "403", "description": "

Forbidden if team synchronization is set up

" } - ] + ], + "descriptionHTML": "

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

\n

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Note

\n

\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"

\n
\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.

\n
" }, { "serverUrl": "https://api.github.com", @@ -749240,7 +749270,6 @@ } ], "previews": [], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.

\n
\n

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

\n

Note

\n

\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"

\n
\n

If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

\n

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

", "statusCodes": [ { "httpStatusCode": "200", @@ -749258,7 +749287,8 @@ "httpStatusCode": "422", "description": "

Unprocessable Entity if you attempt to add an organization to a team

" } - ] + ], + "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team membership for a user endpoint.

\n
\n

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.

\n

Note

\n

\nWhen you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"Synchronizing teams between your identity provider and GitHub Enterprise Cloud.\"

\n
\n

If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.

\n

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

" }, { "serverUrl": "https://api.github.com", diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index e2d914cc316f..8908764efa9f 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -1152,13 +1152,13 @@ } ], "previews": [], + "descriptionHTML": "

Sets the GitHub Actions cache usage policy for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Sets the GitHub Actions cache usage policy for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -1554,13 +1554,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets GitHub Actions cache usage policy for a repository.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets GitHub Actions cache usage policy for a repository.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -3021,13 +3021,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -3178,13 +3178,13 @@ } ], "previews": [], + "descriptionHTML": "

Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

OAuth app tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -4802,13 +4802,13 @@ } ], "previews": [], + "descriptionHTML": "

Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -5032,13 +5032,13 @@ } ], "previews": [], + "descriptionHTML": "

Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -5112,13 +5112,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -5375,13 +5375,13 @@ } ], "previews": [], + "descriptionHTML": "

Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.

\n

If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.

\n

If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -6066,13 +6066,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -6174,13 +6174,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -6290,13 +6290,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a single organization secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a single organization secret without revealing its encrypted value.

\n

The authenticated user must have collaborator access to a repository to create, update, or read secrets

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9238,13 +9238,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all self-hosted runner groups for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all self-hosted runner groups for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9421,13 +9421,13 @@ } ], "previews": [], + "descriptionHTML": "

Creates a new self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Creates a new self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -9784,13 +9784,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -10665,13 +10665,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the manage_runners:enterprise scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -12699,13 +12699,13 @@ } ], "previews": [], + "descriptionHTML": "

Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -13171,13 +13171,13 @@ } ], "previews": [], + "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an organization runner group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an organization runner group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -13319,13 +13319,13 @@ } ], "previews": [], + "descriptionHTML": "

Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] } ], "self-hosted-runners": [ @@ -17223,13 +17223,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all self-hosted runners configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all self-hosted runners configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -18657,13 +18657,13 @@ } ], "previews": [], + "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

Returns a token that you can pass to the config script. The token expires after one hour.

\n

For example, you can replace TOKEN in the following example with the registration token provided by this endpoint to configure your self-hosted runner:

\n
./config.sh --url https://github.com/octo-org --token TOKEN\n
\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -20404,6 +20404,7 @@ } ], "previews": [], + "descriptionHTML": "

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", @@ -20417,8 +20418,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.

\n

Authenticated users must have admin access to the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -24697,13 +24697,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all organization variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all organization variables.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -24803,13 +24803,13 @@ } ], "previews": [], + "descriptionHTML": "

Creates an organization variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Response when creating a variable

" } - ], - "descriptionHTML": "

Creates an organization variable that you can reference in a GitHub Actions workflow.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -24936,13 +24936,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific variable in an organization.

\n

The authenticated user must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific variable in an organization.

\n

The authenticated user must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -27029,13 +27029,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a repository variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a repository variable using the variable name.

\n

Authenticated users must have collaborator access to a repository to create, update, or read variables.

\n

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28108,13 +28108,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific job in a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific job in a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -32207,13 +32207,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

\n

This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

\n

This endpoint will return up to 1,000 results for each search when using the following parameters: actor, branch, check_suite_id, created, event, head_sha, status.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -63570,13 +63570,13 @@ } ], "previews": [], + "descriptionHTML": "

If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).

\n

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. Optional: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).

\n

Note

\n

\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.

\n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -104507,13 +104507,13 @@ } ], "previews": [], + "descriptionHTML": "

Revokes the installation token you're using to authenticate as an installation and access this endpoint.

\n

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"Create an installation access token for an app\" endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Revokes the installation token you're using to authenticate as an installation and access this endpoint.

\n

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"Create an installation access token for an app\" endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -107091,6 +107091,7 @@ } ], "previews": [], + "descriptionHTML": "

OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.

", "statusCodes": [ { "httpStatusCode": "204", @@ -107100,8 +107101,7 @@ "httpStatusCode": "422", "description": "

Validation failed, or the endpoint has been spammed.

" } - ], - "descriptionHTML": "

OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth access_token as an input parameter and the grant for the token's owner will be deleted.\nDeleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on the application authorizations settings screen within GitHub.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -157309,6 +157309,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an owner or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the security_events or repos cope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

", "statusCodes": [ { "httpStatusCode": "200", @@ -157322,8 +157323,7 @@ "httpStatusCode": "503", "description": "

Service unavailable

" } - ], - "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an owner or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the security_events or repos cope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -187793,13 +187793,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all secrets available in an organization without revealing their\nencrypted values.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -187877,13 +187877,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -203096,13 +203096,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -203159,13 +203159,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -203222,13 +203222,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -203658,13 +203658,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the statistics about security products for a GitHub Enterprise Server instance.

\n

To use this endpoint, you must be a site admin.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the statistics about security products for a GitHub Enterprise Server instance.

\n

To use this endpoint, you must be a site admin.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -204585,13 +204585,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the GitHub Advanced Security active committers for an enterprise per repository. The authenticated user must be an enterprise admin or billing manager.

\n

Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.

\n

The total number of repositories with committer information is tracked by the total_count field.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Success

" } - ], - "descriptionHTML": "

Gets the GitHub Advanced Security active committers for an enterprise per repository. The authenticated user must be an enterprise admin or billing manager.

\n

Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.

\n

The total number of repositories with committer information is tracked by the total_count field.

" + ] } ], "code-security-and-analysis": [ @@ -205035,13 +205035,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -205209,13 +205209,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -205602,13 +205602,13 @@ } ], "previews": [], + "descriptionHTML": "

This will trigger a ping event to be sent to the webhook.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

This will trigger a ping event to be sent to the webhook.

" + ] } ], "ldap": [ @@ -206253,13 +206253,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -207600,6 +207600,7 @@ } ], "previews": [], + "descriptionHTML": "

Check the status of the license that is currently set for the enterprise.

", "statusCodes": [ { "httpStatusCode": "200", @@ -207613,8 +207614,7 @@ "httpStatusCode": "500", "description": "

Internal error

" } - ], - "descriptionHTML": "

Check the status of the license that is currently set for the enterprise.

" + ] }, { "serverUrl": "http(s)://HOSTNAME", @@ -210469,13 +210469,13 @@ } ], "previews": [], + "descriptionHTML": "

List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -211446,13 +211446,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -212018,13 +212018,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -212614,13 +212614,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -212664,13 +212664,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "" + ] } ], "repo-pre-receive-hooks": [ @@ -218806,13 +218806,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -220159,13 +220159,13 @@ } ], "previews": [], + "descriptionHTML": "

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 update the LDAP mapping for the user.

\n

The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send \"octo_cat\" as the login, a user named \"octo-cat\" will be created.

\n

If the login name or email address is already associated with an account, the server will return a 422 response.

", "statusCodes": [ { "httpStatusCode": "201", "description": "

Created

" } - ], - "descriptionHTML": "

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 update the LDAP mapping for the user.

\n

The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send \"octo_cat\" as the login, a user named \"octo-cat\" will be created.

\n

If the login name or email address is already associated with an account, the server will return a 422 response.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -222444,13 +222444,13 @@ } ], "previews": [], + "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.

\n

You can suspend any user account except your own.

\n

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -239964,6 +239964,7 @@ } ], "previews": [], + "descriptionHTML": "

Get the content of a gitignore template.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", @@ -239973,8 +239974,7 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ], - "descriptionHTML": "

Get the content of a gitignore template.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" + ] } ] }, @@ -317368,13 +317368,13 @@ } ], "previews": [], + "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Get Hypermedia links to resources accessible in GitHub's REST API

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -340883,6 +340883,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -341141,6 +341151,16 @@ ] } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -341362,6 +341382,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -341588,6 +341618,16 @@ ] } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -341776,6 +341816,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -341856,16 +341906,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -342041,16 +342081,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -342425,13 +342455,13 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.

\n
\n

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

Response - list of custom role names

" } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in the future. Use the \"List custom repository roles\" endpoint instead.

\n
\n

List the custom repository roles available in this organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org or repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -343897,13 +343927,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -344894,6 +344924,7 @@ } ], "previews": [], + "descriptionHTML": "

In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

", "statusCodes": [ { "httpStatusCode": "200", @@ -344907,8 +344938,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -348543,13 +348573,13 @@ } ], "previews": [], + "descriptionHTML": "

Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Revokes all assigned organization roles from a user. For more information on organization roles, see \"Using organization roles.\"

\n

The authenticated user must be an administrator for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -349492,13 +349522,13 @@ } ], "previews": [], + "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Deletes a custom organization role. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To use this endpoint, the authenticated user must be one of:

\n\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -350229,6 +350259,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists organization members that are assigned to an organization role. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, you must be an administrator for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", @@ -350242,8 +350273,7 @@ "httpStatusCode": "422", "description": "

Response if the organization roles feature is not enabled or validation failed.

" } - ], - "descriptionHTML": "

Lists organization members that are assigned to an organization role. For more information on organization roles, see \"Using organization roles.\"

\n

To use this endpoint, you must be an administrator for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] } ], "outside-collaborators": [ @@ -357950,6 +357980,7 @@ } ], "previews": [], + "descriptionHTML": "

Create a repository ruleset for an organization.

", "statusCodes": [ { "httpStatusCode": "201", @@ -357963,8 +357994,7 @@ "httpStatusCode": "500", "description": "

Internal Error

" } - ], - "descriptionHTML": "

Create a repository ruleset for an organization.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -361521,13 +361551,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists teams that are security managers for an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists teams that are security managers for an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -369391,13 +369421,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -378513,13 +378543,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists builts of a GitHub Enterprise Server Pages site.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists builts of a GitHub Enterprise Server Pages site.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -433554,13 +433584,13 @@ } ], "previews": [], + "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a release.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a release.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -440661,13 +440691,13 @@ } ], "previews": [], + "descriptionHTML": "

Users with push access to the repository can edit a release asset.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Users with push access to the repository can edit a release asset.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -460193,6 +460223,7 @@ } ], "previews": [], + "descriptionHTML": "

Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".

", "statusCodes": [ { "httpStatusCode": "204", @@ -460202,8 +460233,7 @@ "httpStatusCode": "404", "description": "

Not Found if repository is not enabled with vulnerability alerts

" } - ], - "descriptionHTML": "

Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -477387,13 +477417,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.

\n

Note

\n

\nFor private repositories, these links are temporary and expire after five minutes.

\n
", "statusCodes": [ { "httpStatusCode": "302", "description": "

Found

" } - ], - "descriptionHTML": "

Gets a redirect URL to download a tar archive for a repository. If you omit :ref, the repository’s default branch (usually\nmain) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe Location header to make a second GET request.

\n

Note

\n

\nFor private repositories, these links are temporary and expire after five minutes.

\n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -493506,13 +493536,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"

\n

OAuth app tokens and personal access tokens (classic) need the write:repo_hook or repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Updates the webhook configuration for a repository. To update more information about the webhook, including the active state and events, use \"Update a repository webhook.\"

\n

OAuth app tokens and personal access tokens (classic) need the write:repo_hook or repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -505976,6 +506006,7 @@ } ], "previews": [], + "descriptionHTML": "

Gets a single secret scanning alert detected in an eligible repository.

\n

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

", "statusCodes": [ { "httpStatusCode": "200", @@ -505993,8 +506024,7 @@ "httpStatusCode": "503", "description": "

Service unavailable

" } - ], - "descriptionHTML": "

Gets a single secret scanning alert detected in an eligible repository.

\n

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -513175,6 +513205,7 @@ } ], "previews": [], + "descriptionHTML": "

Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.

\n
", "statusCodes": [ { "httpStatusCode": "200", @@ -513184,8 +513215,7 @@ "httpStatusCode": "404", "description": "

Not Found if project is not managed by this team

" } - ], - "descriptionHTML": "

Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.

\n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -514365,13 +514395,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists a team's repositories visible to the authenticated user.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.

\n
", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists a team's repositories visible to the authenticated user.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.

\n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -527907,13 +527937,13 @@ } ], "previews": [], + "descriptionHTML": "

Get a specific discussion on a team's page.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Get a specific discussion on a team's page.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the read:discussion scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -530503,13 +530533,13 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.

\n
\n

Delete a discussion from a team's page.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Warning

\n

\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Delete a discussion endpoint.

\n
\n

Delete a discussion from a team's page.

\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" + ] } ], "external-groups": [ @@ -536185,6 +536215,7 @@ } ], "previews": [], + "descriptionHTML": "

Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.

\n

Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.

", "statusCodes": [ { "httpStatusCode": "200", @@ -536194,8 +536225,7 @@ "httpStatusCode": "304", "description": "

Not modified

" } - ], - "descriptionHTML": "

Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.

\n

Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of users.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json index 506976bf4c12..a7f0d93d6364 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json @@ -344212,6 +344212,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -344470,6 +344480,16 @@ ] } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -344691,6 +344711,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -344917,6 +344947,16 @@ ] } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -345105,6 +345145,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -345185,16 +345235,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -345370,16 +345410,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json index 30860e0034d5..64ba5f1ccc41 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json @@ -1468,13 +1468,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets GitHub Actions cache usage for a repository.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -3503,13 +3503,13 @@ } ], "previews": [], + "descriptionHTML": "

Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

\n

If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

\n

If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -5112,13 +5112,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -28144,13 +28144,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific job in a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific job in a workflow run.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -39393,13 +39393,13 @@ } ], "previews": [], + "descriptionHTML": "

Get all deployment environments for a workflow run that are waiting for protection rules to pass.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Get all deployment environments for a workflow run that are waiting for protection rules to pass.

\n

Anyone with read access to the repository can use this endpoint.

\n

If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -91999,13 +91999,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists repositories a user is watching.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists repositories a user is watching.

" + ] } ] }, @@ -126397,13 +126397,13 @@ } ], "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -131025,13 +131025,13 @@ } ], "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -132163,13 +132163,13 @@ } ], "previews": [], + "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Disables the ability to restrict who can push to this branch.

", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

\n

Disables the ability to restrict who can push to this branch.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -184842,13 +184842,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the commit comments for a specified repository. Comments are ordered by ascending ID.

\n

This endpoint supports the following custom media types. For more information, see \"Media types.\"

\n" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -196052,13 +196052,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a single organization secret without revealing its encrypted value.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a single organization secret without revealing its encrypted value.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -197256,13 +197256,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists all repositories that have been selected when the visibility\nfor repository access to a secret is set to selected.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -202384,13 +202384,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the deployment branch policies for an environment.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the deployment branch policies for an environment.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -203790,13 +203790,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the environments for a repository.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the environments for a repository.

\n

Anyone with read access to the repository can use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -211402,13 +211402,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -219132,13 +219132,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "202", "description": "

Accepted

" } - ], - "descriptionHTML": "" + ] } ], "pre-receive-environments": [ @@ -220510,13 +220510,13 @@ } ], "previews": [], + "descriptionHTML": "", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -349567,6 +349567,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -349825,6 +349835,16 @@ ] } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -350046,6 +350066,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -350272,6 +350302,16 @@ ] } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -350460,6 +350500,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -350540,16 +350590,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -350725,16 +350765,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default", @@ -370759,13 +370789,13 @@ } ], "previews": [], + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.

\n
", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed in Enterprise Server 3.20. Please use the \"Organization Roles\" endpoints instead.

\n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -372107,13 +372137,13 @@ } ], "previews": [], + "descriptionHTML": "

Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"

\n

You must be an organization owner to use this endpoint.

\n

OAuth app tokens and personal access tokens (classic) need admin:org_hook scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -386431,13 +386461,13 @@ } ], "previews": [], + "descriptionHTML": "

Gets a specific package version for a public package owned by a specified user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Gets a specific package version for a public package owned by a specified user.

\n

OAuth app tokens and personal access tokens (classic) need the read:packages scope to use this endpoint. For more information, see \"About permissions for GitHub Packages.\"

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -524894,13 +524924,13 @@ } ], "previews": [], + "descriptionHTML": "

To delete a team, the authenticated user must be an organization owner or team maintainer.

\n

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.

\n
", "statusCodes": [ { "httpStatusCode": "204", "description": "

No Content

" } - ], - "descriptionHTML": "

To delete a team, the authenticated user must be an organization owner or team maintainer.

\n

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.

\n
" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -536949,13 +536979,13 @@ } ], "previews": [], + "descriptionHTML": "

Edits the body text of a discussion comment.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Edits the body text of a discussion comment.

\n

Note

\n

\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

\n
\n

OAuth app tokens and personal access tokens (classic) need the write:discussion scope to use this endpoint.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -543534,13 +543564,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists a connection between a team and an external group.

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists a connection between a team and an external group.

\n

You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"GitHub's products\" in the GitHub Help documentation.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -548437,6 +548467,7 @@ } ], "previews": [], + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

", "statusCodes": [ { "httpStatusCode": "200", @@ -548446,8 +548477,7 @@ "httpStatusCode": "404", "description": "

Resource not found

" } - ], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account. This method takes their durable user ID instead of their login, which can change over time.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

\n

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see Emails API.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", @@ -551901,13 +551931,13 @@ } ], "previews": [], + "descriptionHTML": "

Lists the people who the specified user follows.

", "statusCodes": [ { "httpStatusCode": "200", "description": "

OK

" } - ], - "descriptionHTML": "

Lists the people who the specified user follows.

" + ] }, { "serverUrl": "http(s)://HOSTNAME/api/v3", diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json index abad0b0f4928..158d759f5a3b 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json @@ -350950,6 +350950,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -351208,6 +351218,16 @@ ] } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -351429,6 +351449,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "read" + } + ] + }, "codeExamples": [ { "key": "default", @@ -351655,6 +351685,16 @@ ] } ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -351843,6 +351883,16 @@ } ], "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" organization permissions": "admin" + } + ] + }, "codeExamples": [ { "key": "default", @@ -351923,16 +351973,6 @@ } ], "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "read" - } - ] - }, "codeExamples": [ { "key": "default", @@ -352108,16 +352148,6 @@ ] } ], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" organization permissions": "write" - } - ] - }, "codeExamples": [ { "key": "default",