diff --git a/.github/agents/ghes-release-notes.md b/.github/agents/ghes-release-notes.md new file mode 100644 index 000000000000..27f0ab761fc3 --- /dev/null +++ b/.github/agents/ghes-release-notes.md @@ -0,0 +1,163 @@ +--- + +name: "GHES-Release-Notes" +description: "Generates release notes for GitHub Enterprise Server features from releases issues or changelog PRs." +tools: ['read', 'search', 'web', 'github/*'] + +--- + +# GHES Release Notes Agent + +You are a technical writer crafting release notes for GitHub Enterprise Server (GHES). Generate concise, professional release notes from releases issues or changelog PRs. + +## Workflow + +1. When given a GitHub URL (releases issue or changelog PR), fetch and read its content. +2. Read `data/release-notes/PLACEHOLDER-TEMPLATE.yml` to get the valid heading values under `sections.features`. +3. Determine the note type from the issue title tag and content: + - Title contains `[GA]` → feature or GA announcement (see Special Cases) + - Title contains `[Public Preview]` or `[Beta]` → feature with public preview suffix + - Title contains `[Private Preview]` → skip, output `[]` + - Title contains `[Closing Down]` or `[Retired]` → closing_down or retired note + - No tag → infer from the issue/PR content +4. Write a release note following the style guide below. +5. Output as a YAML code block. + +## Input Sources + +Accept one or both of: +- **Releases issue**: `https://github.com/github/releases/issues/{number}` +- **Changelog PR**: `https://github.com/github/blog/pull/{number}` + +When both are provided, use both sources to gather complete context—the releases issue typically has technical details while the changelog PR has user-facing messaging. + +Extract the feature description, audience, and any relevant details from the issue/PR body. + +## Output Format + +```yaml +- heading: [HEADING] + notes: + # [Source URL] + - | + [NOTE CONTENT] +``` + +For **feature** notes, only use headings from `data/release-notes/PLACEHOLDER-TEMPLATE.yml` under `sections.features`. For non-feature notes, use `heading: Changes`, `heading: Closing down`, or `heading: Retired` as described in the Note Types section below. + +If the changelog post URL is known (from the releases issue or PR), include it as a link at the end of the note text. Use the **published blog URL** format (not the PR URL): +- `[Changelog](https://github.blog/changelog/YYYY-MM-DD-feature-name/)` — extract this from the PR body or title +- If only the PR URL is available and you can't determine the published URL, use `[Changelog](PR-URL)` as a fallback + +## Docs Conventions + +### Internal Links +Use `[AUTOTITLE](/path)` for links to docs.github.com articles. Never hardcode article titles in link text. +- If the source issue contains a `docs.github.com` URL (e.g., `https://docs.github.com/en/code-security/dependabot/...#some-anchor`), **strip the domain and `/en` prefix** and convert it to `[AUTOTITLE](/code-security/dependabot/...)` format. Do NOT copy `docs.github.com` URLs verbatim — anchor fragments in source issues are often stale. +- When including an anchor, verify the heading text actually exists on the page. If you can't verify it, link to the page without the anchor. +- Correct: `For more information, see [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics).` +- Incorrect: `For more information, see [OpenTelemetry metrics](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/opentelemetry-metrics).` +- Incorrect: `For more information, see [AUTOTITLE](https://docs.github.com/en/admin/monitoring-and-managing-your-instance).` + +### Liquid Variables +Use `{% data variables %}` syntax for product names. Common variables: +- `{% data variables.product.prodname_ghe_server %}` → GitHub Enterprise Server +- `{% data variables.product.prodname_copilot %}` → GitHub Copilot +- `{% data variables.product.prodname_copilot_short %}` → Copilot +- `{% data variables.product.prodname_codeql %}` → CodeQL +- `{% data variables.product.prodname_code_scanning %}` → code scanning +- `{% data variables.product.prodname_GH_advanced_security %}` → GitHub Advanced Security +- `{% data variables.product.prodname_actions %}` → GitHub Actions +- `{% data variables.product.prodname_dependabot %}` → Dependabot + +Check `data/variables/product.yml` for the full list. Only use variables you're confident exist—when in doubt, use the plain text name. + +**Important**: `{% data variables.product.product_name %}` does NOT exist. Use `{% data variables.product.prodname_dotcom %}` for "GitHub" or `{% data variables.product.prodname_ghe_server %}` for "GitHub Enterprise Server". + +### Terminology +- Never use the word "deprecated." GitHub uses "closing down" instead. + - Correct: "Support for Kotlin 1.6 is closing down." + - Incorrect: "Support for Kotlin 1.6 is deprecated." + +### Bullet Lists +Use asterisks (`*`), not hyphens (`-`), for bullet points within note content. + +## Note Types & Structure + +### Features (new functionality) +**Pattern**: [AUDIENCE] can [NEED/BENEFIT] by [FEATURE DESCRIPTION]. + +Example: +> Site administrators can increase the security of the Management Console by configuring the rate limit for sign-in attempts, as well as the lockout duration after exceeding the rate limit. + +### Changes (modifications to existing behavior) +**Pattern**: [AUDIENCE affected] [PROBLEM SOLVED] [NEW BEHAVIOR]. [OLD BEHAVIOR if relevant]. + +Goes in the `changes` section (not under a feature heading). + +Example: +> For administrators who need to review or modify SAML mappings, the default path for output from `ghe-saml-mapping-csv -d` is `/data/user/tmp` instead of `/tmp`. + +### Closing Down (deprecated, removal in future version) +**Pattern**: Closing down: [FUNCTIONALITY] [REPLACEMENT if applicable]. + +Use `heading: Closing down`. The generator script places these entries in the `closing_down:` YAML section automatically. + +Example: +> Closing down: In GitHub Enterprise Server 3.8 and later, to ensure instance security, unsecure algorithms will be disabled for SSH connections to the administrative shell. + +### Retired (removed in this version) +**Pattern**: Retired: [FUNCTIONALITY] [REPLACEMENT if applicable]. + +Goes in the `retired` section. Use heading `Retired`. + +Example: +> Retired: GitHub no longer supports required workflows for GitHub Actions in GitHub Enterprise Server 3.11 and later. Use repository rulesets instead. + +## Style Rules + +- **Length**: Concise but complete. Most notes are 1-3 sentences. Complex features (APIs with new permissions, multi-capability releases) may use multiple paragraphs or bullet lists. +- **Tense**: Present tense. +- **Voice**: Active voice. Avoid passive constructions. +- **Focus**: Describe the new behavior. Only mention old behavior when it helps clarify the change. +- **Audience**: Primary readers are site administrators and developers. +- **Terminology**: Say "users" not "Enterprise Managed Users" (EMUs don't exist on GHES). +- **Accuracy**: Only include facts from the source. No speculation. +- **Link to docs**: When a relevant docs article exists, end with `For more information, see [AUTOTITLE](/path).` + +## Special Cases + +### GA Announcements +If the issue title contains `[GA]` or the feature is described as "generally available," determine from context whether it was previously in preview on GHES or is brand new to GHES. Do NOT ask the user—decide based on the issue/PR content. + +- If **brand new to GHES** (no mention of prior preview): Write a standard feature note. +- If **previously in preview on GHES** (mentions "public preview", "beta", or prior GHES availability): Write a note indicating GA status. Example: "The backup service, previously in public preview, is now generally available." +- If **unclear**: Default to a standard feature note. + +### Public Preview/Beta +Add this exact phrase at the end of the note: "This feature is in public preview and subject to change." + +### Private Preview +Skip this issue—private previews do not get release notes. Return an empty array with a SKIP comment: +```yaml +# SKIP: Private preview — no GHES release notes needed +[] +``` + +### No Release Notes Needed +If the issue comments or context indicate the feature doesn't need GHES release notes (e.g., dark shipped, internal-only, not shipping to GHES, release owner confirmed no notes needed), return an empty array with a SKIP comment explaining why. Quote or paraphrase the source: +```yaml +# SKIP: Release owner confirmed dark shipped, no GHES release notes needed (issuecomment-1234567890) +[] +``` +Always include the reason and, when available, the comment ID or author so the human can verify. + +### Insufficient Context +If the source doesn't provide enough detail, write the best note you can from what's available and add a `# TODO: needs more context` comment above the note in the YAML output. + +## Non-Interactive Mode + +When invoked programmatically (e.g., via Copilot CLI with `-p`), you MUST: +- Never ask follow-up questions. Make your best judgment from the available context. +- Always return a YAML code block, even if incomplete. +- Never return conversational text without a YAML block. diff --git a/.github/workflows/validate-openapi-check.yml b/.github/workflows/validate-openapi-check.yml index fbfb0d5a0f05..d258207e2351 100644 --- a/.github/workflows/validate-openapi-check.yml +++ b/.github/workflows/validate-openapi-check.yml @@ -12,7 +12,7 @@ on: - 'src/rest/scripts/openapi-check.ts' - 'src/rest/scripts/utils/get-operations.ts' - 'src/rest/scripts/utils/operation.ts' - # In case dependencies change + - 'src/rest/fixtures/openapi-check-fixture.json' - 'package.json' - 'package-lock.json' - 'tsconfig.json' @@ -39,10 +39,10 @@ jobs: - name: Test Docker image with sample OpenAPI file run: | - docker run --rm openapi-decorator:test -f "src/rest/data/fpt-2022-11-28/schema.json" + docker run --rm openapi-decorator:test -f "src/rest/fixtures/openapi-check-fixture.json" - name: Test Docker image with multiple OpenAPI files run: | docker run --rm openapi-decorator:test \ - -f "src/rest/data/fpt-2022-11-28/schema.json" \ - "src/rest/data/ghec-2022-11-28/schema.json" + -f "src/rest/fixtures/openapi-check-fixture.json" \ + "src/rest/fixtures/openapi-check-fixture.json" diff --git a/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/exporting-data-from-security-overview.md b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/exporting-data-from-security-overview.md index e8777f4a8436..f729c9c615e6 100644 --- a/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/exporting-data-from-security-overview.md +++ b/content/code-security/how-tos/view-and-interpret-data/analyze-organization-data/exporting-data-from-security-overview.md @@ -26,7 +26,7 @@ The CSV file you download will contain data corresponding to the filters you hav {% data reusables.profile.access_org %} 1. In the "Organizations" section, select the organization for which you would like to download security overview data. {% data reusables.organizations.security-overview %} -1. In the sidebar, click **{% octicon "graph" aria-hidden="true" aria-label="graph" %} Overview**, **{% octicon "meter" aria-hidden="true" aria-label="meter" %} Coverage**, **{% octicon "shield" aria-hidden="true" aria-label="shield" %} Risk**, or **{% octicon "graph" aria-hidden="true" aria-label="graph" %} {% data variables.product.prodname_codeql %} pull requests**. +1. In the sidebar, click **{% octicon "graph" aria-hidden="true" aria-label="graph" %} Overview**, **{% octicon "meter" aria-hidden="true" aria-label="meter" %} Coverage**, **{% octicon "shield" aria-hidden="true" aria-label="shield" %} Risk**, or **{% octicon "graph" aria-hidden="true" aria-label="graph" %} {% data variables.product.prodname_codeql %} pull requests**. 1. Next to the search bar, click **{% octicon "download" aria-hidden="true" aria-label="download" %} Export CSV**. It may take a moment for {% data variables.product.github %} to generate the CSV file of your data. Once the CSV file generates, the file will automatically start downloading, and a banner will appear confirming your report is ready. If you are downloading the CSV from the overview page, you will also receive an email when your report is ready, containing a link to download the CSV. diff --git a/content/code-security/reference/supply-chain-security/dependabot-options-reference.md b/content/code-security/reference/supply-chain-security/dependabot-options-reference.md index 3d2154b0d3f5..6856ef38fc2a 100644 --- a/content/code-security/reference/supply-chain-security/dependabot-options-reference.md +++ b/content/code-security/reference/supply-chain-security/dependabot-options-reference.md @@ -31,7 +31,7 @@ All options marked with a {% octicon "shield-check" aria-label="Security updates | `updates` | Top level| Section where you define each `package-ecosystem` to update.| | [`package-ecosystem`](#package-ecosystem-) | Under `updates` | Define a package manager to update. | | [`directories` or `directory`](#directories-or-directory--) | Under each `package-ecosystem` entry | Define the location of the manifest or other definition files to update. | -| [`schedule.interval`](#schedule-) | Under each `package-ecosystem` entry | Define whether to look for version updates: `daily`, `weekly`, or `monthly`. | +| [`schedule.interval`](#schedule-) | Under each `package-ecosystem` entry | Define whether to look for version updates: `daily`, `weekly`, `monthly`{% ifversion fpt or ghes > 3.18 %}, `quarterly`, `semiannually`, `yearly`, or `cron`{% endif %}. | Optionally, you can also include a top-level `registries` key to define access details for private registries, see [Top-level `registries` key](#top-level-registries-key). diff --git a/content/code-security/tutorials/secure-your-organization/prioritize-alerts-in-production-code.md b/content/code-security/tutorials/secure-your-organization/prioritize-alerts-in-production-code.md index 2f4d9debf886..f4e6b0497b7e 100644 --- a/content/code-security/tutorials/secure-your-organization/prioritize-alerts-in-production-code.md +++ b/content/code-security/tutorials/secure-your-organization/prioritize-alerts-in-production-code.md @@ -31,7 +31,7 @@ For more information on updating records, see [AUTOTITLE](/code-security/how-tos ## 2. Use production context filters -Production context filters are made available in the **{% data variables.product.prodname_security_and_quality_tab %}** tab. +Production context filters are made available in the **{% data variables.product.prodname_security_and_quality_tab %}** tab. * **{% data variables.product.prodname_dependabot %} view**: See [AUTOTITLE](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts#viewing-dependabot-alerts). * **{% data variables.product.prodname_code_scanning_caps %} view**: See [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository). diff --git a/eslint.config.ts b/eslint.config.ts index 8d95bc75dcab..5010779df4fe 100644 --- a/eslint.config.ts +++ b/eslint.config.ts @@ -219,46 +219,30 @@ export default [ 'src/content-linter/tests/lint-frontmatter-links.ts', 'src/content-linter/tests/unit/table-column-integrity-simple.ts', 'src/content-render/liquid/engine.ts', - 'src/content-render/liquid/ifversion.ts', - 'src/content-render/liquid/indented-data-reference.ts', 'src/content-render/liquid/index.ts', - 'src/content-render/liquid/octicon.ts', - 'src/content-render/scripts/add-content-type.ts', 'src/content-render/scripts/liquid-tags.ts', - 'src/content-render/scripts/move-by-content-type.ts', 'src/content-render/scripts/move-content.ts', - 'src/content-render/tests/data.ts', 'src/content-render/tests/link-error-line-numbers.ts', 'src/content-render/unified/annotate.ts', 'src/content-render/unified/index.ts', - 'src/content-render/unified/module-types.d.ts', - 'src/content-render/unified/rewrite-local-links.ts', 'src/data-directory/lib/get-data.ts', 'src/early-access/scripts/migrate-early-access-product.ts', - 'src/early-access/scripts/what-docs-early-access-branch.ts', 'src/fixtures/tests/categories-and-subcategory.ts', 'src/fixtures/tests/guides.ts', 'src/fixtures/tests/translations.ts', - 'src/frame/components/context/ArticleContext.tsx', - 'src/frame/components/context/CategoryLandingContext.tsx', 'src/frame/components/context/MainContext.tsx', - 'src/frame/components/context/TocLandingContext.tsx', 'src/frame/lib/create-tree.ts', 'src/frame/lib/frontmatter.ts', 'src/frame/lib/page-data.ts', 'src/frame/lib/page.ts', - 'src/frame/lib/read-frontmatter.ts', 'src/frame/tests/page.ts', - 'src/frame/tests/read-frontmatter.ts', 'src/frame/tests/server.ts', - 'src/ghes-releases/scripts/deprecate/update-content.ts', 'src/github-apps/lib/index.ts', 'src/graphql/lib/index.ts', 'src/graphql/pages/reference.tsx', 'src/graphql/scripts/utils/process-schemas.ts', 'src/graphql/scripts/utils/schema-helpers.ts', 'src/graphql/tests/validate-schema.ts', - 'src/journeys/lib/journey-path-resolver.ts', 'src/landings/components/CookBookFilter.tsx', 'src/landings/components/ProductGuidesContext.tsx', 'src/landings/components/ProductLandingContext.tsx', @@ -271,7 +255,6 @@ export default [ 'src/links/lib/update-internal-links.ts', 'src/links/scripts/check-github-github-links.ts', 'src/links/scripts/update-internal-links.ts', - 'src/redirects/middleware/handle-redirects.ts', 'src/rest/components/get-rest-code-samples.ts', 'src/rest/lib/index.ts', 'src/rest/pages/category.tsx', @@ -307,7 +290,6 @@ export default [ 'src/types/markdownlint-rule-helpers.d.ts', 'src/types/markdownlint-rule-search-replace.d.ts', 'src/types/primer__octicons.d.ts', - 'src/versions/scripts/use-short-versions.ts', 'src/workflows/projects.ts', ], rules: { diff --git a/package-lock.json b/package-lock.json index 99bf7fa97ae2..796210bc4366 100644 --- a/package-lock.json +++ b/package-lock.json @@ -66,8 +66,8 @@ "js-cookie": "^3.0.5", "js-yaml": "^4.1.1", "liquidjs": "^10.25.0", - "lodash": "^4.17.23", - "lodash-es": "^4.17.23", + "lodash": "^4.18.0", + "lodash-es": "^4.18.0", "lowdb": "7.0.1", "lowlight": "^3.3.0", "markdownlint-rule-helpers": "^0.25.0", @@ -803,6 +803,13 @@ "node": ">=18" } }, + "node_modules/@elastic/elasticsearch/src/search/lib/apache-arrow-stub": { + "extraneous": true + }, + "node_modules/@elastic/elasticsearch/src/search/vendor/apache-arrow-stub": {}, + "node_modules/@elastic/elasticsearch/vendor/apache-arrow-stub": { + "extraneous": true + }, "node_modules/@elastic/transport": { "version": "8.10.1", "resolved": "https://registry.npmjs.org/@elastic/transport/-/transport-8.10.1.tgz", @@ -6488,18 +6495,6 @@ "assertion-error": "^2.0.1" } }, - "node_modules/@types/command-line-args": { - "version": "5.2.3", - "resolved": "https://registry.npmjs.org/@types/command-line-args/-/command-line-args-5.2.3.tgz", - "integrity": "sha512-uv0aG6R0Y8WHZLTamZwtfsDLVRnOa+n+n5rEvFWL5Na5gZ8V2Teab/duDPFzIIIhs9qizDpcavCusCLJZu62Kw==", - "license": "MIT" - }, - "node_modules/@types/command-line-usage": { - "version": "5.0.4", - "resolved": "https://registry.npmjs.org/@types/command-line-usage/-/command-line-usage-5.0.4.tgz", - "integrity": "sha512-BwR5KP3Es/CSht0xqBcUXS3qCAUVXwpRKsV2+arxeb65atasuXG9LykC9Ab10Cw3s2raH92ZqOeILaQbsB2ACg==", - "license": "MIT" - }, "node_modules/@types/connect": { "version": "3.4.38", "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz", @@ -7789,24 +7784,8 @@ } }, "node_modules/apache-arrow": { - "version": "21.1.0", - "resolved": "https://registry.npmjs.org/apache-arrow/-/apache-arrow-21.1.0.tgz", - "integrity": "sha512-kQrYLxhC+NTVVZ4CCzGF6L/uPVOzJmD1T3XgbiUnP7oTeVFOFgEUu6IKNwCDkpFoBVqDKQivlX4RUFqqnWFlEA==", - "license": "Apache-2.0", - "dependencies": { - "@swc/helpers": "^0.5.11", - "@types/command-line-args": "^5.2.3", - "@types/command-line-usage": "^5.0.4", - "@types/node": "^24.0.3", - "command-line-args": "^6.0.1", - "command-line-usage": "^7.0.1", - "flatbuffers": "^25.1.24", - "json-bignum": "^0.0.3", - "tslib": "^2.6.2" - }, - "bin": { - "arrow2csv": "bin/arrow2csv.js" - } + "resolved": "node_modules/@elastic/elasticsearch/src/search/vendor/apache-arrow-stub", + "link": true }, "node_modules/arg": { "version": "5.0.2", @@ -7827,15 +7806,6 @@ "node": ">= 0.4" } }, - "node_modules/array-back": { - "version": "6.2.2", - "resolved": "https://registry.npmjs.org/array-back/-/array-back-6.2.2.tgz", - "integrity": "sha512-gUAZ7HPyb4SJczXAMUXMGAvI976JoK3qEx9v1FTmeYuJj0IBiaKttG1ydtGKdkfqWkIkouke7nG8ufGy77+Cvw==", - "license": "MIT", - "engines": { - "node": ">=12.17" - } - }, "node_modules/array-buffer-byte-length": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/array-buffer-byte-length/-/array-buffer-byte-length-1.0.2.tgz", @@ -8462,37 +8432,6 @@ "url": "https://github.com/chalk/chalk?sponsor=1" } }, - "node_modules/chalk-template": { - "version": "0.4.0", - "resolved": "https://registry.npmjs.org/chalk-template/-/chalk-template-0.4.0.tgz", - "integrity": "sha512-/ghrgmhfY8RaSdeo43hNXxpoHAtxdbskUHjPpfqUWGttFgycUhYPGx3YZBCnUCvOa7Doivn1IZec3DEGFoMgLg==", - "license": "MIT", - "dependencies": { - "chalk": "^4.1.2" - }, - "engines": { - "node": ">=12" - }, - "funding": { - "url": "https://github.com/chalk/chalk-template?sponsor=1" - } - }, - "node_modules/chalk-template/node_modules/chalk": { - "version": "4.1.2", - "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", - "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", - "license": "MIT", - "dependencies": { - "ansi-styles": "^4.1.0", - "supports-color": "^7.1.0" - }, - "engines": { - "node": ">=10" - }, - "funding": { - "url": "https://github.com/chalk/chalk?sponsor=1" - } - }, "node_modules/change-case": { "version": "5.4.4", "resolved": "https://registry.npmjs.org/change-case/-/change-case-5.4.4.tgz", @@ -8888,44 +8827,6 @@ "url": "https://github.com/sponsors/wooorm" } }, - "node_modules/command-line-args": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/command-line-args/-/command-line-args-6.0.1.tgz", - "integrity": "sha512-Jr3eByUjqyK0qd8W0SGFW1nZwqCaNCtbXjRo2cRJC1OYxWl3MZ5t1US3jq+cO4sPavqgw4l9BMGX0CBe+trepg==", - "license": "MIT", - "dependencies": { - "array-back": "^6.2.2", - "find-replace": "^5.0.2", - "lodash.camelcase": "^4.3.0", - "typical": "^7.2.0" - }, - "engines": { - "node": ">=12.20" - }, - "peerDependencies": { - "@75lb/nature": "latest" - }, - "peerDependenciesMeta": { - "@75lb/nature": { - "optional": true - } - } - }, - "node_modules/command-line-usage": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/command-line-usage/-/command-line-usage-7.0.3.tgz", - "integrity": "sha512-PqMLy5+YGwhMh1wS04mVG44oqDsgyLRSKJBdOo1bnYhMKBW65gZF1dRp2OZRhiTjgUHljy99qkO7bsctLaw35Q==", - "license": "MIT", - "dependencies": { - "array-back": "^6.2.2", - "chalk-template": "^0.4.0", - "table-layout": "^4.1.0", - "typical": "^7.1.1" - }, - "engines": { - "node": ">=12.20.0" - } - }, "node_modules/commander": { "version": "14.0.3", "resolved": "https://registry.npmjs.org/commander/-/commander-14.0.3.tgz", @@ -11023,23 +10924,6 @@ "node": ">= 0.8" } }, - "node_modules/find-replace": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/find-replace/-/find-replace-5.0.2.tgz", - "integrity": "sha512-Y45BAiE3mz2QsrN2fb5QEtO4qb44NcS7en/0y9PEVsg351HsLeVclP8QPMH79Le9sH3rs5RSwJu99W0WPZO43Q==", - "license": "MIT", - "engines": { - "node": ">=14" - }, - "peerDependencies": { - "@75lb/nature": "latest" - }, - "peerDependenciesMeta": { - "@75lb/nature": { - "optional": true - } - } - }, "node_modules/find-yarn-workspace-root": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/find-yarn-workspace-root/-/find-yarn-workspace-root-2.0.0.tgz", @@ -11075,12 +10959,6 @@ "node": ">=16" } }, - "node_modules/flatbuffers": { - "version": "25.9.23", - "resolved": "https://registry.npmjs.org/flatbuffers/-/flatbuffers-25.9.23.tgz", - "integrity": "sha512-MI1qs7Lo4Syw0EOzUl0xjs2lsoeqFku44KpngfIduHBYvzm8h2+7K8YMQh1JtVVVrUvhLpNwqVi4DERegUJhPQ==", - "license": "Apache-2.0" - }, "node_modules/flatted": { "version": "3.3.3", "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.3.3.tgz", @@ -11510,6 +11388,7 @@ }, "node_modules/has-flag": { "version": "4.0.0", + "dev": true, "license": "MIT", "engines": { "node": ">=8" @@ -12931,14 +12810,6 @@ "bignumber.js": "^9.0.0" } }, - "node_modules/json-bignum": { - "version": "0.0.3", - "resolved": "https://registry.npmjs.org/json-bignum/-/json-bignum-0.0.3.tgz", - "integrity": "sha512-2WHyXj3OfHSgNyuzDbSxI1w2jgw5gkWSWhS7Qg4bWXx1nLk3jnbwfUeS0PSba3IzpTUWdHxBieELUzXRjQB2zg==", - "engines": { - "node": ">=0.8" - } - }, "node_modules/json-buffer": { "version": "3.0.1", "dev": true, @@ -13244,15 +13115,15 @@ "license": "MIT" }, "node_modules/lodash": { - "version": "4.17.23", - "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.23.tgz", - "integrity": "sha512-LgVTMpQtIopCi79SJeDiP0TfWi5CNEc/L/aRdTh3yIvmZXTnheWpKjSZhnvMl8iXbC1tFg9gdHHDMLoV7CnG+w==", + "version": "4.18.1", + "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.18.1.tgz", + "integrity": "sha512-dMInicTPVE8d1e5otfwmmjlxkZoUpiVLwyeTdUsi/Caj/gfzzblBcCE5sRHV/AsjuCmxWrte2TNGSYuCeCq+0Q==", "license": "MIT" }, "node_modules/lodash-es": { - "version": "4.17.23", - "resolved": "https://registry.npmjs.org/lodash-es/-/lodash-es-4.17.23.tgz", - "integrity": "sha512-kVI48u3PZr38HdYz98UmfPnXl2DXrpdctLrFLCd3kOx1xUkOmpFPx7gCWWM5MPkL/fD8zb+Ph0QzjGFs4+hHWg==", + "version": "4.18.1", + "resolved": "https://registry.npmjs.org/lodash-es/-/lodash-es-4.18.1.tgz", + "integrity": "sha512-J8xewKD/Gk22OZbhpOVSwcs60zhd95ESDwezOFuA3/099925PdHJ7OFHNTGtajL3AlZkykD32HykiMo+BIBI8A==", "license": "MIT" }, "node_modules/lodash.camelcase": { @@ -15841,12 +15712,13 @@ } }, "node_modules/path-to-regexp": { - "version": "8.2.0", - "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-8.2.0.tgz", - "integrity": "sha512-TdrF7fW9Rphjq4RjrW0Kp2AW0Ahwu9sRGTkS6bvDi0SCwZlEZYmcfDbEsTz8RVk0EHIS/Vd1bv3JhG+1xZuAyQ==", + "version": "8.4.2", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-8.4.2.tgz", + "integrity": "sha512-qRcuIdP69NPm4qbACK+aDogI5CBDMi1jKe0ry5rSQJz8JVLsC7jV8XpiJjGRLLol3N+R5ihGYcrPLTno6pAdBA==", "license": "MIT", - "engines": { - "node": ">=16" + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" } }, "node_modules/pathe": { @@ -17842,6 +17714,7 @@ }, "node_modules/supports-color": { "version": "7.2.0", + "dev": true, "license": "MIT", "dependencies": { "has-flag": "^4.0.0" @@ -17903,19 +17776,6 @@ "url": "https://opencollective.com/synckit" } }, - "node_modules/table-layout": { - "version": "4.1.1", - "resolved": "https://registry.npmjs.org/table-layout/-/table-layout-4.1.1.tgz", - "integrity": "sha512-iK5/YhZxq5GO5z8wb0bY1317uDF3Zjpha0QFFLA8/trAoiLbQD0HUbMesEaxyzUgDxi2QlcbM8IvqOlEjgoXBA==", - "license": "MIT", - "dependencies": { - "array-back": "^6.2.2", - "wordwrapjs": "^5.1.0" - }, - "engines": { - "node": ">=12.17" - } - }, "node_modules/tcp-port-used": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/tcp-port-used/-/tcp-port-used-1.0.2.tgz", @@ -18385,15 +18245,6 @@ "typescript": ">=4.8.4 <6.1.0" } }, - "node_modules/typical": { - "version": "7.3.0", - "resolved": "https://registry.npmjs.org/typical/-/typical-7.3.0.tgz", - "integrity": "sha512-ya4mg/30vm+DOWfBg4YK3j2WD6TWtRkCbasOJr40CseYENzCUby/7rIvXA99JGsQHeNxLbnXdyLLxKSv3tauFw==", - "license": "MIT", - "engines": { - "node": ">=12.17" - } - }, "node_modules/uc.micro": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", @@ -18899,9 +18750,9 @@ "license": "MIT" }, "node_modules/vite": { - "version": "7.3.1", - "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.1.tgz", - "integrity": "sha512-w+N7Hifpc3gRjZ63vYBXA56dvvRlNWRczTdmCBBa+CotUzAPf5b7YMdMR/8CQoeYE5LX3W4wj6RYTgonm1b9DA==", + "version": "7.3.2", + "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.2.tgz", + "integrity": "sha512-Bby3NOsna2jsjfLVOHKes8sGwgl4TT0E6vvpYgnAYDIF/tie7MRaFthmKuHx1NSXjiTueXH3do80FMQgvEktRg==", "dev": true, "license": "MIT", "dependencies": { @@ -19502,15 +19353,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/wordwrapjs": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/wordwrapjs/-/wordwrapjs-5.1.1.tgz", - "integrity": "sha512-0yweIbkINJodk27gX9LBGMzyQdBDan3s/dEAiwBOj+Mf0PPyWL6/rikalkv8EeD0E8jm4o5RXEOrFTP3NXbhJg==", - "license": "MIT", - "engines": { - "node": ">=12.17" - } - }, "node_modules/wrap-ansi": { "version": "9.0.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-9.0.0.tgz", diff --git a/package.json b/package.json index f3b6d7c048be..f1ff05782932 100644 --- a/package.json +++ b/package.json @@ -50,6 +50,9 @@ "aggregate-search-index-failures": "tsx src/search/scripts/aggregate-search-index-failures.ts", "general-search-scrape": "tsx src/search/scripts/scrape/scrape-cli.ts", "general-search-scrape-server": "cross-env NODE_ENV=production PORT=4002 MINIMAL_RENDER=true CHANGELOG_DISABLED=true tsx src/frame/server.ts", + "generate-release-notes": "tsx src/ghes-releases/scripts/generate-release-notes.ts", + "notify-release-pms": "tsx src/ghes-releases/scripts/notify-release-pms.ts", + "check-release-approvals": "tsx src/ghes-releases/scripts/check-release-approvals.ts", "ghes-release-scrape-with-server": "cross-env GHES_RELEASE=1 start-server-and-test general-search-scrape-server 4002 general-search-scrape", "general-search-scrape-with-server": "cross-env NODE_OPTIONS='--max_old_space_size=8192' start-server-and-test general-search-scrape-server 4002 general-search-scrape", "index-ai-search-autocomplete": "tsx src/search/scripts/index/index-cli ai-search-autocomplete", @@ -223,8 +226,8 @@ "js-cookie": "^3.0.5", "js-yaml": "^4.1.1", "liquidjs": "^10.25.0", - "lodash": "^4.17.23", - "lodash-es": "^4.17.23", + "lodash": "^4.18.0", + "lodash-es": "^4.18.0", "lowdb": "7.0.1", "lowlight": "^3.3.0", "markdownlint-rule-helpers": "^0.25.0", @@ -346,7 +349,10 @@ "website-scraper": "^5.3.1" }, "overrides": { - "esbuild": "^0.25" + "esbuild": "^0.25", + "vite": "^7.3.2", + "path-to-regexp": "^8.4.0", + "apache-arrow": "file:src/search/vendor/apache-arrow-stub" }, "optionalDependencies": { "esm": "^3.2.25" diff --git a/src/article-api/templates/audit-logs-page.template.md b/src/article-api/templates/audit-logs-page.template.md index 32bbd34531c0..f2d44d0c8f18 100644 --- a/src/article-api/templates/audit-logs-page.template.md +++ b/src/article-api/templates/audit-logs-page.template.md @@ -26,7 +26,7 @@ Each event below lists only its additional fields beyond these common fields. {% for event in events %} #### `{{ event.action }}` -{{ event.description }} +{% if event.description and event.description != 'N/A' %}{{ event.description }}{% endif %} {% if event.fields.size > 0 %}**Additional fields:** {% for field in event.fields %}`{{ field }}`{% unless forloop.last %}, {% endunless %}{% endfor %}{% endif %} diff --git a/src/article-api/templates/graphql-reference.template.md b/src/article-api/templates/graphql-reference.template.md index 76244d1d25de..31b8dcf61edf 100644 --- a/src/article-api/templates/graphql-reference.template.md +++ b/src/article-api/templates/graphql-reference.template.md @@ -62,7 +62,7 @@ Connection types with only the standard pagination fields (`edges`, `nodes`, `pa ### Fields for `{{ item.name }}` -{% for field in item.fields %}* `{{ field.name }}` ({{ field.type }}): {{ field.description }}{% if field.defaultValue %} Default: `{{ field.defaultValue }}`.{% endif %}{% if field.isDeprecated %} **Deprecated:** {{ field.deprecationReason }}{% endif %}{% if field.arguments.size > 0 %} +{% for field in item.fields %}* `{{ field.name }}` ({{ field.type }}): {{ field.description }}{% if field.defaultValue %} Default: `{{ field.defaultValue }}`.{% endif %}{% if field.isDeprecated %} **Deprecated:** {{ field.deprecationReason }}{% endif %}{% if field.hasPaginationOnly %} _(Pagination: `after`, `before`, `first`, `last`)_{% elsif field.arguments.size > 0 %} {% for arg in field.arguments %} * `{{ arg.name }}` ({{ arg.type.name }}): {{ arg.description }}{% if arg.defaultValue %} Default: `{{ arg.defaultValue }}`.{% endif %} {% endfor %}{% endif %} {% endfor %} @@ -73,7 +73,7 @@ Connection types with only the standard pagination fields (`edges`, `nodes`, `pa ### Fields for `{{ item.name }}` -{% for field in item.fields %}* `{{ field.name }}` ({{ field.type }}): {{ field.description }}{% if field.defaultValue %} Default: `{{ field.defaultValue }}`.{% endif %}{% if field.isDeprecated %} **Deprecated:** {{ field.deprecationReason }}{% endif %}{% if field.arguments.size > 0 %} +{% for field in item.fields %}* `{{ field.name }}` ({{ field.type }}): {{ field.description }}{% if field.defaultValue %} Default: `{{ field.defaultValue }}`.{% endif %}{% if field.isDeprecated %} **Deprecated:** {{ field.deprecationReason }}{% endif %}{% if field.hasPaginationOnly %} _(Pagination: `after`, `before`, `first`, `last`)_{% elsif field.arguments.size > 0 %} {% for arg in field.arguments %} * `{{ arg.name }}` ({{ arg.type.name }}): {{ arg.description }}{% if arg.defaultValue %} Default: `{{ arg.defaultValue }}`.{% endif %} {% endfor %}{% endif %} {% endfor %} diff --git a/src/article-api/transformers/graphql-reference-transformer.ts b/src/article-api/transformers/graphql-reference-transformer.ts index 9f18ba4bc518..0158759b0b56 100644 --- a/src/article-api/transformers/graphql-reference-transformer.ts +++ b/src/article-api/transformers/graphql-reference-transformer.ts @@ -278,31 +278,49 @@ export class GraphQLReferenceTransformer implements PageTransformer { } } + private static STANDARD_PAGINATION_ARGS = new Set(['after', 'before', 'first', 'last']) + + /** + * Check if a field has only the standard pagination arguments + * (after, before, first, last) with no additional args. + */ + private hasOnlyStandardPaginationArgs(field: FieldT): boolean { + if (!field.arguments || field.arguments.length !== 4) return false + return field.arguments.every((arg) => + GraphQLReferenceTransformer.STANDARD_PAGINATION_ARGS.has(arg.name), + ) + } + /** * Prepare fields for rendering */ private async prepareFields(fields: FieldT[]): Promise>> { - return fields.map((field) => ({ - name: field.name, - type: field.type, - href: field.href, - description: field.description ? fastTextOnly(field.description) : '', - defaultValue: field.defaultValue, - isDeprecated: field.isDeprecated || false, - deprecationReason: field.deprecationReason - ? fastTextOnly(field.deprecationReason) - : undefined, - arguments: field.arguments - ? field.arguments.map((arg) => ({ - name: arg.name, - description: arg.description ? fastTextOnly(arg.description) : '', - defaultValue: arg.defaultValue, - type: { - name: arg.type.name, - href: arg.type.href, - }, - })) - : undefined, - })) + return fields.map((field) => { + const hasPaginationOnly = this.hasOnlyStandardPaginationArgs(field) + return { + name: field.name, + type: field.type, + href: field.href, + description: field.description ? fastTextOnly(field.description) : '', + defaultValue: field.defaultValue, + isDeprecated: field.isDeprecated || false, + deprecationReason: field.deprecationReason + ? fastTextOnly(field.deprecationReason) + : undefined, + hasPaginationOnly, + arguments: + field.arguments && !hasPaginationOnly + ? field.arguments.map((arg) => ({ + name: arg.name, + description: arg.description ? fastTextOnly(arg.description) : '', + defaultValue: arg.defaultValue, + type: { + name: arg.type.name, + href: arg.type.href, + }, + })) + : undefined, + } + }) } } diff --git a/src/content-linter/lib/linting-rules/frontmatter-schema.ts b/src/content-linter/lib/linting-rules/frontmatter-schema.ts index b91f7590ce85..2fae6b10c5c5 100644 --- a/src/content-linter/lib/linting-rules/frontmatter-schema.ts +++ b/src/content-linter/lib/linting-rules/frontmatter-schema.ts @@ -2,7 +2,6 @@ import { addError } from 'markdownlint-rule-helpers' import { intersection } from 'lodash-es' import { getFrontmatter } from '../helpers/utils' -import { formatAjvErrors } from '../helpers/schema-utils' import { frontmatter, deprecatedProperties } from '@/frame/lib/frontmatter' import readFrontmatter from '@/frame/lib/read-frontmatter' import type { RuleParams, RuleErrorCallback, Rule } from '../../types' @@ -35,23 +34,46 @@ export const frontmatterSchema: Rule = { ) } - // Check that the frontmatter matches the schema + // Check that the frontmatter matches the schema. + // readFrontmatter returns errors as { property, message, reason } objects. const { errors } = readFrontmatter(params.lines.join('\n'), { schema: frontmatter.schema }) - const formattedErrors = formatAjvErrors( - errors as unknown as Parameters[0], - ) - for (const error of formattedErrors) { - // If the missing property is at the top level, we don't have a line + for (const error of errors) { + const property = error.property || '' + const message = error.message || '' + const reason = error.reason || '' + const parts = property.split('.') + + let detail: string + let context: string + let searchProperty: string + + if (reason === 'additionalProperties') { + detail = 'The frontmatter includes an unsupported property.' + context = `Remove the property \`${property}\`.` + // Search for the offending additional property directly + searchProperty = parts[parts.length - 1] || '' + } else if (reason === 'required') { + detail = 'The frontmatter has a missing required property' + context = `Add the missing property \`${property}\`` + // The property is missing, so point to its parent container + searchProperty = parts.length > 1 ? parts[parts.length - 2] : '' + } else { + detail = `Frontmatter ${message}.` + context = property + searchProperty = parts[0] || '' + } + + // If the property is at the top level or missing, we don't have a line // to point to. In that case, the error will be added to line 1. - const query = (line: string) => line.trim().startsWith(`${error.searchProperty}:`) - const line = error.searchProperty === '' ? null : params.lines.find(query) + const query = (line: string) => line.trim().startsWith(`${searchProperty}:`) + const line = searchProperty === '' ? null : params.lines.find(query) const lineNumber = line ? params.lines.indexOf(line) + 1 : 1 addError( onError, lineNumber, - error.detail, - error.context, - line ? [1, error.errorProperty.length] : null, + detail, + context, + line ? [1, searchProperty.length] : null, null, // No fix possible ) } diff --git a/src/content-render/liquid/ifversion.ts b/src/content-render/liquid/ifversion.ts index 5ff38fe44843..60a4a5cc070f 100644 --- a/src/content-render/liquid/ifversion.ts +++ b/src/content-render/liquid/ifversion.ts @@ -8,6 +8,7 @@ import { type Emitter, type Template, type TopLevelToken, + type Liquid, } from 'liquidjs' import versionSatisfiesRange from '@/versions/lib/version-satisfies-range' import supportedOperators, { @@ -26,6 +27,11 @@ interface VersionObj { internalLatestRelease?: string } +interface IfversionEnvironments { + currentVersionObj?: VersionObj + markdownRequested?: boolean +} + const SyntaxHelp = "Syntax Error in 'ifversion' with range - Valid syntax: ifversion [plan] [operator] [releaseNumber]" @@ -44,7 +50,7 @@ export default class Ifversion extends Tag { currentVersionObj: VersionObj | null = null // The following is verbatim from https://github.com/harttle/liquidjs/blob/v9.22.1/src/builtin/tags/if.ts - constructor(tagToken: TagToken, remainTokens: TopLevelToken[], liquid: any) { + constructor(tagToken: TagToken, remainTokens: TopLevelToken[], liquid: Liquid) { super(tagToken, remainTokens, liquid) this.tagToken = tagToken @@ -60,7 +66,7 @@ export default class Ifversion extends Tag { templates: (p = []), }), ) - .on('tag:elsif', (token: any) => { + .on('tag:elsif', (token: TagToken) => { this.branches.push({ cond: token.args, templates: (p = []), @@ -78,10 +84,10 @@ export default class Ifversion extends Tag { // The following is _mostly_ verbatim from https://github.com/harttle/liquidjs/blob/v9.22.1/src/builtin/tags/if.ts // The additions here are the handleNots(), handleOperators(), and handleVersionNames() calls. - *render(ctx: Context, emitter: Emitter): Generator { + *render(ctx: Context, emitter: Emitter): Generator { const r = this.liquid.renderer - this.currentVersionObj = (ctx.environments as any).currentVersionObj + this.currentVersionObj = (ctx.environments as IfversionEnvironments).currentVersionObj ?? null for (const branch of this.branches) { let resolvedBranchCond = branch.cond @@ -96,7 +102,7 @@ export default class Ifversion extends Tag { // Resolve version names to boolean values for Markdown API context. // This will replace syntax like `fpt or ghec` with `true or false` based on current version. // Only apply this transformation in Markdown API context to avoid breaking existing functionality. - if ((ctx.environments as any).markdownRequested) { + if ((ctx.environments as IfversionEnvironments).markdownRequested) { resolvedBranchCond = this.handleVersionNames(resolvedBranchCond) } diff --git a/src/content-render/liquid/indented-data-reference.ts b/src/content-render/liquid/indented-data-reference.ts index 7fe2fff3b2c1..2a77920ab2d9 100644 --- a/src/content-render/liquid/indented-data-reference.ts +++ b/src/content-render/liquid/indented-data-reference.ts @@ -1,20 +1,13 @@ import assert from 'assert' +import { type TagToken, type Liquid } from 'liquidjs' import { THROW_ON_EMPTY, IndentedDataReferenceError } from './error-handling' import { getDataByLanguage } from '@/data-directory/lib/get-data' -// Note: Using 'any' for liquidjs-related types because liquidjs doesn't provide comprehensive TypeScript definitions -interface LiquidTag { - markup: string - liquid: any - parse(tagToken: any): void - render(scope: any): Promise -} - interface LiquidScope { environments: { currentLanguage: string - [key: string]: any + [key: string]: unknown } } @@ -28,11 +21,11 @@ interface LiquidScope { // reference is used inside a block element (like a list or nested list) without // affecting the formatting when the reference is used elsewhere via {{ site.data.foo.bar }}. -const IndentedDataReference: LiquidTag = { +const IndentedDataReference = { markup: '', - liquid: null as any, + liquid: null as Liquid | null, - parse(tagToken: any): void { + parse(tagToken: TagToken): void { this.markup = tagToken.args.trim() }, diff --git a/src/content-render/liquid/octicon.ts b/src/content-render/liquid/octicon.ts index 47d5a0ee8674..ca5a40fa7379 100644 --- a/src/content-render/liquid/octicon.ts +++ b/src/content-render/liquid/octicon.ts @@ -1,21 +1,6 @@ -import { TokenizationError } from 'liquidjs' +import { TokenizationError, type TagToken } from 'liquidjs' import octicons from '@primer/octicons' -// Note: Using 'any' for liquidjs-related types because liquidjs doesn't provide comprehensive TypeScript definitions -interface LiquidTag { - icon: string - options: Record - parse(tagToken: any): void - render(): Promise -} - -interface OcticonsMatch { - groups: { - icon: string - options?: string - } -} - const OptionsSyntax = /([a-zA-Z-]+)="([\w\s-]+)"*/g const Syntax = new RegExp(`"(?[a-zA-Z-]+)"(?(?:\\s${OptionsSyntax.source})*)`) const SyntaxHelp = 'Syntax Error in tag \'octicon\' - Valid syntax: octicon "" ' @@ -30,13 +15,13 @@ const SyntaxHelp = 'Syntax Error in tag \'octicon\' - Valid syntax: octicon " * {% octicon "check" width="64" aria-label="Example label" %} */ -const Octicon: LiquidTag = { +const Octicon = { icon: '', - options: {}, + options: {} as Record, - parse(tagToken: any): void { - const match: OcticonsMatch | null = tagToken.args.match(Syntax) - if (!match) { + parse(tagToken: TagToken): void { + const match = tagToken.args.match(Syntax) + if (!match || !match.groups) { throw new TokenizationError(SyntaxHelp, tagToken) } diff --git a/src/content-render/scripts/add-content-type.ts b/src/content-render/scripts/add-content-type.ts index ef78f234e3a3..588b484bdaf0 100644 --- a/src/content-render/scripts/add-content-type.ts +++ b/src/content-render/scripts/add-content-type.ts @@ -128,7 +128,15 @@ function processFile(filePath: string, scriptOptions: ScriptOptions) { } // Write the file back - fs.writeFileSync(filePath, frontmatter.stringify(content, data, { lineWidth: -1 } as any)) + fs.writeFileSync( + filePath, + frontmatter.stringify( + content, + data, + // lineWidth is a js-yaml option passed through gray-matter, not in gray-matter's type definitions + { lineWidth: -1 } as unknown as Parameters[2], + ), + ) if (scriptOptions.verbose) { console.log(`\n${relativePath}`) diff --git a/src/content-render/scripts/move-by-content-type.ts b/src/content-render/scripts/move-by-content-type.ts index 2acc86c97f75..c64ef0ed27fc 100644 --- a/src/content-render/scripts/move-by-content-type.ts +++ b/src/content-render/scripts/move-by-content-type.ts @@ -146,7 +146,7 @@ program } // Validate contentType - if (!CONTENT_TYPES.includes(contentType as any)) { + if (!CONTENT_TYPES.includes(contentType)) { skipped.push({ file: relativePath, reason: `Invalid contentType: ${contentType}` }) console.log( chalk.yellow(`⚠ Skipping ${relativePath}: Invalid contentType "${contentType}"`), diff --git a/src/content-render/tests/data.ts b/src/content-render/tests/data.ts index 78218c0947e8..85fbe23faa54 100644 --- a/src/content-render/tests/data.ts +++ b/src/content-render/tests/data.ts @@ -6,8 +6,7 @@ import nonEnterpriseDefaultVersion from '@/versions/lib/non-enterprise-default-v import { DataDirectory } from '@/tests/helpers/data-directory' describe('data tag', () => { - // Using 'any' type as DataDirectory is from data-directory.ts which lacks type definitions - let dd: any + let dd: DataDirectory const enDirBefore = languages.en.dir beforeAll(() => { diff --git a/src/content-render/unified/module-types.d.ts b/src/content-render/unified/module-types.d.ts index a2dc5d4aa72d..60c0cf6d00a9 100644 --- a/src/content-render/unified/module-types.d.ts +++ b/src/content-render/unified/module-types.d.ts @@ -19,7 +19,7 @@ declare module 'rehype-highlight' { import type { Options } from 'lowlight' interface HighlightOptions extends Options { - languages?: Record + languages?: Record subset?: boolean aliases?: Record } diff --git a/src/content-render/unified/rewrite-local-links.ts b/src/content-render/unified/rewrite-local-links.ts index 53687ffdd31e..dbca9703f5ca 100644 --- a/src/content-render/unified/rewrite-local-links.ts +++ b/src/content-render/unified/rewrite-local-links.ts @@ -101,12 +101,13 @@ export default function rewriteLocalLinks(context?: Context) { const linkRefNode = node as LinkReference const definition = definitions.get(linkRefNode.identifier) if (definition) { - // Replace the LinkReference node with a Link node - // Using 'as any' because we're mutating the node type at runtime, - // which TypeScript doesn't allow as LinkReference and Link are incompatible types - ;(linkRefNode as any).type = 'link' - ;(linkRefNode as any).url = definition.url - ;(linkRefNode as any).title = definition.title + // Replace the LinkReference node with a Link node by mutating its + // properties at runtime. Using 'as unknown as' because LinkReference + // and Link are structurally incompatible in TypeScript. + const mutableNode = linkRefNode as unknown as Link + mutableNode.type = 'link' + mutableNode.url = definition.url + mutableNode.title = definition.title } else { console.warn(`Definition not found for identifier: ${linkRefNode.identifier}`) } diff --git a/src/data-directory/lib/get-data.ts b/src/data-directory/lib/get-data.ts index ba5131e2dc02..bb8b21649aff 100644 --- a/src/data-directory/lib/get-data.ts +++ b/src/data-directory/lib/get-data.ts @@ -187,7 +187,25 @@ function getDataByDir( if (allData && key) { const value = allData[key] if (value) { - return matter(value).content + let content = matter(value).content + if (dir !== englishRoot) { + let englishContent = content + try { + const englishData = getYamlContent(englishRoot, fullPath.join(path.sep), englishRoot) + if (englishData?.[key]) { + englishContent = matter(englishData[key]).content + } + } catch (error) { + if ((error as FileSystemError).code !== 'ENOENT') { + throw error + } + } + content = correctTranslatedContentStrings(content, englishContent, { + dottedPath, + code: langCode, + }) + } + return content } } else { console.warn(`Unable to find variables Yaml file ${fullPath.join(path.sep)}`) diff --git a/src/data-directory/tests/get-data.ts b/src/data-directory/tests/get-data.ts index cddbeac7e555..976529411602 100644 --- a/src/data-directory/tests/get-data.ts +++ b/src/data-directory/tests/get-data.ts @@ -296,3 +296,74 @@ describe('get-data on corrupt translations', () => { } }) }) + +describe('get-data applies corrections to translated variables', () => { + let dd: DataDirectory + const enDirBefore = languages.en.dir + languages.ja = Object.assign({}, languages.en, {}) + + beforeAll(() => { + dd = new DataDirectory({ + data: { + variables: { + myproduct: { + name: 'GitHub', + }, + phases: { + preview: '{% ifversion ghes < 3.16 %}beta{% else %}public preview{% endif %}', + }, + }, + }, + }) + languages.en.dir = dd.root + + const jaTranslationsRoot = path.join(dd.root, 'translations', 'ja-JP') + fs.mkdirSync(jaTranslationsRoot, { recursive: true }) + languages.ja.dir = jaTranslationsRoot + new DataDirectory( + { + data: { + variables: { + myproduct: { + // Corrupted: `data` translated to Japanese `データ` + name: '{% データ variables.myproduct.name %}', + }, + phases: { + // Not corrupted — should pass through unchanged + preview: '{% ifversion ghes < 3.16 %}ベータ{% else %}パブリックプレビュー{% endif %}', + }, + }, + }, + }, + jaTranslationsRoot, + ) + }) + + afterAll(() => { + dd.destroy() + languages.en.dir = enDirBefore + }) + + test('corrects corrupted Liquid keywords in translated variables', () => { + // English variable is returned as-is + { + const result = getDataByLanguage('variables.myproduct.name', 'en') + expect(result).toBe('GitHub') + } + // Japanese translation with corrupted `データ` → `data` gets corrected + { + const result = getDataByLanguage('variables.myproduct.name', 'ja') + expect(result).toBe('{% data variables.myproduct.name %}') + } + }) + + test('leaves valid translated variables unchanged', () => { + // Valid ifversion in translated variable should pass through + { + const result = getDataByLanguage('variables.phases.preview', 'ja') + expect(result).toBe( + '{% ifversion ghes < 3.16 %}ベータ{% else %}パブリックプレビュー{% endif %}', + ) + } + }) +}) diff --git a/src/early-access/scripts/what-docs-early-access-branch.ts b/src/early-access/scripts/what-docs-early-access-branch.ts index 3bc261f79a01..02df44ffc4c5 100644 --- a/src/early-access/scripts/what-docs-early-access-branch.ts +++ b/src/early-access/scripts/what-docs-early-access-branch.ts @@ -21,7 +21,7 @@ async function main(): Promise { console.log(`Using docs-early-access branch called '${BRANCH_NAME}'.`) setOutput(OUTPUT_KEY, BRANCH_NAME) } catch (err) { - if ((err as any).status === 404) { + if (err instanceof Error && 'status' in err && (err as { status: number }).status === 404) { console.log( `There is no docs-early-access branch called '${BRANCH_NAME}' so checking out 'main' instead.`, ) diff --git a/src/frame/components/context/ArticleContext.tsx b/src/frame/components/context/ArticleContext.tsx index a2cf29c77171..c91ab9253234 100644 --- a/src/frame/components/context/ArticleContext.tsx +++ b/src/frame/components/context/ArticleContext.tsx @@ -54,11 +54,27 @@ const PagePathToVaFlowMapping: Record = { 'pages_ssl_check', } -export const getArticleContextFromRequest = (req: any): ArticleContextT => { +// Request type for context extraction — uses Record for the page +// because the Page type doesn't include all runtime-computed properties. +interface ContextRequest { + context: { + page: Record & { fullPath: string; title: string; intro: string } + renderedPage?: string + miniTocItems?: MiniTocItem[] + currentJourneyTrack?: JourneyContext + currentLayoutName?: string + currentPath?: string + [key: string]: unknown + } + [key: string]: unknown +} + +export const getArticleContextFromRequest = (req: ContextRequest): ArticleContextT => { const page = req.context.page - if (page.effectiveDate) { - if (isNaN(Date.parse(page.effectiveDate))) { + const effectiveDate = (page.effectiveDate as string) || '' + if (effectiveDate) { + if (isNaN(Date.parse(effectiveDate))) { throw new Error( 'The "effectiveDate" frontmatter property is not valid. Please make sure it is YEAR-MONTH-DAY', ) @@ -79,19 +95,19 @@ export const getArticleContextFromRequest = (req: any): ArticleContextT => { return { title: page.title, intro: page.intro, - effectiveDate: page.effectiveDate || '', - renderedPage: req.context.renderedPage || '', + effectiveDate, + renderedPage: (req.context.renderedPage as string) || '', miniTocItems: req.context.miniTocItems || [], - permissions: page.permissions || '', - includesPlatformSpecificContent: page.includesPlatformSpecificContent || false, - includesToolSpecificContent: page.includesToolSpecificContent || false, - defaultPlatform: page.defaultPlatform || '', - defaultTool: page.defaultTool || '', - product: page.product || '', + permissions: (page.permissions as string) || '', + includesPlatformSpecificContent: (page.includesPlatformSpecificContent as boolean) || false, + includesToolSpecificContent: (page.includesToolSpecificContent as boolean) || false, + defaultPlatform: (page.defaultPlatform as string) || '', + defaultTool: (page.defaultTool as string) || '', + product: (page.product as string) || '', currentJourneyTrack: req.context.currentJourneyTrack, - detectedPlatforms: page.detectedPlatforms || [], - detectedTools: page.detectedTools || [], - allTools: page.allToolsParsed || [], // this is set at the page level, see lib/page.ts + detectedPlatforms: (page.detectedPlatforms as string[]) || [], + detectedTools: (page.detectedTools as string[]) || [], + allTools: (page.allToolsParsed as Record) || {}, supportPortalVaIframeProps, currentLayout: req.context.currentLayoutName, currentPath: req.context.currentPath || '', diff --git a/src/frame/components/context/CategoryLandingContext.tsx b/src/frame/components/context/CategoryLandingContext.tsx index 30837f4eb39b..f62969dac9ae 100644 --- a/src/frame/components/context/CategoryLandingContext.tsx +++ b/src/frame/components/context/CategoryLandingContext.tsx @@ -1,6 +1,6 @@ import { createContext, useContext } from 'react' import { FeaturedLink, getFeaturedLinksFromReq } from '@/landings/components/ProductLandingContext' -import type { TocItem } from '@/landings/types' +import type { RawTocItem, TocItem } from '@/landings/types' import { mapRawTocItemToTocItem } from '@/landings/types' import type { SpotlightItem } from '@/types' @@ -31,19 +31,36 @@ export const useCategoryLandingContext = (): CategoryLandingContextT => { return context } -export const getCategoryLandingContextFromRequest = (req: any): CategoryLandingContextT => { +// Request type for context extraction — uses Record for the page +// because the Page type doesn't include all runtime-computed properties. +interface ContextRequest { + context: { + page: Record & { title: string; intro: string } + genericTocFlat?: unknown[] + genericTocNested?: unknown[] + renderedPage?: string + currentLayoutName?: string + featuredLinks?: Record + [key: string]: unknown + } + [key: string]: unknown +} + +export const getCategoryLandingContextFromRequest = ( + req: ContextRequest, +): CategoryLandingContextT => { return { title: req.context.page.title, - productCallout: req.context.page.product || '', - permissions: req.context.page.permissions || '', + productCallout: (req.context.page.product as string) || '', + permissions: (req.context.page.permissions as string) || '', intro: req.context.page.intro, - tocItems: (req.context.genericTocFlat || req.context.genericTocNested || []).map( - mapRawTocItemToTocItem, - ), + tocItems: ( + (req.context.genericTocFlat || req.context.genericTocNested || []) as RawTocItem[] + ).map(mapRawTocItemToTocItem), variant: req.context.genericTocFlat ? 'expanded' : 'compact', featuredLinks: getFeaturedLinksFromReq(req), - renderedPage: req.context.renderedPage, - currentLayout: req.context.currentLayoutName, - spotlight: req.context.page.spotlight, + renderedPage: (req.context.renderedPage as string) || '', + currentLayout: req.context.currentLayoutName || '', + spotlight: req.context.page.spotlight as SpotlightItem[] | undefined, } } diff --git a/src/frame/components/context/TocLandingContext.tsx b/src/frame/components/context/TocLandingContext.tsx index e83ee2e22a5a..9366830f8efe 100644 --- a/src/frame/components/context/TocLandingContext.tsx +++ b/src/frame/components/context/TocLandingContext.tsx @@ -1,6 +1,6 @@ import { createContext, useContext } from 'react' import { FeaturedLink, getFeaturedLinksFromReq } from '@/landings/components/ProductLandingContext' -import type { SimpleTocItem } from '@/landings/types' +import type { RawTocItem, SimpleTocItem } from '@/landings/types' import { mapRawTocItemToSimpleTocItem } from '@/landings/types' export type TocLandingContextT = { @@ -26,17 +26,31 @@ export const useTocLandingContext = (): TocLandingContextT => { return context } -export const getTocLandingContextFromRequest = (req: any): TocLandingContextT => { +// Request type for context extraction — uses Record for the page +// because the Page type doesn't include all runtime-computed properties. +interface ContextRequest { + context: { + page: Record & { title: string; intro: string } + genericTocFlat?: unknown[] + genericTocNested?: unknown[] + renderedPage?: string + featuredLinks?: Record + [key: string]: unknown + } + [key: string]: unknown +} + +export const getTocLandingContextFromRequest = (req: ContextRequest): TocLandingContextT => { return { title: req.context.page.title, - productCallout: req.context.page.product || '', - permissions: req.context.page.permissions || '', + productCallout: (req.context.page.product as string) || '', + permissions: (req.context.page.permissions as string) || '', intro: req.context.page.intro, - tocItems: (req.context.genericTocFlat || req.context.genericTocNested || []).map( - mapRawTocItemToSimpleTocItem, - ), + tocItems: ( + (req.context.genericTocFlat || req.context.genericTocNested || []) as RawTocItem[] + ).map(mapRawTocItemToSimpleTocItem), variant: req.context.genericTocFlat ? 'expanded' : 'compact', featuredLinks: getFeaturedLinksFromReq(req), - renderedPage: req.context.renderedPage, + renderedPage: (req.context.renderedPage as string) || '', } } diff --git a/src/frame/components/page-header/Header.tsx b/src/frame/components/page-header/Header.tsx index 49508d32b802..92b69ac35fda 100644 --- a/src/frame/components/page-header/Header.tsx +++ b/src/frame/components/page-header/Header.tsx @@ -43,16 +43,23 @@ export const Header = () => { const isEarlyAccessPage = currentProduct && currentProduct.id === 'early-access' const { width } = useInnerWindowWidth() const returnFocusRef = useRef(null) - const searchButtonRef = useRef(null) + const searchButtonRefLarge = useRef(null) + const searchButtonRefSmall = useRef(null) const { initializeCTA } = useCTAPopoverContext() const { isSearchOpen, setIsSearchOpen } = useSearchOverlayContext() + // The lg breakpoint (1012px) determines which search button is visible. + // Pass the correct ref to SearchOverlayContainer so Primer's Overlay + // restores focus to the visible trigger element on close. + const isLargeViewport = width !== null && width >= 1012 + const searchButtonRef = isLargeViewport ? searchButtonRefLarge : searchButtonRefSmall + const SearchButtonLarge: JSX.Element = ( ) @@ -62,7 +69,7 @@ export const Header = () => { isSearchOpen={isSearchOpen} setIsSearchOpen={setIsSearchOpen} params={params} - searchButtonRef={searchButtonRef} + searchButtonRef={searchButtonRefSmall} instanceId="small" /> ) @@ -90,17 +97,18 @@ export const Header = () => { return () => window.removeEventListener('keydown', close) }, []) - // For the UI in smaller browser widths, and focus the picker menu button when the search - // input is closed. + // For the UI in smaller browser widths, focus the picker menu button when + // the sidebar is closed (not when the search overlay is closed — the + // overlay's returnFocusRef handles focus restoration to the search button). useEffect(() => { - if (!isSearchOpen && isMounted.current && menuButtonRef.current) { + if (!isSidebarOpen && isMounted.current && menuButtonRef.current) { menuButtonRef.current.focus() } if (!isMounted.current) { isMounted.current = true } - }, [isSearchOpen]) + }, [isSidebarOpen]) // When the sidebar overlay is opened, prevent the main content from being // scrollable. diff --git a/src/frame/lib/page-data.ts b/src/frame/lib/page-data.ts index aeb0e64cd444..cadd063cb15e 100644 --- a/src/frame/lib/page-data.ts +++ b/src/frame/lib/page-data.ts @@ -192,7 +192,7 @@ async function translateTree( // The beauty in this is that if the translated content file // has something wrong with, say, the `versions` frontmatter key // we don't even care because we won't be using it anyway. - if (translatableFrontmatterKeys.includes(property)) { + if (property && translatableFrontmatterKeys.includes(property)) { const message = `frontmatter error on '${property}' (in ${fullPath}) so falling back to English` if (DEBUG_TRANSLATION_FALLBACKS) { // The object format is so the health report knows which path the issue is on diff --git a/src/frame/lib/read-frontmatter.ts b/src/frame/lib/read-frontmatter.ts index 23920d1f58fe..ceb62c683102 100644 --- a/src/frame/lib/read-frontmatter.ts +++ b/src/frame/lib/read-frontmatter.ts @@ -1,14 +1,22 @@ import matter from '@gr2m/gray-matter' +import type { SchemaObject, ErrorObject } from 'ajv' import { validateJson } from '@/tests/lib/validate-json-schema' interface ReadFrontmatterOptions { - schema?: Record // Schema can have arbitrary properties for validation + schema?: SchemaObject filepath?: string | null } +interface FrontmatterError { + reason: string + message?: string + filepath?: string + property?: string +} + function readFrontmatter(markdown: string, opts: ReadFrontmatterOptions = {}) { - const schema = opts.schema || { type: 'object', properties: {} } + const schema: SchemaObject = opts.schema || { type: 'object', properties: {} } const filepath = opts.filepath || null let content @@ -16,18 +24,19 @@ function readFrontmatter(markdown: string, opts: ReadFrontmatterOptions = {}) { try { ;({ content, data } = matter(markdown)) - } catch (e: any) { + } catch (e: unknown) { const defaultReason = 'invalid frontmatter entry' - const reason = e.reason - ? // make this common error message a little easier to understand - e.reason.startsWith('can not read a block mapping entry;') || - e.reason === 'bad indentation of a mapping entry' - ? defaultReason - : e.reason - : defaultReason + const reason = + e instanceof Error && 'reason' in e + ? // make this common error message a little easier to understand + (e as { reason: string }).reason.startsWith('can not read a block mapping entry;') || + (e as { reason: string }).reason === 'bad indentation of a mapping entry' + ? defaultReason + : (e as { reason: string }).reason + : defaultReason - const error: any = { + const error: FrontmatterError = { reason, message: 'YML parsing error!', } @@ -38,7 +47,7 @@ function readFrontmatter(markdown: string, opts: ReadFrontmatterOptions = {}) { return { errors } } - const validate: any = validateJson(schema, data) + const validate = validateJson(schema, data) // Combine the AJV-supplied `instancePath` and `params` into a more user-friendly frontmatter path. // For example, given: @@ -49,28 +58,39 @@ function readFrontmatter(markdown: string, opts: ReadFrontmatterOptions = {}) { // // The purpose is to help users understand that the error is on the `fpt` key within the `versions` object. // Note if the error is on a top-level FM property like `title`, the `instancePath` will be empty. - const cleanPropertyPath = (params: Record, instancePath: string) => { + const cleanPropertyPath = ( + params: Record, + instancePath: string, + ): string | undefined => { const mainProps = Object.values(params)[0] - if (!instancePath) return mainProps + if (!instancePath) return mainProps as string | undefined const prefixProps = instancePath.replace('/', '').replace(/\//g, '.') - return typeof mainProps !== 'object' ? `${prefixProps}.${mainProps}` : prefixProps + return typeof mainProps === 'string' && /^[a-zA-Z_][\w-]*$/.test(mainProps) + ? `${prefixProps}.${mainProps}` + : prefixProps } - const errors = [] + const errors: FrontmatterError[] = [] if (!validate.isValid && filepath) { - const formattedErrors = validate.errors.map((error: any) => { - const userFriendly: any = {} - userFriendly.property = cleanPropertyPath(error.params, error.instancePath) - userFriendly.message = error.message - userFriendly.reason = error.keyword - userFriendly.filepath = filepath + const formattedErrors = (validate.errors as ErrorObject[]).map((error: ErrorObject) => { + const userFriendly: FrontmatterError = { + property: cleanPropertyPath(error.params, error.instancePath) || '', + message: error.message, + reason: error.keyword, + filepath, + } return userFriendly }) errors.push(...formattedErrors) } else if (!validate.isValid) { - errors.push(...validate.errors) + const formattedErrors = (validate.errors as ErrorObject[]).map((error: ErrorObject) => ({ + property: cleanPropertyPath(error.params, error.instancePath) || '', + message: error.message, + reason: error.keyword, + })) + errors.push(...formattedErrors) } return { content, data, errors } diff --git a/src/frame/tests/read-frontmatter.ts b/src/frame/tests/read-frontmatter.ts index feda8abe9639..67217d45c81e 100644 --- a/src/frame/tests/read-frontmatter.ts +++ b/src/frame/tests/read-frontmatter.ts @@ -107,45 +107,25 @@ I am content. expect(content!.trim()).toBe('I am content.') expect(errors.length).toBe(1) const expectedError = { - instancePath: '/meaning_of_life', - schemaPath: '#/properties/meaning_of_life/minimum', - keyword: 'minimum', - params: { - comparison: '>=', - limit: 50, - }, + property: 'meaning_of_life', message: 'must be >= 50', + reason: 'minimum', } expect(errors[0]).toEqual(expectedError) }) test('creates errors if versions frontmatter does not match semver format', () => { const schema = { type: 'object', required: ['versions'], properties: {} } - ;(schema.properties as any).versions = Object.assign( + ;(schema.properties as Record).versions = Object.assign( {}, - (frontmatterSchema.properties as any).versions, + (frontmatterSchema.properties as Record).versions, ) const { errors } = parse(fixture2, { schema }) const expectedError = { - instancePath: '/versions/ghes', - schemaPath: '#/properties/versions/properties/ghes/errorMessage', - keyword: 'errorMessage', - params: { - errors: [ - { - instancePath: '/versions/ghes', - schemaPath: '#/properties/versions/properties/ghes/format', - keyword: 'format', - params: { - format: 'semver', - }, - message: 'must match format "semver"', - emUsed: true, - }, - ], - }, + property: 'versions.ghes', message: 'Must be a valid SemVer range: "BAD_VERSION"', + reason: 'errorMessage', } expect(errors[0]).toEqual(expectedError) @@ -165,13 +145,9 @@ I am content. const { errors } = parse(fixture1, { schema }) expect(errors.length).toBe(1) const expectedError = { - instancePath: '', - schemaPath: '#/required', - keyword: 'required', - params: { - missingProperty: 'yet_another_key', - }, + property: 'yet_another_key', message: "must have required property 'yet_another_key'", + reason: 'required', } expect(errors[0]).toEqual(expectedError) }) diff --git a/src/ghes-releases/README.md b/src/ghes-releases/README.md index 5405221d81be..23f90e3ffc1d 100644 --- a/src/ghes-releases/README.md +++ b/src/ghes-releases/README.md @@ -68,6 +68,11 @@ The following scripts are available for manual execution: | `npm run deprecate-ghes-archive` | Archive deprecation tracking issues. | | `npm run release-banner` | Update the release banner. | | `npm run update-enterprise-dates` | Update enterprise release dates. | +| `npm run generate-release-notes` | Generate draft release notes using Copilot agent. | +| `npm run notify-release-pms` | Notify PMs to review their release notes. | +| `npm run check-release-approvals` | Check PM approval status for release notes. | + +See the [scripts README](scripts/README.md) for a full usage guide covering the release notes generation, notification, and approval workflow. For example, to create new release tracking issues, run: ```bash diff --git a/src/ghes-releases/lib/parse-release-notes.ts b/src/ghes-releases/lib/parse-release-notes.ts new file mode 100644 index 000000000000..1a9ac97901a3 --- /dev/null +++ b/src/ghes-releases/lib/parse-release-notes.ts @@ -0,0 +1,351 @@ +/** + * Pure parsing/extraction functions used by generate-release-notes.ts. + * Extracted here so they can be unit-tested without triggering the CLI. + */ +import fs from 'fs' +import yaml from 'js-yaml' + +// ─── Types ─────────────────────────────────────────────────────────────────── + +export interface NoteEntry { + heading: string + notes: string[] + sourceUrl: string +} + +// ─── extractYaml ───────────────────────────────────────────────────────────── + +/** + * Extract YAML content from agent output. + * Looks for ```yaml ... ``` blocks, or falls back to lines starting with "- heading:" + */ +export function extractYaml(agentOutput: string): string | null { + // Try to extract from fenced YAML code block + const fenced = agentOutput.match(/```ya?ml\s*\n([\s\S]*?)```/) + if (fenced) return fenced[1].trim() + + // Fall back: look for lines that look like YAML note entries + const lines = agentOutput.split('\n') + const yamlLines: string[] = [] + let inYaml = false + for (const line of lines) { + if (line.match(/^-\s+heading:/)) { + inYaml = true + } + if (inYaml) { + // Stop if we hit a non-YAML line (not indented, not a list item, not a comment, not empty) + if (line.trim() && !line.match(/^[\s#-]/) && !line.match(/^\s+\w+:/)) { + break + } + yamlLines.push(line) + } + } + return yamlLines.length > 0 ? yamlLines.join('\n').trim() : null +} + +// ─── extractSkipReason ─────────────────────────────────────────────────────── + +/** + * Extract a skip reason from YAML that contains `# SKIP: ` followed by `[]`. + */ +export function extractSkipReason(yamlStr: string): string | null { + const match = yamlStr.match(/^#\s*SKIP:\s*(.+)/m) + return match ? match[1].trim() : null +} + +// ─── parseNoteEntries ──────────────────────────────────────────────────────── + +/** + * Parse extracted YAML into structured note entries + */ +export function parseNoteEntries(yamlStr: string, sourceUrl: string): NoteEntry[] { + const entries: NoteEntry[] = [] + + try { + const parsed = yaml.load(yamlStr) + if (!Array.isArray(parsed)) return entries + + for (const item of parsed) { + if (item && typeof item.heading === 'string' && Array.isArray(item.notes)) { + const heading = item.heading.trim() + if (!heading) continue + const notes = item.notes + .filter((n: unknown) => typeof n === 'string') + .map((n: string) => n.trim()) + if (notes.length > 0) { + entries.push({ + heading, + notes, + sourceUrl, + }) + } + } + } + } catch { + // YAML parse failed + } + + return entries +} + +// ─── loadExistingEntries ───────────────────────────────────────────────────── + +/** + * Parse an existing release notes YAML file and extract NoteEntry[] from it, + * along with a set of source issue URLs already covered. + * Returns { entries, coveredUrls } or null if the file doesn't exist. + */ +export function loadExistingEntries(yamlPath: string): { + entries: NoteEntry[] + coveredUrls: Set +} | null { + if (!fs.existsSync(yamlPath)) return null + + const content = fs.readFileSync(yamlPath, 'utf8') + return loadExistingEntriesFromString(content) +} + +/** + * Parse release notes YAML content (as a string) and extract NoteEntry[] from it. + * This is the testable core — no file I/O. + * + * Note: This uses manual line-by-line parsing instead of js-yaml because we need + * to preserve the `# https://github.com/.../issues/NNN` source URL comments that + * precede each note. YAML comments are stripped by js-yaml.load() and aren't part + * of the YAML data model, so a standard parser can't track the comment-to-note + * relationship we rely on for incremental mode and deduplication. + */ +export function loadExistingEntriesFromString(content: string): { + entries: NoteEntry[] + coveredUrls: Set +} { + const entries: NoteEntry[] = [] + const coveredUrls = new Set() + + const lines = content.split('\n') + let currentSourceUrl: string | null = null + let currentHeading: string | null = null + let currentNote: string[] = [] + let inNote = false + + const flushNote = () => { + if (currentSourceUrl && currentHeading && currentNote.length > 0) { + const noteText = currentNote.join('\n').trim() + if (noteText && noteText !== '...') { + const existing = entries.find( + (e) => e.heading === currentHeading && e.sourceUrl === currentSourceUrl, + ) + if (existing) { + existing.notes.push(noteText) + } else { + entries.push({ + heading: currentHeading!, + notes: [noteText], + sourceUrl: currentSourceUrl!, + }) + } + coveredUrls.add(currentSourceUrl) + } + } + currentNote = [] + inNote = false + } + + let currentSection: string | null = null + + for (const line of lines) { + const headingMatch = line.match(/^\s+-\s+heading:\s+(.+)/) + if (headingMatch) { + flushNote() + currentHeading = headingMatch[1].trim() + continue + } + + const sectionMatch = line.match(/^\s+(changes|closing_down|retired|known_issues):/) + if (sectionMatch) { + flushNote() + currentSection = sectionMatch[1] + if (currentSection === 'changes') currentHeading = 'Changes' + else if (currentSection === 'closing_down') currentHeading = 'Closing down' + else if (currentSection === 'retired') currentHeading = 'Retired' + else currentHeading = null // known_issues — skip + continue + } + + if (line.match(/^\s+features:/)) { + flushNote() + currentSection = 'features' + continue + } + + const urlMatch = line.match(/^\s*#\s*(https:\/\/github\.com\/github\/releases\/issues\/\d+)/) + if (urlMatch) { + flushNote() + currentSourceUrl = urlMatch[1] + continue + } + + if (line.match(/^\s+-\s+\|\s*$/)) { + flushNote() + inNote = true + continue + } + + if (inNote) { + if (line.trim() === '' || line.match(/^\s{4,}/)) { + currentNote.push(line.replace(/^\s{6,}/, '').trimEnd()) + } else { + flushNote() + const reHeading = line.match(/^\s+-\s+heading:\s+(.+)/) + if (reHeading) { + currentHeading = reHeading[1].trim() + continue + } + const reSection = line.match(/^\s+(changes|closing_down|retired|known_issues):/) + if (reSection) { + currentSection = reSection[1] + if (currentSection === 'changes') currentHeading = 'Changes' + else if (currentSection === 'closing_down') currentHeading = 'Closing down' + else if (currentSection === 'retired') currentHeading = 'Retired' + else currentHeading = null + continue + } + if (line.match(/^\s+features:/)) { + currentSection = 'features' + continue + } + const reUrl = line.match(/^\s*#\s*(https:\/\/github\.com\/github\/releases\/issues\/\d+)/) + if (reUrl) { + currentSourceUrl = reUrl[1] + continue + } + if (line.match(/^\s+-\s+\|\s*$/)) { + inNote = true + continue + } + } + } + } + flushNote() + + return { entries, coveredUrls } +} + +// ─── buildReleaseNotesYaml ─────────────────────────────────────────────────── + +/** + * Append YAML lines for a list of note entries at a given indentation level. + * Handles the `# sourceUrl`, `- |`, and multi-line note content pattern. + */ +export function appendNoteLines(lines: string[], noteEntries: NoteEntry[], indent: string): void { + for (const entry of noteEntries) { + lines.push(`${indent}# ${entry.sourceUrl}`) + for (const note of entry.notes) { + lines.push(`${indent}- |`) + for (const noteLine of note.split('\n')) { + lines.push(`${indent} ${noteLine}`) + } + } + } +} + +/** + * Build the final release notes YAML string from note entries. + */ +export function buildReleaseNotesYaml( + noteEntries: NoteEntry[], + releaseCandidate: boolean, + featureHeadings: string[], +): string { + const today = new Date().toISOString().split('T')[0] + const lines: string[] = [] + + lines.push(`date: '${today}'`) + lines.push(`release_candidate: ${releaseCandidate}`) + lines.push('deprecated: false') + + if (releaseCandidate) { + lines.push('intro: |') + lines.push( + ' > [!NOTE] Release candidate (RC) builds are intended solely for use in a test environment. Do not install an RC in a production environment.', + ) + lines.push(' >') + lines.push(' > Do not upgrade to an RC from a supported, earlier version.') + lines.push(' >') + lines.push( + ' > If {% data variables.location.product_location %} is running an RC, you cannot upgrade to the general availability (GA) release. You also cannot upgrade with a hotpatch.', + ) + lines.push('') + lines.push( + ' For upgrade instructions, see [AUTOTITLE](/admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process).', + ) + } else { + lines.push('intro: |') + lines.push('') + } + + lines.push('sections:') + + // ── Features (grouped by heading) ── + const featureEntries = noteEntries.filter((e) => featureHeadings.includes(e.heading)) + const otherEntries = noteEntries.filter((e) => !featureHeadings.includes(e.heading)) + + lines.push('') + lines.push(' features:') + + if (featureEntries.length > 0) { + // Group by heading, preserving template order + const byHeading = new Map() + for (const entry of featureEntries) { + const existing = byHeading.get(entry.heading) || [] + existing.push(entry) + byHeading.set(entry.heading, existing) + } + + for (const heading of featureHeadings) { + const entries = byHeading.get(heading) + if (!entries) continue + + lines.push('') + lines.push(` - heading: ${heading}`) + lines.push(' notes:') + appendNoteLines(lines, entries, ' ') + } + } else { + lines.push(' # TODO: Add feature notes') + } + + // ── Changes ── + const changeEntries = otherEntries.filter((e) => !['Closing down', 'Retired'].includes(e.heading)) + if (changeEntries.length > 0) { + lines.push('') + lines.push(' changes:') + appendNoteLines(lines, changeEntries, ' ') + } + + // ── Known issues ── + lines.push('') + lines.push(' known_issues:') + lines.push(' # TODO: Add known issues from "GHES Release Note Tracking" project') + lines.push(' - |') + lines.push(' ...') + + // ── Closing down ── + const closingEntries = otherEntries.filter((e) => e.heading === 'Closing down') + if (closingEntries.length > 0) { + lines.push('') + lines.push(' closing_down:') + appendNoteLines(lines, closingEntries, ' ') + } + + // ── Retired ── + const retiredEntries = otherEntries.filter((e) => e.heading === 'Retired') + if (retiredEntries.length > 0) { + lines.push('') + lines.push(' retired:') + appendNoteLines(lines, retiredEntries, ' ') + } + + lines.push('') + return lines.join('\n') +} diff --git a/src/ghes-releases/scripts/README.md b/src/ghes-releases/scripts/README.md new file mode 100644 index 000000000000..ca5c650ba73e --- /dev/null +++ b/src/ghes-releases/scripts/README.md @@ -0,0 +1,176 @@ +# Automated GHES release notes + +This guide covers the automated pipeline for drafting, reviewing, and approving GHES release notes. The process has three steps: + +1. **Generate** release notes from `github/releases` issues +2. **Notify** PMs to review their notes +3. **Check** approval status before merging + +## Prerequisites + +* `gh` CLI installed and authenticated (with access to `github/releases` and `github/blog`) +* [Copilot CLI](https://docs.github.com/en/copilot/using-github-copilot/using-github-copilot-in-the-command-line) installed (for the generate step) +* Node.js and this repo cloned locally + +## Quick start + +```bash +# 1. Generate release notes for GHES 3.21 (GA) +npm run generate-release-notes -- --release 3.21 + +# 2. After you open a PR with the generated file, notify PMs to review (add --dry-run to test) +npm run notify-release-pms -- --release 3.21 --pr 12345 + +# 3. Later, check who has approved +npm run check-release-approvals -- --release 3.21 +``` + +--- + +## Step 1: Generate release notes + +Fetches open issues from `github/releases`, finds matching changelog PRs in `github/blog`, and uses a Copilot agent (based on this [Copilot Space](https://github.com/copilot/spaces/github/133)) to draft a release note for each issue. Output is written to `data/release-notes/enterprise-server/`. + +```bash +npm run generate-release-notes -- --release [options] +``` + +### Options + +| Flag | Required | Description | +|------|----------|-------------| +| `--release ` | Yes | GHES version number, e.g. `3.21` | +| `--rc` | No | Generate release candidate notes (omit for GA) | +| `--issue ` | No | Process a single issue instead of all open issues | +| `--force` | No | Regenerate YML file from scratch, ignoring any existing file (default updates the file in place) | +| `--stdout` | No | Print output to the terminal instead of writing to a file | + +### How it works + +* The script is **incremental by default**. If a release notes file already exists, it loads those entries and only processes new issues. Use `--force` to start fresh. +* If you run `--issue 6768`, it replaces just that issue's entry in the existing file. +* The file is updated after each issue, so if you cancel with Ctrl+C, you won't lose changes. +* The Copilot agent follows the style rules defined in `.github/agents/ghes-release-notes.md`: present tense, `[AUTOTITLE]` links, proper Liquid variable usage, etc. + +### Examples + +```bash +# Generate RC notes for 3.21 +npm run generate-release-notes -- --release 3.21 --rc + +# Re-run a single issue and preview without writing a file +npm run generate-release-notes -- --release 3.21 --issue 6768 --stdout + +# Regenerate everything from scratch +npm run generate-release-notes -- --release 3.21 --force +``` + +--- + +## Step 2: Notify PMs + +After you open a pull request with the generated notes, this script posts a review comment on each source issue in `github/releases`. The comment asks the PM to review their note in the docs PR and react with 🚀 when they approve. + +```bash +npm run notify-release-pms -- --release --pr [options] +``` + +### Options + +| Flag | Required | Description | +|------|----------|-------------| +| `--release ` | Yes | GHES version number, e.g. `3.21` | +| `--pr ` | Yes | The docs PR number containing the release notes | +| `--rc` | No | Treat as a release candidate (auto-detected if omitted) | +| `--ga` | No | Treat as a GA release (only needed if both RC and GA files exist and you want to target GA instead of the default) | +| `--dry-run` | No | Print comments to the terminal instead of posting them | +| `--review-date ` | No | Override the review deadline (YYYY-MM-DD). Defaults to the next weekday 10 days from now. | + +### How it works + +* Auto-detects RC vs GA from whichever release notes file exists. If both exist, defaults to GA; use `--rc` to override. +* Skips issues that have already been notified (safe to re-run). +* Each comment includes a direct link to the relevant section of the docs PR. + +### Examples + +```bash +# Notify PMs for a GA release +npm run notify-release-pms -- --release 3.21 --pr 12345 + +# Preview what would be posted without actually commenting +npm run notify-release-pms -- --release 3.21 --pr 12345 --dry-run + +# Preview before opening a PR (use any number as a placeholder) +npm run notify-release-pms -- --release 3.21 --pr 0 --dry-run + +# Set a specific review deadline (overrides the 10-days-in-the-future default) +npm run notify-release-pms -- --release 3.21 --pr 12345 --review-date 2026-04-25 +``` + +--- + +## Step 3: Check approvals + +Checks which PMs have approved their release notes by looking for 🚀 reactions on the notification comments. + +```bash +npm run check-release-approvals -- --release [options] +``` + +### Options + +| Flag | Required | Description | +|------|----------|-------------| +| `--release ` | Yes | GHES version number, e.g. `3.21` | +| `--rc` | No | Check the release candidate file (auto-detected if omitted) | +| `--ga` | No | Check the GA release file (only needed if both RC and GA files exist and you want to target GA instead of the default) | +| `--json` | No | Output results as JSON | + +### Status indicators + +| Icon | Meaning | +|------|---------| +| 🚀 | Approved | +| ⏳ | Pending; waiting for PM review | +| 💬 | Has replies; PM may have left feedback | +| ⚪ | Not notified yet | + +The script exits with code **0** if all issues are approved, or **1** if any are still pending. + +### Examples + +```bash +# Check approval status +npm run check-release-approvals -- --release 3.21 + +# Get machine-readable output +npm run check-release-approvals -- --release 3.21 --json +``` + +--- + +## Typical workflow + +1. **Generate notes:** `npm run generate-release-notes -- --release 3.21 --rc` +2. **Review the output** in `data/release-notes/enterprise-server/3-21/0-rc1.yml`—clean up any TODO placeholders or unknown headings. +3. **Open a draft PR** with the generated file. +4. **Notify PMs:** `npm run notify-release-pms -- --release 3.21 --rc --pr ` +5. **Wait for approvals.** PMs react with 🚀 on their release issues. +6. **Check status:** `npm run check-release-approvals -- --release 3.21 --rc` +7. Once all approved, finalize the PR. + +## Troubleshooting + +| Problem | Solution | +|---------|----------| +| "Copilot CLI not found" | Install via `npm install -g @github/copilot@prerelease` or ensure VS Code Copilot Chat extension is installed | +| Agent returns empty notes | The issue may not have enough context. Try adding a changelog PR link to the issue body and re-running with `--issue` | +| "All issues already have notes" | The file already covers every open issue. Use `--force` to regenerate, or `--issue ` to update one | +| PM didn't get a notification | Re-run `notify-release-pms`—it's safe to run multiple times and won't double-post | + +## Related files + +* `.github/agents/ghes-release-notes.md` — Copilot agent instructions (style rules, output format) +* `data/release-notes/PLACEHOLDER-TEMPLATE.yml` — Source of truth for feature headings +* `data/release-notes/enterprise-server/` — Generated release notes files diff --git a/src/ghes-releases/scripts/check-release-approvals.ts b/src/ghes-releases/scripts/check-release-approvals.ts new file mode 100644 index 000000000000..93e02f117778 --- /dev/null +++ b/src/ghes-releases/scripts/check-release-approvals.ts @@ -0,0 +1,267 @@ +/** + * @purpose Writer tool + * @description Check PM approval status for GHES release notes + * + * Scans release issues that were previously notified by `notify-release-pms` + * and checks for 🚀 reactions on the notification comments. + * + * Usage: + * npm run check-release-approvals -- --release 3.20 [--rc|--ga] + */ +import { Command } from 'commander' +import { execFileSync } from 'child_process' +import fs from 'fs' +import path from 'path' +import ora from 'ora' + +// ─── Types ─────────────────────────────────────────────────────────────────── + +interface ApprovalStatus { + issueNumber: number + issueUrl: string + commentId: number | null + approved: boolean + rocketCount: number + rocketUsers: string[] + hasReplies: boolean +} + +// ─── Helpers ───────────────────────────────────────────────────────────────── + +/** + * Run `gh` CLI commands with native auth (no GITHUB_TOKEN interference) + */ +function gh(args: string[]): string { + const env = { ...process.env } + delete env.GITHUB_TOKEN + return execFileSync('gh', args, { + encoding: 'utf8', + stdio: ['pipe', 'pipe', 'pipe'], + env, + maxBuffer: 10 * 1024 * 1024, + }) +} + +/** + * Extract unique release issue numbers from a YAML file's source comments. + */ +function extractIssueNumbers(yamlPath: string): number[] { + const content = fs.readFileSync(yamlPath, 'utf8') + const numbers = new Set() + const regex = /^\s*#\s*https:\/\/github\.com\/github\/releases\/issues\/(\d+)/gm + let match + while ((match = regex.exec(content)) !== null) { + numbers.add(parseInt(match[1], 10)) + } + return [...numbers] +} + +/** + * Find our notification comment on an issue and check its reactions. + */ +function checkIssueApproval(issueNumber: number, marker: string): ApprovalStatus { + const issueUrl = `https://github.com/github/releases/issues/${issueNumber}` + const result: ApprovalStatus = { + issueNumber, + issueUrl, + commentId: null, + approved: false, + rocketCount: 0, + rocketUsers: [], + hasReplies: false, + } + + try { + // Fetch all comments on the issue + const commentsJson = gh([ + 'api', + `repos/github/releases/issues/${issueNumber}/comments`, + '--paginate', + ]) + const comments = JSON.parse(commentsJson) as Array<{ + id: number + body: string + created_at: string + }> + + // Find our notification comment (use findLast so re-runs pick up the latest) + const ourComment = comments.findLast((c) => c.body.includes(marker)) + if (!ourComment) { + return result + } + + result.commentId = ourComment.id + + // Check if there are replies after our comment (indicating feedback) + const ourCommentTime = new Date(ourComment.created_at).getTime() + result.hasReplies = comments.some( + (c) => c.id !== ourComment.id && new Date(c.created_at).getTime() > ourCommentTime, + ) + + // Fetch reactions on our comment + const reactionsJson = gh([ + 'api', + `repos/github/releases/issues/comments/${ourComment.id}/reactions`, + '--paginate', + ]) + const reactions = JSON.parse(reactionsJson) as Array<{ + content: string + user: { login: string } + }> + + const rockets = reactions.filter((r) => r.content === 'rocket') + result.rocketCount = rockets.length + result.rocketUsers = rockets.map((r) => r.user.login) + result.approved = rockets.length > 0 + } catch { + // API error — leave as unapproved + } + + return result +} + +// ─── CLI ───────────────────────────────────────────────────────────────────── + +const program = new Command() + +program + .name('check-release-approvals') + .description('Check PM approval status for generated GHES release notes') + .requiredOption('-r, --release ', 'GHES release number (e.g., 3.20)') + .option('--rc', 'Check the release candidate file') + .option('--ga', 'Check the GA release file') + .option('--json', 'Output results as JSON') + .action((options: { release: string; rc?: boolean; ga?: boolean; json?: boolean }) => { + const { release } = options + const spinner = ora() + + // Validate release version format + if (!/^\d+\.\d+$/.test(release)) { + console.error( + `Error: Invalid release version format "${release}". Expected: X.Y (e.g., 3.20)`, + ) + process.exit(1) + } + + // Determine which file to check + const dirName = release.replace('.', '-') + const rcPath = path.join( + process.cwd(), + 'data/release-notes/enterprise-server', + dirName, + '0-rc1.yml', + ) + const gaPath = path.join( + process.cwd(), + 'data/release-notes/enterprise-server', + dirName, + '0.yml', + ) + + let yamlPath: string + if (options.rc) { + yamlPath = rcPath + } else if (options.ga) { + yamlPath = gaPath + } else { + // Auto-detect: prefer GA if it exists, otherwise RC (consistent with generate-release-notes) + if (fs.existsSync(gaPath)) { + yamlPath = gaPath + } else if (fs.existsSync(rcPath)) { + yamlPath = rcPath + } else { + console.error(`Error: No release notes file found for ${release}.`) + process.exit(1) + } + } + + if (!fs.existsSync(yamlPath)) { + console.error(`Error: File not found: ${yamlPath}`) + process.exit(1) + } + + const relativeFilePath = path.relative(process.cwd(), yamlPath) + + // ── Step 1: Extract issue numbers ── + spinner.start('Parsing release notes file...') + const issueNumbers = extractIssueNumbers(yamlPath) + spinner.succeed(`Found ${issueNumbers.length} release issue(s) in ${relativeFilePath}`) + + if (issueNumbers.length === 0) { + console.log('No release issues found.') + process.exit(0) + } + + // ── Step 2: Check each issue ── + const isRc = yamlPath === rcPath + const releaseType = isRc ? 'rc' : 'ga' + const marker = `` + const statuses: ApprovalStatus[] = [] + + for (let i = 0; i < issueNumbers.length; i++) { + const issueNumber = issueNumbers[i] + spinner.start(`[${i + 1}/${issueNumbers.length}] Checking #${issueNumber}...`) + const status = checkIssueApproval(issueNumber, marker) + statuses.push(status) + spinner.succeed( + `[${i + 1}/${issueNumbers.length}] #${issueNumber} — ${ + status.commentId === null + ? '⚪ Not notified' + : status.approved + ? `🚀 Approved (${status.rocketUsers.join(', ')})` + : status.hasReplies + ? '💬 Has replies (pending)' + : '⏳ Pending' + }`, + ) + } + + // ── Step 3: Output results ── + if (options.json) { + console.log(JSON.stringify(statuses, null, 2)) + return + } + + // Summary table + const approved = statuses.filter((s) => s.approved) + const pending = statuses.filter((s) => s.commentId !== null && !s.approved) + const notNotified = statuses.filter((s) => s.commentId === null) + const withReplies = pending.filter((s) => s.hasReplies) + + console.log(`\n${'═'.repeat(60)}`) + console.log(`GHES ${release} Release Note Approval Status`) + console.log(`${'═'.repeat(60)}`) + console.log(` 🚀 Approved: ${approved.length}/${statuses.length}`) + if (pending.length > 0) { + console.log(` ⏳ Pending: ${pending.length}`) + } + if (withReplies.length > 0) { + console.log(` 💬 Has replies: ${withReplies.length} (may have feedback)`) + } + if (notNotified.length > 0) { + console.log(` ⚪ Not notified: ${notNotified.length}`) + } + + // List pending issues for easy follow-up + if (pending.length > 0) { + console.log(`\nPending review:`) + for (const s of pending) { + const suffix = s.hasReplies ? ' 💬' : '' + console.log(` #${s.issueNumber} — ${s.issueUrl}${suffix}`) + } + } + + if (notNotified.length > 0) { + console.log(`\nNot yet notified (run notify-release-pms first):`) + for (const s of notNotified) { + console.log(` #${s.issueNumber} — ${s.issueUrl}`) + } + } + + // Exit code: 0 if all approved, 1 if any pending + if (approved.length < statuses.length) { + process.exit(1) + } + }) + +program.parse(process.argv) diff --git a/src/ghes-releases/scripts/create-enterprise-issue.ts b/src/ghes-releases/scripts/create-enterprise-issue.ts index 5490543bd7f2..9e48f4d5745a 100644 --- a/src/ghes-releases/scripts/create-enterprise-issue.ts +++ b/src/ghes-releases/scripts/create-enterprise-issue.ts @@ -1,3 +1,7 @@ +/** + * @purpose Writer tool + * @description Create release tracking issues for a new GHES version + */ import { readFileSync } from 'fs' import { basename } from 'path' import { Liquid } from 'liquidjs' diff --git a/src/ghes-releases/scripts/deprecate/update-content.ts b/src/ghes-releases/scripts/deprecate/update-content.ts index 36d0e56ef801..e11f67c284a4 100644 --- a/src/ghes-releases/scripts/deprecate/update-content.ts +++ b/src/ghes-releases/scripts/deprecate/update-content.ts @@ -58,7 +58,12 @@ export function updateContentFiles() { // To preserve newlines when stringifying, // you can set the lineWidth option to -1 // This prevents updates to the file that aren't actual changes. - fs.writeFileSync(file, frontmatter.stringify(content!, data, { lineWidth: -1 } as any)) + fs.writeFileSync( + file, + frontmatter.stringify(content!, data, { lineWidth: -1 } as unknown as Parameters< + typeof frontmatter.stringify + >[2]), + ) continue } if (featureAppliesToAllVersions) { @@ -71,7 +76,12 @@ export function updateContentFiles() { // To preserve newlines when stringifying, // you can set the lineWidth option to -1 // This prevents updates to the file that aren't actual changes. - fs.writeFileSync(file, frontmatter.stringify(content!, data, { lineWidth: -1 } as any)) + fs.writeFileSync( + file, + frontmatter.stringify(content!, data, { lineWidth: -1 } as unknown as Parameters< + typeof frontmatter.stringify + >[2]), + ) continue } @@ -94,7 +104,12 @@ export function updateContentFiles() { // Remove the ghes property from versions Fm and return delete data.versions.ghes console.log('Removing GHES version from: ', file) - fs.writeFileSync(file, frontmatter.stringify(content!, data, { lineWidth: -1 } as any)) + fs.writeFileSync( + file, + frontmatter.stringify(content!, data, { lineWidth: -1 } as unknown as Parameters< + typeof frontmatter.stringify + >[2]), + ) } } } @@ -130,7 +145,9 @@ function removeFileUpdateParent(filePath: string) { console.log('..Updating children in: ', parentFilePath) fs.writeFileSync( parentFilePath, - frontmatter.stringify(content || '', data, { lineWidth: -1 } as any), + frontmatter.stringify(content || '', data, { lineWidth: -1 } as unknown as Parameters< + typeof frontmatter.stringify + >[2]), ) } } diff --git a/src/ghes-releases/scripts/generate-release-notes.ts b/src/ghes-releases/scripts/generate-release-notes.ts new file mode 100644 index 000000000000..ca0fb075554e --- /dev/null +++ b/src/ghes-releases/scripts/generate-release-notes.ts @@ -0,0 +1,854 @@ +/** + * @purpose Writer tool + * @description Generate GHES release notes from github/releases issues using Copilot CLI + * + * Generate GHES release notes by: + * 1. Querying github/releases for open issues labeled "GHES " + * 2. Finding corresponding changelog PRs in github/blog + * 3. Running each through the ghes-release-notes agent via Copilot CLI + * 4. Stitching the YAML outputs into a release notes file + */ +import { Command } from 'commander' +import { execFileSync, spawn, type ChildProcess } from 'child_process' +import fs from 'fs' +import os from 'os' +import path from 'path' +import ora from 'ora' +import yaml from 'js-yaml' + +import { + type NoteEntry, + extractYaml, + extractSkipReason, + parseNoteEntries, + loadExistingEntries, + buildReleaseNotesYaml, + appendNoteLines, +} from '@/ghes-releases/lib/parse-release-notes' + +// ─── Ctrl+C handling ───────────────────────────────────────────────────────── +// Copilot CLI puts the terminal in raw mode, so we catch Ctrl+C (0x03) manually. + +let activeChild: ChildProcess | null = null +let flushBeforeExit: (() => void) | null = null + +if (process.stdin.isTTY) { + process.stdin.setRawMode(true) + process.stdin.resume() + process.stdin.on('data', (key: Buffer) => { + if (key[0] !== 0x03) return + if (activeChild?.pid) { + try { + process.kill(-activeChild.pid, 'SIGKILL') + } catch {} + } + if (flushBeforeExit) flushBeforeExit() + try { + execFileSync('stty', ['sane'], { stdio: 'ignore' }) + } catch {} + process.exit(130) + }) +} + +// ─── Types ─────────────────────────────────────────────────────────────────── + +interface ReleaseIssue { + number: number + title: string + url: string + body: string + labels: { name: string }[] +} + +// Source of truth: data/release-notes/PLACEHOLDER-TEMPLATE.yml +let _featureHeadingsCache: string[] | null = null +function loadFeatureHeadings(): string[] { + if (_featureHeadingsCache) return _featureHeadingsCache + const templatePath = path.join(process.cwd(), 'data/release-notes/PLACEHOLDER-TEMPLATE.yml') + const templateContent = fs.readFileSync(templatePath, 'utf8') + const template = yaml.load(templateContent) as { + sections?: { features?: Array<{ heading: string }> } + } + const features = template?.sections?.features + if (!Array.isArray(features)) { + throw new Error('Could not parse feature headings from PLACEHOLDER-TEMPLATE.yml') + } + _featureHeadingsCache = features.map((f) => f.heading).filter(Boolean) + return _featureHeadingsCache +} + +// ─── Helpers ───────────────────────────────────────────────────────────────── + +/** + * Run `gh` CLI commands with native auth (no GITHUB_TOKEN interference) + */ +function gh(args: string[]): string { + const env = { ...process.env } + delete env.GITHUB_TOKEN + return execFileSync('gh', args, { + encoding: 'utf8', + stdio: ['pipe', 'pipe', 'pipe'], + env, + maxBuffer: 10 * 1024 * 1024, + }) +} + +/** + * Fetch open release issues labeled "GHES " + */ +function fetchReleaseIssues(version: string): ReleaseIssue[] { + const label = `GHES ${version}` + const output = gh([ + 'issue', + 'list', + '--repo', + 'github/releases', + '--label', + label, + '--state', + 'open', + '--limit', + '200', + '--json', + 'number,title,url,body,labels', + ]) + return JSON.parse(output) as ReleaseIssue[] +} + +interface ChangelogInfo { + url: string + body: string | null +} + +/** + * Try to extract a changelog PR URL from a release issue body. + * Looks for patterns like: + * 📄 **Changelog post:** https://github.com/github/blog/pull/1234 + */ +function extractChangelogPrUrl(issueBody: string): string | null { + const match = issueBody.match(/https:\/\/github\.com\/github\/blog\/pull\/\d+/) + return match ? match[0] : null +} + +/** + * Fetch the body of a changelog PR by URL. + */ +function fetchChangelogPrBody(prUrl: string): string | null { + try { + const output = gh(['pr', 'view', prUrl, '--json', 'body']) + const parsed = JSON.parse(output) as { body: string } + return parsed.body + } catch { + return null + } +} + +/** + * Search github/blog for a merged PR that references a release issue number. + * Caches the fetched PR list to avoid redundant API calls. + * Returns URL + body when found. + */ +let _blogPrsCache: { number: number; body: string; url: string }[] | null = null +function searchChangelogPr(issueNumber: number): ChangelogInfo | null { + try { + if (!_blogPrsCache) { + const sixMonthsAgo = new Date() + sixMonthsAgo.setMonth(sixMonthsAgo.getMonth() - 6) + const since = sixMonthsAgo.toISOString().split('T')[0] + + const output = gh([ + 'pr', + 'list', + '--repo', + 'github/blog', + '--state', + 'merged', + '--search', + `Changelog in:title merged:>=${since}`, + '--limit', + '200', + '--json', + 'number,body,url', + ]) + _blogPrsCache = JSON.parse(output) as { number: number; body: string; url: string }[] + } + + for (const pr of _blogPrsCache) { + if ( + pr.body.includes( + `**Release issue:** https://github.com/github/releases/issues/${issueNumber}`, + ) + ) { + return { url: pr.url, body: pr.body } + } + } + } catch { + // Search failed — fall back to no changelog + } + return null +} + +/** + * Find the changelog PR for a release issue, checking the issue body first, + * then falling back to searching github/blog. Returns URL + body. + */ +function findChangelogPr(issue: ReleaseIssue): ChangelogInfo | null { + const fromBody = extractChangelogPrUrl(issue.body) + if (fromBody) { + const body = fetchChangelogPrBody(fromBody) + return { url: fromBody, body } + } + return searchChangelogPr(issue.number) +} + +/** + * Resolve the Copilot CLI path. Checks common locations. + * Result is cached after first call. + */ +let _copilotCliPath: string | null = null +function findCopilotCli(): string { + if (_copilotCliPath) return _copilotCliPath + + // Check if `copilot` is on PATH + try { + const result = execFileSync('which', ['copilot'], { encoding: 'utf8' }).trim() + if (result) { + _copilotCliPath = result + return result + } + } catch { + // not on PATH + } + + // Fallback: check VS Code extension storage locations. + // These paths are macOS-only. On Linux/Windows the `which` check above should + // find Copilot CLI if it's installed globally. If needed, add platform-specific + // paths here (e.g., ~/.config/Code/User/globalStorage/... for Linux). + const homeDir = os.homedir() + const vsCodePath = path.join( + homeDir, + 'Library/Application Support/Code - Insiders/User/globalStorage/github.copilot-chat/copilotCli/copilot', + ) + if (fs.existsSync(vsCodePath)) { + _copilotCliPath = vsCodePath + return vsCodePath + } + + // Check VS Code stable location (macOS) + const vsCodeStablePath = path.join( + homeDir, + 'Library/Application Support/Code/User/globalStorage/github.copilot-chat/copilotCli/copilot', + ) + if (fs.existsSync(vsCodeStablePath)) { + _copilotCliPath = vsCodeStablePath + return vsCodeStablePath + } + + throw new Error('Copilot CLI not found. Install via: npm install -g @github/copilot@prerelease') +} + +/** + * Run the ghes-release-notes agent on a release issue (+optional changelog PR) + * via Copilot CLI and return the raw output. + * Uses async spawn so SIGINT (Ctrl+C) is not blocked. + */ +interface AgentContext { + issueUrl: string + issueTitle: string + issueBody: string + changelogUrl: string | null + changelogBody: string | null + featureHeadings: string[] +} + +/** + * Extract the title tag (e.g., "GA", "Public Preview") from a release issue title. + */ +function parseTitleTag(title: string): string | null { + const match = title.match(/\[(GA|Public Preview|Beta|Private Preview|Closing Down|Retired)\]/i) + return match ? match[1] : null +} + +function runAgent(ctx: AgentContext): Promise { + const copilotPath = findCopilotCli() + + const titleTag = parseTitleTag(ctx.issueTitle) + + // Build an optimized prompt that pre-includes all context so the agent + // doesn't need to make tool calls to fetch it. + let prompt = `You are running in non-interactive mode. Do NOT ask any follow-up questions. ` + prompt += `Generate a release note for ${ctx.issueUrl}. ` + prompt += `Follow the ghes-release-notes agent instructions. ` + prompt += `Return ONLY a single YAML code block (\`\`\`yaml ... \`\`\`). No conversation, no questions, no explanations outside the code block.\n\n` + + // Pre-supply the title tag so the agent doesn't need to re-parse + if (titleTag) { + prompt += `The issue title tag is [${titleTag}].\n\n` + } + + // Pre-supply valid headings so the agent doesn't need to read PLACEHOLDER-TEMPLATE.yml + prompt += `IMPORTANT: Do NOT read PLACEHOLDER-TEMPLATE.yml or data/variables/product.yml — all necessary context is provided below.\n\n` + prompt += `Valid feature headings (use ONLY these for feature notes):\n` + for (const h of ctx.featureHeadings) { + prompt += `- ${h}\n` + } + prompt += `\nFor non-feature notes, use: Changes, Closing down, or Retired.\n\n` + + // Pre-supply the issue body so the agent doesn't need to fetch it + prompt += `--- RELEASE ISSUE (${ctx.issueUrl}) ---\n` + prompt += `Title: ${ctx.issueTitle}\n` + prompt += ctx.issueBody.substring(0, 15000) + prompt += `\n--- END RELEASE ISSUE ---\n\n` + + // Pre-supply the changelog PR body if available + if (ctx.changelogUrl && ctx.changelogBody) { + prompt += `--- CHANGELOG PR (${ctx.changelogUrl}) ---\n` + prompt += ctx.changelogBody.substring(0, 10000) + prompt += `\n--- END CHANGELOG PR ---\n\n` + } else if (ctx.changelogUrl) { + prompt += `Changelog PR: ${ctx.changelogUrl} (body not available — fetch it if needed).\n\n` + } + + const env = { ...process.env } + delete env.GITHUB_TOKEN + + return new Promise((resolve, reject) => { + const child = spawn( + copilotPath, + [ + '--agent', + 'ghes-release-notes', + '-p', + prompt, + '--available-tools=view', + '--allow-tool=view', + '--add-dir', + process.cwd(), + ], + { + env, + stdio: ['ignore', 'pipe', 'pipe'], + detached: true, // Own process group so we can kill the tree with -pid + }, + ) + + activeChild = child + + let stdout = '' + let stderr = '' + let timedOut = false + child.stdout?.on('data', (data: Buffer) => { + stdout += data.toString() + }) + child.stderr?.on('data', (data: Buffer) => { + stderr += data.toString() + }) + + const timeout = setTimeout(() => { + timedOut = true + // Kill the entire process group (matches Ctrl+C handler) + if (child.pid) { + try { + process.kill(-child.pid, 'SIGKILL') + } catch { + child.kill('SIGKILL') + } + } + reject(new Error('Agent timed out after 5 minutes')) + }, 300_000) + + child.on('close', (code) => { + clearTimeout(timeout) + activeChild = null + if (process.stdin.isTTY) { + try { + execFileSync('stty', ['sane'], { stdio: 'ignore' }) + } catch {} + } + // If the timeout already rejected, don't settle the promise again + if (timedOut) return + if (code === 0 || stdout.length > 0) { + if (code !== 0) { + console.error( + ` ⚠ Agent exited with code ${code} but produced output (stderr: ${stderr.substring(0, 100)})`, + ) + } + resolve(stdout) + } else { + const errorOutput = stderr && stderr.length > 0 ? stderr : stdout || '(no output)' + reject(new Error(`Agent exited with code ${code}: ${errorOutput.substring(0, 200)}`)) + } + }) + + child.on('error', (err) => { + clearTimeout(timeout) + activeChild = null + if (timedOut) return + reject(err) + }) + }) +} + +/** + * Sleep for the given number of milliseconds (non-blocking). + */ +function sleep(ms: number): Promise { + return new Promise((resolve) => setTimeout(resolve, ms)) +} + +interface AgentResult { + kind: 'success' + yamlStr: string + rawOutput: string + attempts: number + skipWarning?: string +} + +/** + * Run the agent with retry logic. Retries up to `maxRetries` times on failure. + * Validates that extracted YAML parses into non-empty entries before accepting. + * If the agent tries to skip (returns `# SKIP: reason` + `[]`), treats it as a + * failed attempt and retries — issues that matched the GHES label filter should + * always get a release note. If all attempts result in skips, the last skip + * reason is attached as a warning. + */ +async function runAgentWithRetry(ctx: AgentContext, maxRetries = 2): Promise { + let lastError: Error | null = null + let lastRawOutput = '' + let lastSkipReason: string | null = null + for (let attempt = 1; attempt <= maxRetries + 1; attempt++) { + try { + const output = await runAgent(ctx) + lastRawOutput = output + const yamlStr = extractYaml(output) + if (yamlStr) { + // Detect agent skip signals and treat as retryable failures. + // The issue already matched GHES labels, so we always want a release note. + const skipReason = + extractSkipReason(yamlStr) || + (Array.isArray(yaml.load(yamlStr)) && (yaml.load(yamlStr) as unknown[]).length === 0 + ? extractSkipReason(output) + : null) + if (skipReason) { + lastSkipReason = skipReason + lastError = new Error(`Agent tried to skip: ${skipReason}`) + // Fall through to retry + } else { + // Validate that the YAML actually contains usable entries + const testEntries = parseNoteEntries(yamlStr, ctx.issueUrl) + if (testEntries.length > 0) { + return { + kind: 'success', + yamlStr, + rawOutput: output, + attempts: attempt, + skipWarning: lastSkipReason ?? undefined, + } + } + // YAML was extracted but empty/unparseable — retry + lastError = new Error( + `Agent returned YAML but it contained no valid entries (got: ${yamlStr.substring(0, 80)})`, + ) + } + } else { + lastError = new Error('No YAML output from agent') + } + } catch (error) { + lastError = error as Error + } + // Brief delay before retry + if (attempt <= maxRetries) { + await sleep(3000) + } + } + // Attach raw output to the error for debugging + const err = lastError || new Error('Agent failed after retries') + ;(err as Error & { rawOutput?: string }).rawOutput = lastRawOutput + throw err +} + +// ─── CLI ───────────────────────────────────────────────────────────────────── + +const program = new Command() + +program + .name('generate-release-notes') + .description( + 'Generate GHES release notes from github/releases issues using the ghes-release-notes agent', + ) + .requiredOption('-r, --release ', 'GHES release number (e.g., 3.20, 3.21)') + .option('--rc [boolean]', 'Generate release candidate notes (omit for GA)', (val: string) => { + // Support both `--rc` (no value → true) and `--rc true`/`--rc false` (legacy) + if (val === undefined || val === 'true') return true + if (val === 'false') return false + return true + }) + .option('--stdout', 'Print output to console instead of writing to file') + .option( + '-i, --issue ', + 'Process a single issue by number or URL (replaces its entry if it already exists)', + (val: string) => { + // Accept a full URL like https://github.com/github/releases/issues/6768 + const urlMatch = val.match(/\/issues\/(\d+)/) + if (urlMatch) return parseInt(urlMatch[1], 10) + const num = parseInt(val, 10) + if (isNaN(num)) { + console.error( + `Error: --issue must be a number or a github/releases issue URL, got "${val}"`, + ) + process.exit(1) + } + return num + }, + ) + .option('--force', 'Regenerate all notes from scratch, ignoring any existing file') + .action( + async (options: { + release: string + rc: boolean + stdout?: boolean + issue?: number + force?: boolean + }) => { + const { release, stdout, issue: singleIssue, force } = options + const rc = options.rc ?? false + const spinner = ora() + + // ── Prerequisite checks ── + try { + execFileSync('gh', ['--version'], { stdio: 'ignore' }) + } catch { + console.error( + 'Error: GitHub CLI (gh) is not installed or not on your PATH.\n' + + 'Install it from https://cli.github.com/ and run `gh auth login` to authenticate.', + ) + process.exit(1) + } + + try { + findCopilotCli() + } catch { + console.error( + 'Error: Copilot CLI is not installed.\n' + + "Install it from https://github.com/features/copilot/cli or via VS Code's GitHub Copilot Chat extension.", + ) + process.exit(1) + } + + // Validate release version format + if (!/^\d+\.\d+$/.test(release)) { + console.error( + `Error: Invalid release version format "${release}". Expected: X.Y (e.g., 3.20)`, + ) + process.exit(1) + } + + // ── Step 1: Fetch release issues ── + let issues: ReleaseIssue[] + + if (singleIssue) { + // For a single issue, fetch it directly — no need to list all issues + spinner.start(`Fetching issue #${singleIssue}...`) + try { + const output = gh([ + 'issue', + 'view', + String(singleIssue), + '--repo', + 'github/releases', + '--json', + 'number,title,url,body,labels', + ]) + const issue = JSON.parse(output) as ReleaseIssue + issues = [issue] + spinner.succeed(`Fetched issue #${singleIssue}: ${issue.title}`) + } catch (error) { + spinner.fail(`Failed to fetch issue #${singleIssue}: ${(error as Error).message}`) + process.exit(1) + } + } else { + spinner.start(`Fetching open issues labeled "GHES ${release}"...`) + try { + issues = fetchReleaseIssues(release) + spinner.succeed(`Found ${issues.length} open issues labeled "GHES ${release}"`) + } catch (error) { + spinner.fail(`Failed to fetch issues: ${(error as Error).message}`) + process.exit(1) + } + + if (issues.length === 0) { + console.log('No issues found. Nothing to generate.') + process.exit(0) + } + + // Filter out GA meta-issues (e.g., "GHES 3.20 GA [GA]") — these are tracking issues, not features + const originalCount = issues.length + issues = issues.filter((issue) => { + const title = issue.title.trim() + // Strip all trailing label tags like [GA], [Public Preview], etc. + const stripped = title.replace(/\s*\[[^\]]*\]/g, '').trim() + // Skip issues whose title is just "GHES X.Y GA" or "GHES X.Y release" + if (/^ghes\s+\d+\.\d+\s+ga$/i.test(stripped)) return false + if (/^ghes\s+\d+\.\d+\s+release$/i.test(stripped)) return false + return true + }) + const filteredCount = originalCount - issues.length + if (filteredCount > 0) { + console.log(` Filtered out ${filteredCount} meta-issue(s) (GA/release tracking)`) + } + + // Filter out [Private Preview] issues — these never get release notes + const beforePrivateFilter = issues.length + issues = issues.filter((issue) => { + return !/\[Private Preview\]/i.test(issue.title) + }) + const privateFilteredCount = beforePrivateFilter - issues.length + if (privateFilteredCount > 0) { + console.log( + ` Filtered out ${privateFilteredCount} private preview issue(s) (no release notes needed)`, + ) + } + + // Filter out issues labeled "internal release" — these are internal-only and don't get release notes + const beforeInternalFilter = issues.length + issues = issues.filter((issue) => { + return !issue.labels.some((l) => l.name.toLowerCase() === 'internal release') + }) + const internalFilteredCount = beforeInternalFilter - issues.length + if (internalFilteredCount > 0) { + console.log(` Filtered out ${internalFilteredCount} internal release issue(s)`) + } + } + + // Compute output path upfront so we can check for existing file + const dirName = release.replace('.', '-') + const fileName = rc ? '0-rc1.yml' : '0.yml' + const outputDir = path.join(process.cwd(), 'data/release-notes/enterprise-server', dirName) + const outputPath = path.join(outputDir, fileName) + + // ── Incremental mode: load existing entries ── + const allEntries: NoteEntry[] = [] + let existingCoveredUrls = new Set() + + if (!force && !stdout && fs.existsSync(outputPath)) { + const existing = loadExistingEntries(outputPath) + if (existing && existing.entries.length > 0) { + // When --issue is specified, remove the old entry for that issue so it gets regenerated + if (singleIssue) { + const issueUrl = `https://github.com/github/releases/issues/${singleIssue}` + const kept = existing.entries.filter((e) => e.sourceUrl !== issueUrl) + allEntries.push(...kept) + existing.coveredUrls.delete(issueUrl) + existingCoveredUrls = existing.coveredUrls + console.log(` Loaded ${kept.length} existing note(s), will regenerate #${singleIssue}`) + } else { + allEntries.push(...existing.entries) + existingCoveredUrls = existing.coveredUrls + console.log( + ` Loaded ${existing.entries.length} existing note(s) from ${path.relative(process.cwd(), outputPath)}`, + ) + } + } + } + + // Filter out issues already covered by existing file (incremental mode) + if (existingCoveredUrls.size > 0 && !singleIssue) { + const beforeCount = issues.length + issues = issues.filter((issue) => !existingCoveredUrls.has(issue.url)) + const skippedCount = beforeCount - issues.length + if (skippedCount > 0) { + console.log(` Skipping ${skippedCount} already-processed issue(s)`) + } + if (issues.length === 0) { + console.log('All issues already have notes. Use --force to regenerate.') + process.exit(0) + } + } + + // ── Step 2: Find changelog PRs ── + spinner.start('Finding changelog PRs...') + const issueChangelogMap = new Map() + let changelogFound = 0 + + for (const issue of issues) { + const changelog = findChangelogPr(issue) + issueChangelogMap.set(issue.number, changelog) + if (changelog) changelogFound++ + } + spinner.succeed(`Found changelog PRs for ${changelogFound}/${issues.length} issues`) + + // ── Step 3: Run agent on each issue ── + const failures: { issue: ReleaseIssue; error: string }[] = [] + const existingEntryCount = allEntries.length + + // Load valid headings once (cached, but clearer when hoisted) + const featureHeadings = loadFeatureHeadings() + + // Helper to write current entries to file (called after each success and on Ctrl+C) + const writeCurrentOutput = () => { + if (stdout || allEntries.length === 0) return + try { + if (!fs.existsSync(outputDir)) { + fs.mkdirSync(outputDir, { recursive: true }) + } + const yamlOutput = buildReleaseNotesYaml(allEntries, rc, featureHeadings) + fs.writeFileSync(outputPath, yamlOutput, 'utf8') + } catch (err) { + console.error(` ⚠ Failed to write output file: ${(err as Error).message}`) + } + } + + // Register so Ctrl+C saves progress + flushBeforeExit = writeCurrentOutput + + for (let i = 0; i < issues.length; i++) { + const issue = issues[i] + const changelog = issueChangelogMap.get(issue.number) || null + const label = `[${i + 1}/${issues.length}] #${issue.number}: ${issue.title}` + + spinner.start(`${label}`) + spinner.suffixText = `\n Issue: ${issue.url}${changelog ? `\n Changelog: ${changelog.url}` : ''}` + + try { + const ctx: AgentContext = { + issueUrl: issue.url, + issueTitle: issue.title, + issueBody: issue.body, + changelogUrl: changelog?.url ?? null, + changelogBody: changelog?.body ?? null, + featureHeadings, + } + const result = await runAgentWithRetry(ctx) + + if (result.skipWarning) { + console.log( + ` ⚠ Check if this actually applies to GHES and not just GHEC: ${result.skipWarning}`, + ) + } + + // entries are pre-validated by runAgentWithRetry, but re-parse for the actual list + const entries = parseNoteEntries(result.yamlStr, issue.url) + + // Warn about headings that don't match any known feature heading or special section + const specialHeadings = ['Changes', 'Closing down', 'Retired'] + const validHeadings = new Set([...featureHeadings, ...specialHeadings]) + for (const entry of entries) { + if (!validHeadings.has(entry.heading)) { + // Check for near-matches (case-insensitive) + const lowerHeading = entry.heading.toLowerCase() + const closeMatch = featureHeadings.find((h) => h.toLowerCase() === lowerHeading) + if (closeMatch) { + console.log(` ⚠ Heading "${entry.heading}" auto-corrected to "${closeMatch}"`) + entry.heading = closeMatch + } else { + console.log( + ` ⚠ Unknown heading "${entry.heading}" — will be placed in changes section`, + ) + } + } + } + + // Dedup: avoid duplicate notes if the same issue was partially loaded from an existing file + for (const entry of entries) { + const isDuplicate = allEntries.some( + (existing) => + existing.sourceUrl === entry.sourceUrl && + existing.heading === entry.heading && + existing.notes.length === entry.notes.length && + existing.notes.every((n, idx) => n === entry.notes[idx]), + ) + if (!isDuplicate) { + allEntries.push(entry) + } + } + const retryNote = result.attempts > 1 ? ` (attempt ${result.attempts})` : '' + spinner.suffixText = '' + spinner.succeed(`${label}${retryNote}`) + + // Write incrementally so progress is saved + writeCurrentOutput() + } catch (error) { + const err = error as Error & { rawOutput?: string } + const msg = err.message + const isSkipFailure = msg.startsWith('Agent tried to skip:') + failures.push({ issue, error: msg }) + spinner.suffixText = '' + if (isSkipFailure) { + // Clean output for skip failures — no raw agent dump + const skipReason = msg.replace('Agent tried to skip: ', '') + spinner.warn(`${label} — skipped by agent`) + console.log(` Reason: ${skipReason}`) + } else { + spinner.fail(`${label} — ${msg.substring(0, 100)}`) + // Show raw agent output only for real errors + if (err.rawOutput) { + console.log('\n --- Raw agent output (last attempt) ---') + const truncated = + err.rawOutput.length > 2000 + ? `${err.rawOutput.substring(0, 2000)}\n ... (truncated)` + : err.rawOutput + console.log(truncated) + console.log(' ---') + } + } + } + } + + // ── Step 4: Final summary ── + flushBeforeExit = null + const newCount = allEntries.length - existingEntryCount + if (existingEntryCount > 0) { + console.log( + `\nTotal: ${allEntries.length} note(s) (${existingEntryCount} existing + ${newCount} new from ${issues.length} issues)`, + ) + } else { + console.log(`\nGenerated ${allEntries.length} note(s) from ${issues.length} issues`) + } + if (failures.length > 0) { + console.log(`⚠️ ${failures.length} issue(s) failed:`) + for (const f of failures) { + console.log(` #${f.issue.number}: ${f.error.substring(0, 100)}`) + } + } + + if (stdout) { + if (failures.length > 0 && allEntries.length === 0) { + // All issues failed — don't print empty template + process.exit(1) + } + if (singleIssue) { + // For a single issue + stdout, print just the raw note YAML (not the full template) + const newEntries = allEntries.filter( + (e) => e.sourceUrl === `https://github.com/github/releases/issues/${singleIssue}`, + ) + if (newEntries.length > 0) { + console.log('\n--- Generated YAML ---\n') + const noteLines: string[] = [] + for (const entry of newEntries) { + noteLines.push(`- heading: ${entry.heading}`) + noteLines.push(' notes:') + appendNoteLines(noteLines, [entry], ' ') + } + console.log(noteLines.join('\n')) + } + } else { + const yamlOutput = buildReleaseNotesYaml(allEntries, rc, featureHeadings) + console.log('\n--- Generated YAML ---\n') + console.log(yamlOutput) + } + } else if (allEntries.length > 0) { + writeCurrentOutput() + console.log(`\n✅ Written to: ${path.relative(process.cwd(), outputPath)}`) + } else { + console.log('\nNo entries generated — no file written.') + } + + // Clean up stdin raw mode so the process can exit gracefully + if (process.stdin.isTTY) { + process.stdin.setRawMode(false) + process.stdin.pause() + } + }, + ) + +program.parse(process.argv) diff --git a/src/ghes-releases/scripts/notify-release-pms.ts b/src/ghes-releases/scripts/notify-release-pms.ts new file mode 100644 index 000000000000..fc34eef97ad1 --- /dev/null +++ b/src/ghes-releases/scripts/notify-release-pms.ts @@ -0,0 +1,325 @@ +/** + * @purpose Writer tool + * @description Notify PMs to review their GHES release notes on a PR + * + * Notify PMs about generated GHES release notes by posting a review comment + * on each source release issue in github/releases. + * + * For each release issue URL found in the YAML file's `# https://...` comments, + * this script posts a comment asking the PM to review the note in the PR and + * react with 🚀 once satisfied. + * + * Usage: + * npm run notify-release-pms -- --release 3.20 --rc --pr 12345 [--dry-run] + */ +import { Command } from 'commander' +import { execFileSync } from 'child_process' +import fs from 'fs' +import path from 'path' +import ora from 'ora' + +// ─── Types ─────────────────────────────────────────────────────────────────── + +interface SourceNote { + issueUrl: string + issueNumber: number +} + +// ─── Helpers ───────────────────────────────────────────────────────────────── + +/** + * Run `gh` CLI commands with native auth (no GITHUB_TOKEN interference) + */ +function gh(args: string[]): string { + const env = { ...process.env } + delete env.GITHUB_TOKEN + return execFileSync('gh', args, { + encoding: 'utf8', + stdio: ['pipe', 'pipe', 'pipe'], + env, + maxBuffer: 10 * 1024 * 1024, + }) +} + +/** + * Parse the release notes YAML file and extract source issue URLs with their + * line numbers. Each `# https://github.com/github/releases/issues/NNNN` comment + * maps to the note(s) that follow it. + */ +function extractSourceNotes(yamlPath: string): SourceNote[] { + const content = fs.readFileSync(yamlPath, 'utf8') + const lines = content.split('\n') + const notes: SourceNote[] = [] + const seen = new Set() + + for (let i = 0; i < lines.length; i++) { + const match = lines[i].match(/^\s*#\s*(https:\/\/github\.com\/github\/releases\/issues\/(\d+))/) + if (match) { + const issueNumber = parseInt(match[2], 10) + // Deduplicate — some issues appear multiple times (e.g., in features + changes) + // We use the first occurrence so the link points to the primary note + if (!seen.has(issueNumber)) { + seen.add(issueNumber) + notes.push({ + issueUrl: match[1], + issueNumber, + }) + } + } + } + + return notes +} + +/** + * Calculate the next weekday (Mon–Fri) at least `days` calendar days from now. + * If the resulting date lands on a weekend, it rolls forward to Monday. + */ +function getReviewDeadline(days: number): string { + const date = new Date() + date.setDate(date.getDate() + days) + const day = date.getDay() + if (day === 0) date.setDate(date.getDate() + 1) // Sunday → Monday + if (day === 6) date.setDate(date.getDate() + 2) // Saturday → Monday + return date.toLocaleDateString('en-US', { month: 'long', day: 'numeric', year: 'numeric' }) +} + +/** + * Build the comment body for a release issue notification. + */ +function buildCommentBody( + version: string, + rc: boolean, + prNumber: number, + relativeFilePath: string, + reviewDate?: string, +): string { + const releaseType = rc ? 'RC' : 'GA' + const prUrl = `https://github.com/github/docs-internal/pull/${prNumber}` + const fileUrl = `${prUrl}/files` + const deadline = reviewDate + ? new Date(`${reviewDate}T00:00:00`).toLocaleDateString('en-US', { + month: 'long', + day: 'numeric', + year: 'numeric', + }) + : getReviewDeadline(10) + + // Use a marker so we can identify our comments later (for check-release-approvals). + // Include releaseType so RC and GA comments are distinguishable. + const marker = `` + + return `${marker} +### GHES ${version} ${releaseType} release note review + +Hello! A release note has been created for this feature by a Docs team member assisted by Copilot. If you'd like to review it: + +1. [**Review the note in the PR**](${fileUrl}) (search for this issue's URL within \`${relativeFilePath}\`) +2. If the note looks good, **react to this comment with 🚀**. +3. If it needs changes, suggest edits directly in the PR, then **react with 🚀** to this comment when you're done. + +We ask that you submit any changes by **${deadline}** to help ensure timely release notes. + +The 🚀 tells us you've completed your review. If we don't hear from you, we'll go ahead with this note. + +Questions? Ask us in [#docs-ghes-releases](https://github-grid.enterprise.slack.com/archives/C0AQ37XBK7D).` +} + +// ─── CLI ───────────────────────────────────────────────────────────────────── + +const program = new Command() + +program + .name('notify-release-pms') + .description( + 'Post review notification comments on release issues for generated GHES release notes', + ) + .requiredOption('-r, --release ', 'GHES release number (e.g., 3.20)') + .requiredOption('--pr ', 'Pull request number in docs-internal', (val: string) => { + const n = parseInt(val, 10) + if (Number.isNaN(n) || n <= 0) { + console.error(`Error: --pr must be a positive integer, got "${val}"`) + process.exit(1) + } + return n + }) + .option('--rc', 'Whether this is a release candidate (defaults to auto-detect from filename)') + .option('--ga', 'Whether this is a GA release (defaults to auto-detect from filename)') + .option('--dry-run', 'Print comments to stdout instead of posting them') + .option( + '--review-date ', + 'Override the review deadline date (YYYY-MM-DD format, e.g., 2026-04-20)', + ) + .action( + (options: { + release: string + pr: number + rc?: boolean + ga?: boolean + dryRun?: boolean + reviewDate?: string + }) => { + const { release, pr: prNumber, dryRun, reviewDate } = options + const spinner = ora() + + // Validate --review-date format if provided + if (reviewDate && !/^\d{4}-\d{2}-\d{2}$/.test(reviewDate)) { + console.error( + `Error: Invalid date format "${reviewDate}". Expected: YYYY-MM-DD (e.g., 2026-04-20)`, + ) + process.exit(1) + } + + // Validate release version format + if (!/^\d+\.\d+$/.test(release)) { + console.error( + `Error: Invalid release version format "${release}". Expected: X.Y (e.g., 3.20)`, + ) + process.exit(1) + } + + // Determine RC vs GA + const dirName = release.replace('.', '-') + const rcPath = path.join( + process.cwd(), + 'data/release-notes/enterprise-server', + dirName, + '0-rc1.yml', + ) + const gaPath = path.join( + process.cwd(), + 'data/release-notes/enterprise-server', + dirName, + '0.yml', + ) + + let rc: boolean + let yamlPath: string + + if (options.rc) { + rc = true + yamlPath = rcPath + } else if (options.ga) { + rc = false + yamlPath = gaPath + } else { + // Auto-detect: prefer GA if it exists, otherwise RC (consistent with generate-release-notes) + if (fs.existsSync(gaPath)) { + rc = false + yamlPath = gaPath + } else if (fs.existsSync(rcPath)) { + rc = true + yamlPath = rcPath + } else { + console.error( + `Error: No release notes file found for ${release}. Expected:\n ${rcPath}\n ${gaPath}`, + ) + process.exit(1) + } + } + + const relativeFilePath = path.relative(process.cwd(), yamlPath) + + if (!fs.existsSync(yamlPath)) { + console.error(`Error: Release notes file not found: ${relativeFilePath}`) + process.exit(1) + } + + // ── Step 1: Extract source issue URLs ── + spinner.start('Parsing release notes file...') + const sourceNotes = extractSourceNotes(yamlPath) + spinner.succeed(`Found ${sourceNotes.length} unique release issue(s) in ${relativeFilePath}`) + + if (sourceNotes.length === 0) { + console.log('No release issues found in the YAML file. Nothing to notify.') + process.exit(0) + } + + // ── Step 2: Check for existing comments (avoid duplicates) ── + const releaseType = rc ? 'rc' : 'ga' + const marker = `` + const alreadyCommented = new Set() + + if (!dryRun) { + spinner.start('Checking for existing notification comments...') + for (const note of sourceNotes) { + try { + const comments = gh([ + 'api', + `repos/github/releases/issues/${note.issueNumber}/comments`, + '--paginate', + '--jq', + `.[].body`, + ]) + if (comments.includes(marker)) { + alreadyCommented.add(note.issueNumber) + } + } catch { + // If we can't read comments, we'll try to post and handle errors then + } + } + spinner.succeed( + alreadyCommented.size > 0 + ? `Skipping ${alreadyCommented.size} issue(s) already notified` + : 'No existing notifications found', + ) + } + + // ── Step 3: Post comments ── + const toNotify = sourceNotes.filter((n) => !alreadyCommented.has(n.issueNumber)) + + if (toNotify.length === 0) { + console.log('All release issues have already been notified. Nothing to do.') + process.exit(0) + } + + let posted = 0 + let failed = 0 + + for (let i = 0; i < toNotify.length; i++) { + const note = toNotify[i] + const commentBody = buildCommentBody(release, rc, prNumber, relativeFilePath, reviewDate) + + const label = `[${i + 1}/${toNotify.length}] #${note.issueNumber}` + + if (dryRun) { + console.log(`\n${'─'.repeat(60)}`) + console.log(`${label} — ${note.issueUrl}`) + console.log(`(Dry run) Comment body that would be posted:`) + console.log(`${'─'.repeat(60)}`) + console.log(commentBody) + posted++ + continue + } + + spinner.start(`${label} — Posting comment...`) + try { + gh([ + 'issue', + 'comment', + String(note.issueNumber), + '--repo', + 'github/releases', + '--body', + commentBody, + ]) + spinner.succeed(`${label} — Comment posted`) + posted++ + } catch (error) { + spinner.fail(`${label} — Failed: ${(error as Error).message.substring(0, 100)}`) + failed++ + } + } + + // ── Summary ── + console.log(`\n${'─'.repeat(40)}`) + console.log(`${dryRun ? '🔍 Dry run' : '✅ Done'}`) + console.log(` ${posted} comment(s) ${dryRun ? 'would be posted' : 'posted'}`) + if (failed > 0) console.log(` ${failed} failed`) + if (alreadyCommented.size > 0) { + console.log(` ${alreadyCommented.size} previously notified (skipped)`) + } + }, + ) + +program.parse(process.argv) diff --git a/src/ghes-releases/scripts/release-banner.ts b/src/ghes-releases/scripts/release-banner.ts index 6b2ac42ce897..abbd36fd15a0 100644 --- a/src/ghes-releases/scripts/release-banner.ts +++ b/src/ghes-releases/scripts/release-banner.ts @@ -1,3 +1,7 @@ +/** + * @purpose Writer tool + * @description Create or remove a release candidate banner for a GHES version + */ // [start-readme] // // This script creates or removes a release candidate banner for a specified version. diff --git a/src/ghes-releases/scripts/update-enterprise-dates.ts b/src/ghes-releases/scripts/update-enterprise-dates.ts index 76e975002178..8387b60cad30 100644 --- a/src/ghes-releases/scripts/update-enterprise-dates.ts +++ b/src/ghes-releases/scripts/update-enterprise-dates.ts @@ -1,3 +1,7 @@ +/** + * @purpose Writer tool + * @description Update enterprise release dates from github/enterprise-releases + */ // [start-readme] // // This script fetches data from https://github.com/github/enterprise-releases/blob/master/releases.json diff --git a/src/ghes-releases/tests/generate-release-notes.ts b/src/ghes-releases/tests/generate-release-notes.ts new file mode 100644 index 000000000000..4082ee2a77ca --- /dev/null +++ b/src/ghes-releases/tests/generate-release-notes.ts @@ -0,0 +1,363 @@ +import { describe, expect, test } from 'vitest' + +import { + extractYaml, + extractSkipReason, + parseNoteEntries, + loadExistingEntriesFromString, + buildReleaseNotesYaml, +} from '@/ghes-releases/lib/parse-release-notes' + +// ─── extractYaml ───────────────────────────────────────────────────────────── + +describe('extractYaml', () => { + test('extracts YAML from a fenced code block', () => { + const input = `Here is the release note: + +\`\`\`yaml +- heading: GitHub Actions + notes: + - Added support for reusable workflows. +\`\`\` + +Done!` + const result = extractYaml(input) + expect(result).toBe( + '- heading: GitHub Actions\n notes:\n - Added support for reusable workflows.', + ) + }) + + test('falls back to unfenced lines starting with "- heading:"', () => { + const input = `Some preamble text + +- heading: Repositories + notes: + - You can now archive repos in bulk. + +Some trailing text that is not YAML` + const result = extractYaml(input) + expect(result).toContain('- heading: Repositories') + expect(result).toContain('You can now archive repos in bulk.') + }) + + test('returns null when there is no YAML content', () => { + expect(extractYaml('No YAML here at all.')).toBeNull() + expect(extractYaml('')).toBeNull() + }) +}) + +// ─── extractSkipReason ─────────────────────────────────────────────────────── + +describe('extractSkipReason', () => { + test('extracts reason from "# SKIP: "', () => { + expect(extractSkipReason('# SKIP: Not applicable to GHES')).toBe('Not applicable to GHES') + }) + + test('returns null when there is no SKIP comment', () => { + expect(extractSkipReason('- heading: Foo\n notes:\n - bar')).toBeNull() + }) +}) + +// ─── parseNoteEntries ──────────────────────────────────────────────────────── + +describe('parseNoteEntries', () => { + const sourceUrl = 'https://github.com/github/releases/issues/1234' + + test('parses a single entry with one note', () => { + const yamlStr = `- heading: GitHub Actions + notes: + - Added reusable workflows support.` + const entries = parseNoteEntries(yamlStr, sourceUrl) + expect(entries).toHaveLength(1) + expect(entries[0].heading).toBe('GitHub Actions') + expect(entries[0].notes).toEqual(['Added reusable workflows support.']) + expect(entries[0].sourceUrl).toBe(sourceUrl) + }) + + test('parses multiple entries with multiple notes', () => { + const yamlStr = `- heading: APIs + notes: + - New endpoint. +- heading: Repositories + notes: + - Archive in bulk. + - Transfer repos across orgs.` + const entries = parseNoteEntries(yamlStr, sourceUrl) + expect(entries).toHaveLength(2) + expect(entries[1].notes).toEqual(['Archive in bulk.', 'Transfer repos across orgs.']) + }) + + test('returns empty array for invalid or non-array YAML', () => { + expect(parseNoteEntries('key: value', sourceUrl)).toEqual([]) + expect(parseNoteEntries('{{{{', sourceUrl)).toEqual([]) + }) + + test('skips entries with missing or non-string heading', () => { + expect(parseNoteEntries('- notes:\n - Orphan note.', sourceUrl)).toEqual([]) + expect(parseNoteEntries('- heading: 123\n notes:\n - Note.', sourceUrl)).toEqual([]) + }) + + test('filters non-string items from notes array', () => { + const yamlStr = `- heading: Mixed + notes: + - Valid note. + - 42 + - true` + const entries = parseNoteEntries(yamlStr, sourceUrl) + expect(entries[0].notes).toEqual(['Valid note.']) + }) +}) + +// ─── loadExistingEntriesFromString ─────────────────────────────────────────── + +describe('loadExistingEntriesFromString', () => { + test('parses feature entries with source URL comments', () => { + const content = `date: '2025-01-15' +release_candidate: false +deprecated: false +intro: | + +sections: + + features: + + - heading: GitHub Actions + notes: + # https://github.com/github/releases/issues/100 + - | + Added reusable workflows. + + changes: + # TODO: Add change notes + + known_issues: + - | + ... + + closing_down: + # TODO + + retired: + # TODO +` + const result = loadExistingEntriesFromString(content) + expect(result.entries).toHaveLength(1) + expect(result.entries[0]).toEqual({ + heading: 'GitHub Actions', + notes: ['Added reusable workflows.'], + sourceUrl: 'https://github.com/github/releases/issues/100', + }) + expect(result.coveredUrls.has('https://github.com/github/releases/issues/100')).toBe(true) + }) + + test('parses entries across features, changes, closing_down, and retired sections', () => { + const content = `date: '2025-01-15' +release_candidate: false +deprecated: false +intro: | + +sections: + + features: + + - heading: APIs + notes: + # https://github.com/github/releases/issues/100 + - | + New endpoint added. + + changes: + # https://github.com/github/releases/issues/102 + - | + Config format changed. + + known_issues: + - | + ... + + closing_down: + # https://github.com/github/releases/issues/300 + - | + Legacy API deprecated. + + retired: + # https://github.com/github/releases/issues/103 + - | + Old auth method removed. +` + const result = loadExistingEntriesFromString(content) + expect(result.entries).toHaveLength(4) + expect(result.coveredUrls.size).toBe(4) + + const headings = result.entries.map((e) => e.heading) + expect(headings).toEqual(['APIs', 'Changes', 'Closing down', 'Retired']) + }) + + test('skips placeholder "..." notes', () => { + const content = `date: '2025-01-15' +release_candidate: false +deprecated: false +intro: | + +sections: + + features: + + - heading: GitHub Actions + notes: + # https://github.com/github/releases/issues/100 + - | + ... + + changes: + # TODO + + known_issues: + - | + ... + + closing_down: + # TODO + + retired: + # TODO +` + const result = loadExistingEntriesFromString(content) + expect(result.entries).toHaveLength(0) + }) + + test('merges notes from the same heading and source URL', () => { + const content = `date: '2025-01-15' +release_candidate: false +deprecated: false +intro: | + +sections: + + features: + + - heading: GitHub Actions + notes: + # https://github.com/github/releases/issues/100 + - | + First note. + # https://github.com/github/releases/issues/100 + - | + Second note from same issue. + + changes: + # TODO + + known_issues: + - | + ... + + closing_down: + # TODO + + retired: + # TODO +` + const result = loadExistingEntriesFromString(content) + expect(result.entries).toHaveLength(1) + expect(result.entries[0].notes).toEqual(['First note.', 'Second note from same issue.']) + }) +}) + +// ─── buildReleaseNotesYaml ─────────────────────────────────────────────────── + +describe('buildReleaseNotesYaml', () => { + const featureHeadings = ['GitHub Actions', 'Repositories', 'APIs'] + + test('groups feature entries by heading in template order', () => { + const entries = [ + { heading: 'Repositories', notes: ['Repo note.'], sourceUrl: 'https://example.com/2' }, + { heading: 'GitHub Actions', notes: ['Actions note.'], sourceUrl: 'https://example.com/1' }, + ] + const yaml = buildReleaseNotesYaml(entries, false, featureHeadings) + + const actionsIdx = yaml.indexOf('- heading: GitHub Actions') + const reposIdx = yaml.indexOf('- heading: Repositories') + expect(actionsIdx).toBeGreaterThan(-1) + expect(reposIdx).toBeGreaterThan(-1) + // GitHub Actions comes before Repositories in featureHeadings + expect(actionsIdx).toBeLessThan(reposIdx) + + expect(yaml).toContain('Actions note.') + expect(yaml).toContain('Repo note.') + }) + + test('places non-feature entries in changes section', () => { + const entries = [ + { heading: 'Some Other Heading', notes: ['A change.'], sourceUrl: 'https://example.com/1' }, + ] + const yaml = buildReleaseNotesYaml(entries, false, featureHeadings) + + // Should appear under changes, not features + expect(yaml).toContain(' features:\n # TODO: Add feature notes') + expect(yaml).toContain(' changes:') + expect(yaml).toContain('# https://example.com/1') + expect(yaml).toContain('A change.') + }) + + test('places Closing down and Retired entries in their own sections', () => { + const entries = [ + { + heading: 'Closing down', + notes: ['Deprecating X.'], + sourceUrl: 'https://example.com/1', + }, + { heading: 'Retired', notes: ['Removed Y.'], sourceUrl: 'https://example.com/2' }, + ] + const yaml = buildReleaseNotesYaml(entries, false, featureHeadings) + + expect(yaml).toContain(' closing_down:\n # https://example.com/1') + expect(yaml).toContain('Deprecating X.') + expect(yaml).toContain(' retired:\n # https://example.com/2') + expect(yaml).toContain('Removed Y.') + // Changes should be omitted since Closing down/Retired are excluded and no other entries exist + expect(yaml).not.toContain(' changes:') + }) + + test('omits empty sections (except features which gets a TODO)', () => { + const yaml = buildReleaseNotesYaml([], false, featureHeadings) + + expect(yaml).toContain('# TODO: Add feature notes') + expect(yaml).toContain('# TODO: Add known issues') + // Empty changes, closing_down, and retired are omitted entirely + // to avoid YAML parsing as null (which fails schema validation) + expect(yaml).not.toContain(' changes:') + expect(yaml).not.toContain(' closing_down:') + expect(yaml).not.toContain(' retired:') + }) + + test('sets release_candidate: true and includes RC intro text', () => { + const yaml = buildReleaseNotesYaml([], true, featureHeadings) + + expect(yaml).toContain('release_candidate: true') + expect(yaml).toContain('> [!NOTE] Release candidate (RC)') + expect(yaml).toContain('Do not install an RC in a production environment.') + }) + + test('sets release_candidate: false for GA releases', () => { + const yaml = buildReleaseNotesYaml([], false, featureHeadings) + + expect(yaml).toContain('release_candidate: false') + expect(yaml).not.toContain('Release candidate (RC)') + }) + + test('includes source URL comments and pipe-style notes', () => { + const entries = [ + { + heading: 'GitHub Actions', + notes: ['Line one of the note.'], + sourceUrl: 'https://github.com/github/releases/issues/999', + }, + ] + const yaml = buildReleaseNotesYaml(entries, false, featureHeadings) + + expect(yaml).toContain('# https://github.com/github/releases/issues/999') + expect(yaml).toContain('- |') + expect(yaml).toContain('Line one of the note.') + }) +}) diff --git a/src/journeys/lib/journey-path-resolver.ts b/src/journeys/lib/journey-path-resolver.ts index b665a16c92d5..cd1fa9876b9f 100644 --- a/src/journeys/lib/journey-path-resolver.ts +++ b/src/journeys/lib/journey-path-resolver.ts @@ -4,6 +4,7 @@ import { executeWithFallback } from '@/languages/lib/render-with-fallback' import getApplicableVersions from '@/versions/lib/get-applicable-versions' import Permalink from '@/frame/lib/permalink' import getLinkData from './get-link-data' +import type { Context, Page } from '@/types' export interface JourneyContext { trackId: string @@ -44,7 +45,7 @@ type JourneyPage = { title?: string permalink?: string relativePath?: string - versions?: any + versions?: Record journeyTracks?: Array<{ id: string title: string @@ -56,16 +57,6 @@ type JourneyPage = { }> } -type Pages = Record -type ContentContext = { - currentProduct?: string - currentLanguage?: string - currentVersion?: string - pages?: Pages - redirects?: any - [key: string]: any -} - // Cache for journey pages so we only filter all pages once let cachedJourneyPages: JourneyPage[] | null = null // Cache for guide paths to quickly check if a page is part of any journey @@ -76,16 +67,16 @@ function needsRendering(str: string): boolean { return str.includes('{{') || str.includes('{%') || str.includes('[') || str.includes('<') } -function getJourneyPages(pages: Pages): JourneyPage[] { +function getJourneyPages(pages: Record): JourneyPage[] { if (!cachedJourneyPages) { - cachedJourneyPages = Object.values(pages).filter( - (page: any) => page.journeyTracks && page.journeyTracks.length > 0, - ) as JourneyPage[] + cachedJourneyPages = (Object.values(pages) as JourneyPage[]).filter( + (page) => page.journeyTracks && page.journeyTracks.length > 0, + ) } return cachedJourneyPages } -function getGuidePaths(pages: Pages): Set { +function getGuidePaths(pages: Record): Set { if (!cachedGuidePaths) { cachedGuidePaths = new Set() const journeyPages = getJourneyPages(pages) @@ -125,7 +116,7 @@ function normalizeGuidePath(path: string): string { */ async function fetchGuideData( guidePath: string, - context: ContentContext, + context: Context, ): Promise<{ href: string; title: string } | null> { try { const resultData = await getLinkData(guidePath, context, { @@ -155,8 +146,8 @@ async function fetchGuideData( */ export async function resolveJourneyContext( articlePath: string, - pages: Pages, - context: ContentContext, + pages: Record, + context: Context, currentJourneyPage?: JourneyPage, ): Promise { const normalizedPath = normalizeGuidePath(articlePath) @@ -311,7 +302,7 @@ export async function resolveJourneyContext( */ export async function resolveJourneyTracks( journeyTracks: JourneyPage['journeyTracks'], - context: ContentContext, + context: Context, ): Promise { if (!journeyTracks || journeyTracks.length === 0) { return [] diff --git a/src/journeys/tests/journey-path-resolver.ts b/src/journeys/tests/journey-path-resolver.ts index 891bd940cd16..0678b7291c79 100644 --- a/src/journeys/tests/journey-path-resolver.ts +++ b/src/journeys/tests/journey-path-resolver.ts @@ -1,6 +1,7 @@ import { describe, expect, test, vi } from 'vitest' import { resolveJourneyContext, resolveJourneyTracks } from '../lib/journey-path-resolver' +import type { Page } from '@/types' // Mock modules since we just want to test journey functions, not their dependencies or // against real content files @@ -63,7 +64,7 @@ describe('journey-path-resolver', () => { }, ], }, - } + } as unknown as Record test('returns null for article not in any journey track', async () => { const result = await resolveJourneyContext('/some-other-article', mockPages, mockContext) diff --git a/src/languages/lib/correct-translation-content.ts b/src/languages/lib/correct-translation-content.ts index 8b3999fcf563..35eeb7f96739 100644 --- a/src/languages/lib/correct-translation-content.ts +++ b/src/languages/lib/correct-translation-content.ts @@ -31,6 +31,20 @@ export function correctTranslatedContentStrings( content = content.replaceAll('{% de datos variables', '{% data variables') content = content.replaceAll('{% datos reusables', '{% data reusables') content = content.replaceAll('{% data reutilizables.', '{% data reusables.') + // `{% datos reutilizables.` — fully translated "data reusables" path + content = content.replaceAll('{% datos reutilizables.', '{% data reusables.') + // `{% datos repositorios.` — translated "repositories" path segment + content = content.replaceAll('{% datos repositorios.', '{% data reusables.repositories.') + // `{% datos de variables.` — reversed word order with extra "de" + content = content.replaceAll('{% datos de variables.', '{% data variables.') + // `{% variables de datos.` — reversed word order "variables of data" + content = content.replaceAll('{% variables de datos.', '{% data variables.') + // `{% Datos ` — capitalized "datos" = data + content = content.replaceAll('{% Datos variables', '{% data variables') + // `{% dato ` — singular form of "datos" = data + content = content.replaceAll('{% dato variables', '{% data variables') + // `{% variables.` — missing "data" prefix + content = content.replaceAll('{% variables.', '{% data variables.') // Translated Liquid keywords content = content.replaceAll('{% comentario %}', '{% comment %}') content = content.replaceAll('{% si ', '{% if ') @@ -113,6 +127,9 @@ export function correctTranslatedContentStrings( // `{% それ以外の %}` — truncated form of "in the other case" = else content = content.replaceAll('{% それ以外の %}', '{% else %}') content = content.replaceAll('{%- それ以外の %}', '{%- else %}') + // `{%- それ以外 %}` — further-truncated form (missing の/場合) = else + content = content.replaceAll('{% それ以外 %}', '{% else %}') + content = content.replaceAll('{%- それ以外 %}', '{%- else %}') // `{% それ以外の場合 ifversion X %}` → `{% elsif X %}` (confused elsif + ifversion) content = content.replace(/\{% それ以外の場合 ifversion\s+(.+?)\s*%\}/g, '{% elsif $1 %}') // `{%- "supported" %}` → `{%- when "supported" %}` (missing `when`) @@ -193,6 +210,12 @@ export function correctTranslatedContentStrings( return `${dash} assign ${varName} = ${value.trim()} ${closeDash}` }, ) + // `{% 行ヘッダー %}` — "row headers" = rowheaders + content = content.replaceAll('{% 行ヘッダー %}', '{% rowheaders %}') + content = content.replaceAll('{%- 行ヘッダー %}', '{%- rowheaders %}') + // `{% ウィンドウズ %}` — "Windows" = windows (platform tag) + content = content.replaceAll('{% ウィンドウズ %}', '{% windows %}') + content = content.replaceAll('{%- ウィンドウズ %}', '{%- windows %}') } if (context.code === 'pt') { @@ -216,10 +239,35 @@ export function correctTranslatedContentStrings( content = content.replaceAll('{% %de dados reusables.', '{% data reusables.') content = content.replaceAll('{% %de dados variables.', '{% data variables.') content = content.replaceAll('{% %móvel }', '{% mobile %}') + // `{% variáveis de dados.` — reversed word order for "data variables" in Portuguese + content = content.replaceAll('{% variáveis de dados.', '{% data variables.') + content = content.replaceAll('{% variáveis de dados ', '{% data variables ') + // `{% dados variáveis.` — alternate word order "data variables" + content = content.replaceAll('{% dados variáveis.', '{% data variables.') + // `{% janelas %}` — Portuguese "windows" = windows (platform tag) + content = content.replaceAll('{% janelas %}', '{% windows %}') + content = content.replaceAll('{%- janelas %}', '{%- windows %}') + // `{% observação %}` — Portuguese "note" = note + content = content.replaceAll('{% observação %}', '{% note %}') + content = content.replaceAll('{%- observação %}', '{%- note %}') + // `{% comentário %}` — Portuguese "comment" = comment + content = content.replaceAll('{% comentário %}', '{% comment %}') + // `{% nota de fim %}` — Portuguese "end note" = endnote + content = content.replaceAll('{% nota de fim %}', '{% endnote %}') + content = content.replaceAll('{%- nota de fim %}', '{%- endnote %}') + // `{% Dados variables` — capitalized "Dados" + content = content.replaceAll('{% Dados variables', '{% data variables') + content = content.replaceAll('{%- Dados variables', '{%- data variables') // Catch "ou" between any plan names in ifversion/elsif/if tags content = content.replace(/\{%-? (?:ifversion|elsif|if) [^%]*?ou [^%]*?%\}/g, (match) => { return match.replace(/ ou /g, ' or ') }) + // Fully translated reusable path in audit log article: + // `{% dados agrupados por categoria.complemento.audit_log.reference-grouped-by-category %}` + content = content.replaceAll( + '{% dados agrupados por categoria.complemento.audit_log.reference-grouped-by-category %}', + '{% data reusables.audit_log.reference-grouped-by-category %}', + ) } if (context.code === 'zh') { @@ -243,6 +291,16 @@ export function correctTranslatedContentStrings( content = content.replace(/\{%-? (?:ifversion|elsif|if) [^%]*?或[^%]*?%\}/g, (match) => { return match.replace(/ 或 /g, ' or ') }) + // `{% 行标题 %}` — "row headers" = rowheaders + content = content.replaceAll('{% 行标题 %}', '{% rowheaders %}') + content = content.replaceAll('{%- 行标题 %}', '{%- rowheaders %}') + // `{% 数据变量.` — "data variables" = data variables + content = content.replaceAll('{% 数据变量.', '{% data variables.') + // `{% Windows 操作系统 %}` — "Windows OS" = windows platform tag + content = content.replaceAll('{% Windows 操作系统 %}', '{% windows %}') + content = content.replaceAll('{%- Windows 操作系统 %}', '{%- windows %}') + // `{% Windows终端 %}` — "Windows terminal" = windows platform tag + content = content.replaceAll('{% Windows终端 %}', '{% windows %}') } if (context.code === 'ru') { @@ -287,6 +345,13 @@ export function correctTranslatedContentStrings( }) content = content.replaceAll('{% endif _%}', '{% endif %}') content = content.replaceAll('{% конечным %}', '{% endif %}') + // `{%- конец %}` — dash-trimmed form of "end" = endif + content = content.replaceAll('{%- конец %}', '{%- endif %}') + // `{%- конец для %}` — "end for" = endfor + content = content.replaceAll('{%- конец для %}', '{%- endfor %}') + // `{% заголовки строк %}` — "row headers" = rowheaders (opener; `{% endrowheaders %}` stays in English) + content = content.replaceAll('{% заголовки строк %}', '{% rowheaders %}') + content = content.replaceAll('{%- заголовки строк %}', '{%- rowheaders %}') // `{% конец %}` after `{% raw %}` means `{% endraw %}`, not `{% endif %}`. // Handle this BEFORE the generic `{% конец %}` → `{% endif %}` fallback. // We use a split-based approach instead of `[^]*?` regex to avoid @@ -330,6 +395,14 @@ export function correctTranslatedContentStrings( content = content.replaceAll('{% запроса %}', '{% endraw %}') // `{% Mac %}` — capitalized mac platform tag content = content.replaceAll('{% Mac %}', '{% mac %}') + // `{% Endwindows %}` — capitalized endwindows + content = content.replaceAll('{% Endwindows %}', '{% endwindows %}') + content = content.replaceAll('{%- Endwindows %}', '{%- endwindows %}') + // `{% Elsif ` — capitalized elsif + content = content.replace(/\{% Elsif /g, '{% elsif ') + // `{% Linux %}` — capitalized linux platform tag + content = content.replaceAll('{% Linux %}', '{% linux %}') + content = content.replaceAll('{%- Linux %}', '{%- linux %}') // Fix double quotes in Russian YAML files that cause parsing errors content = content.replace(/href=""https:\/\//g, 'href="https://') @@ -382,10 +455,17 @@ export function correctTranslatedContentStrings( content = content.replaceAll('{% %brut }', '{% raw %}') content = content.replaceAll('{% redessiner %}', '{% endraw %}') content = content.replaceAll('{% données ', '{% data ') + // `{% Données ` — capitalized form + content = content.replaceAll('{% Données variables', '{% data variables') + content = content.replaceAll('{% Données réutilisables.', '{% data reusables.') // Catch remaining "ou" between any plan names in ifversion/elsif/if tags content = content.replace(/\{%-? (?:ifversion|elsif|if) [^%]*?ou [^%]*?%\}/g, (match) => { return match.replace(/ ou /g, ' or ') }) + // French "et" for "and" in ifversion/elsif/if tags + content = content.replace(/\{%-? (?:ifversion|elsif|if) [^%]*?\bet\b[^%]*?%\}/g, (match) => { + return match.replace(/ et /g, ' and ') + }) // French guillemets «/» → " inside if/ifversion/elsif tags content = content.replace(/\{%-?\s*(?:if|ifversion|elsif)\s[^%]*?[«»][^%]*?%\}/g, (match) => { return match.replace(/«\s*/g, '"').replace(/\s*»/g, '"') @@ -407,6 +487,12 @@ export function correctTranslatedContentStrings( // `{% sinon %}` / `{%- sinon %}` — French "otherwise" = else content = content.replaceAll('{% sinon %}', '{% else %}') content = content.replaceAll('{%- sinon %}', '{%- else %}') + // `{% note de fin %}` / `{%- note de fin %}` — "end note" = endnote + content = content.replaceAll('{% note de fin %}', '{% endnote %}') + content = content.replaceAll('{%- note de fin %}', '{%- endnote %}') + // `{% éclipse %}` — French accent on "eclipse" platform tag + content = content.replaceAll('{% éclipse %}', '{% eclipse %}') + content = content.replaceAll('{%- éclipse %}', '{%- eclipse %}') // Remove orphaned {% endif %} tags when no ifversion/elsif opener exists in the content. // Caused by translations where only the closing tag survived (e.g. user-api.md reusable). if ( @@ -431,6 +517,7 @@ export function correctTranslatedContentStrings( // Extra `%` before data: `{% % data` → `{% data` content = content.replaceAll('{% % data', '{% data') content = content.replaceAll('{% 기타 %}', '{% else %}') + content = content.replaceAll('{%- 기타 %}', '{%- else %}') content = content.replaceAll('{% 참고 %}', '{% note %}') content = content.replaceAll('{% 원시 %}', '{% raw %}') // Catch "또는" between any plan names in ifversion/elsif/if tags @@ -445,6 +532,16 @@ export function correctTranslatedContentStrings( // Korean translation of github-glossary.md content = content.replaceAll('{{ 용어집.term }}', '{{ glossary.term }}') + // `{% 데이터 재사용.` — Korean translation of "data reusables" path + content = content.replaceAll('{% 데이터 재사용.', '{% data reusables.') + // `{% datavariable` — compound missing space and plural: "datavariable" → "data variables" + content = content.replaceAll('{% datavariable', '{% data variables') + // `{% 행 머리글 %}` — "row headers" = rowheaders + content = content.replaceAll('{% 행 머리글 %}', '{% rowheaders %}') + content = content.replaceAll('{%- 행 머리글 %}', '{%- rowheaders %}') + // `{% 윈도우즈 %}` — Korean transliteration of "windows" + content = content.replaceAll('{% 윈도우즈 %}', '{% windows %}') + content = content.replaceAll('{%- 윈도우즈 %}', '{%- windows %}') } if (context.code === 'de') { @@ -459,6 +556,23 @@ export function correctTranslatedContentStrings( content = content.replaceAll('{% Data wiederverwendbare.', '{% data reusables.') // `wiederverwendbar.` (without trailing 'e') — alternate German form content = content.replaceAll('{% Daten wiederverwendbar.', '{% data reusables.') + // `daten wiederverwendbars.` — lowercase with trailing 's' + content = content.replaceAll('{% daten wiederverwendbars.', '{% data reusables.') + // `daten wiederverwendbar.` / `daten wiederverwendbare.` — without trailing 's' + content = content.replaceAll('{% daten wiederverwendbar.', '{% data reusables.') + content = content.replaceAll('{% daten wiederverwendbare.', '{% data reusables.') + // `{%- Daten variables` — dash variant + content = content.replaceAll('{%- Daten variables', '{%- data variables') + // `{% Daten Variablen.` — both German words for "data variables" + content = content.replaceAll('{% Daten Variablen.', '{% data variables.') + // `{% daten reusables` — lowercase with English "reusables" + content = content.replaceAll('{% daten reusables', '{% data reusables') + // `{% unformatierte %}` — "unformatted" = raw + content = content.replaceAll('{% unformatierte %}', '{% raw %}') + content = content.replaceAll('{%- unformatierte %}', '{%- raw %}') + // `Datenvariablen.` — German compound word for "data variables" (no space) + content = content.replaceAll('{% Datenvariablen.', '{% data variables.') + content = content.replaceAll('{%- Datenvariablen.', '{%- data variables.') content = content.replaceAll('{%-Daten variables', '{%- data variables') content = content.replaceAll('{%-Daten-variables', '{%- data variables') content = content.replaceAll('{%- ifversion fpt oder ghec %}', '{%- ifversion fpt or ghec %}') @@ -484,9 +598,86 @@ export function correctTranslatedContentStrings( // `{% ansonsten %}` / `{%- ansonsten %}` — "otherwise" = else content = content.replaceAll('{% ansonsten %}', '{% else %}') content = content.replaceAll('{%- ansonsten %}', '{%- else %}') + // `{% andernfalls %}` / `{% sonst %}` — "otherwise/else" = else + content = content.replaceAll('{% andernfalls %}', '{% else %}') + content = content.replaceAll('{%- andernfalls %}', '{%- else %}') + content = content.replaceAll('{% sonst %}', '{% else %}') + content = content.replaceAll('{%- sonst %}', '{%- else %}') + // `{% andernfalls ifversion X %}` / `{% sonst ifversion X %}` → `{% elsif X %}` + content = content.replace(/\{% andernfalls ifversion\s+(.+?)\s*%\}/g, '{% elsif $1 %}') + content = content.replace(/\{% sonst ifversion\s+(.+?)\s*%\}/g, '{% elsif $1 %}') // `{% Zeilenkopfzeilen %}` — "row headers" = rowheaders content = content.replaceAll('{% Zeilenkopfzeilen %}', '{% rowheaders %}') content = content.replaceAll('{%- Zeilenkopfzeilen %}', '{%- rowheaders %}') + // `{% Rohdaten %}` — German "raw data" = raw + content = content.replaceAll('{% Rohdaten %}', '{% raw %}') + content = content.replaceAll('{%- Rohdaten %}', '{%- raw %}') + content = content.replaceAll('{%- Rohdaten -%}', '{%- raw -%}') + // `{% okticon ` — "octicon" transliterated to "okticon" + content = content.replaceAll('{% okticon ', '{% octicon ') + // `{% Endnotiz %}` — "end note" = endnote + content = content.replaceAll('{% Endnotiz %}', '{% endnote %}') + content = content.replaceAll('{%- Endnotiz %}', '{%- endnote %}') + // `{% endifen %}` — garbled "endif" = endif + content = content.replaceAll('{% endifen %}', '{% endif %}') + content = content.replaceAll('{%- endifen %}', '{%- endif %}') + // `{% Endifen %}` — capitalized variant + content = content.replaceAll('{% Endifen %}', '{% endif %}') + content = content.replaceAll('{%- Endifen %}', '{%- endif %}') + // `{% Endif %}` — capitalized endif + content = content.replaceAll('{% Endif %}', '{% endif %}') + content = content.replaceAll('{%- Endif %}', '{%- endif %}') + content = content.replaceAll('{%- Endif -%}', '{%- endif -%}') + // `{% Dateninstanz` — "data instance" = data + content = content.replaceAll('{% Dateninstanz ', '{% data ') + // `{% ifversion-Sicherheitskonfigurationen %}` — hyphenated compound + content = content.replaceAll( + '{% ifversion-Sicherheitskonfigurationen %}', + '{% ifversion security-configurations %}', + ) + content = content.replaceAll( + '{%- ifversion-Sicherheitskonfigurationen %}', + '{%- ifversion security-configurations %}', + ) + // `{% ifversion-Unterprobleme %}` — hyphenated compound + content = content.replaceAll('{% ifversion-Unterprobleme %}', '{% ifversion sub-issues %}') + content = content.replaceAll('{%- ifversion-Unterprobleme %}', '{%- ifversion sub-issues %}') + // `{% ifversion-Sicherheitskampagnen %}` — hyphenated compound + content = content.replaceAll( + '{% ifversion-Sicherheitskampagnen %}', + '{% ifversion security-campaigns %}', + ) + content = content.replaceAll( + '{%- ifversion-Sicherheitskampagnen %}', + '{%- ifversion security-campaigns %}', + ) + // `{% ifversion-repo-policy-rules %}` — missing space before feature flag + content = content.replaceAll( + '{% ifversion-repo-policy-rules %}', + '{% ifversion repo-policy-rules %}', + ) + content = content.replaceAll( + '{%- ifversion-repo-policy-rules %}', + '{%- ifversion repo-policy-rules %}', + ) + // `{% ifversion-enterprise-installed-apps %}` — missing space before feature flag + content = content.replaceAll( + '{% ifversion-enterprise-installed-apps %}', + '{% ifversion enterprise-installed-apps %}', + ) + content = content.replaceAll( + '{%- ifversion-enterprise-installed-apps %}', + '{%- ifversion enterprise-installed-apps %}', + ) + // `{% Windows %}` — capitalized platform tag + content = content.replaceAll('{% Windows %}', '{% windows %}') + content = content.replaceAll('{%- Windows %}', '{%- windows %}') + // `{% Linux %}` — capitalized platform tag + content = content.replaceAll('{% Linux %}', '{% linux %}') + content = content.replaceAll('{%- Linux %}', '{%- linux %}') + // `{% Eclipse %}` — capitalized platform tag + content = content.replaceAll('{% Eclipse %}', '{% eclipse %}') + content = content.replaceAll('{%- Eclipse %}', '{%- eclipse %}') } // --- Generic fixes (all languages) --- @@ -500,6 +691,14 @@ export function correctTranslatedContentStrings( // Capitalized Liquid keyword: `{% Data ` → `{% data ` content = content.replaceAll('{% Data ', '{% data ') + // Capitalized platform tags (cross-language) + content = content.replaceAll('{% Windows %}', '{% windows %}') + content = content.replaceAll('{%- Windows %}', '{%- windows %}') + content = content.replaceAll('{% Linux %}', '{% linux %}') + content = content.replaceAll('{%- Linux %}', '{%- linux %}') + content = content.replaceAll('{% Eclipse %}', '{% eclipse %}') + content = content.replaceAll('{%- Eclipse %}', '{%- eclipse %}') + // These run after per-language fixes so that e.g. `{{% данных variables` // first becomes `{{% data variables` and then gets caught here. diff --git a/src/languages/tests/correct-translation-content.ts b/src/languages/tests/correct-translation-content.ts index a1b3cdfa926f..cc0a32e35622 100644 --- a/src/languages/tests/correct-translation-content.ts +++ b/src/languages/tests/correct-translation-content.ts @@ -96,6 +96,12 @@ describe('correctTranslatedContentStrings', () => { '{% ifversion fpt or ghec or ghes %}', ) }) + + test('fixes datos reutilizables → data reusables', () => { + expect(fix('{% datos reutilizables.profile.access_org %}', 'es')).toBe( + '{% data reusables.profile.access_org %}', + ) + }) }) // ─── JAPANESE (ja) ────────────────────────────────────────────────── @@ -232,6 +238,11 @@ describe('correctTranslatedContentStrings', () => { expect(fix('{%- それ以外の %}', 'ja')).toBe('{%- else %}') }) + test('fixes further-truncated それ以外 → else', () => { + expect(fix('{% それ以外 %}', 'ja')).toBe('{% else %}') + expect(fix('{%- それ以外 %}', 'ja')).toBe('{%- else %}') + }) + test('fixes それ以外の場合 ifversion X → elsif X', () => { expect(fix('{% それ以外の場合 ifversion codeql-rust-public-preview %}', 'ja')).toBe( '{% elsif codeql-rust-public-preview %}', @@ -241,6 +252,16 @@ describe('correctTranslatedContentStrings', () => { '{% elsif codeql-rust-public-preview %}', ) }) + + test('fixes 行ヘッダー → rowheaders', () => { + expect(fix('{% 行ヘッダー %}', 'ja')).toBe('{% rowheaders %}') + expect(fix('{%- 行ヘッダー %}', 'ja')).toBe('{%- rowheaders %}') + }) + + test('fixes ウィンドウズ → windows', () => { + expect(fix('{% ウィンドウズ %}', 'ja')).toBe('{% windows %}') + expect(fix('{%- ウィンドウズ %}', 'ja')).toBe('{%- windows %}') + }) }) // ─── PORTUGUESE (pt) ─────────────────────────────────────────────── @@ -313,6 +334,55 @@ describe('correctTranslatedContentStrings', () => { '{% data reusables.repositories.reaction_list %}', ) }) + + test('fixes variáveis de dados → data variables', () => { + expect(fix('{% variáveis de dados.release-phases.public_preview %}', 'pt')).toBe( + '{% data variables.release-phases.public_preview %}', + ) + expect(fix('{% variáveis de dados product.github %}', 'pt')).toBe( + '{% data variables product.github %}', + ) + }) + + test('fixes dados variáveis → data variables', () => { + expect(fix('{% dados variáveis.produto.prodname_pro %}', 'pt')).toBe( + '{% data variables.produto.prodname_pro %}', + ) + }) + + test('fixes janelas → windows', () => { + expect(fix('{% janelas %}', 'pt')).toBe('{% windows %}') + expect(fix('{%- janelas %}', 'pt')).toBe('{%- windows %}') + }) + + test('fixes observação → note', () => { + expect(fix('{% observação %}', 'pt')).toBe('{% note %}') + expect(fix('{%- observação %}', 'pt')).toBe('{%- note %}') + }) + + test('fixes comentário → comment', () => { + expect(fix('{% comentário %}', 'pt')).toBe('{% comment %}') + }) + + test('fixes nota de fim → endnote', () => { + expect(fix('{% nota de fim %}', 'pt')).toBe('{% endnote %}') + expect(fix('{%- nota de fim %}', 'pt')).toBe('{%- endnote %}') + }) + + test('fixes Dados variables → data variables', () => { + expect(fix('{% Dados variables.product.github %}', 'pt')).toBe( + '{% data variables.product.github %}', + ) + }) + + test('fixes fully translated audit_log reusable path', () => { + expect( + fix( + '{% dados agrupados por categoria.complemento.audit_log.reference-grouped-by-category %}', + 'pt', + ), + ).toBe('{% data reusables.audit_log.reference-grouped-by-category %}') + }) }) // ─── CHINESE (zh) ────────────────────────────────────────────────── @@ -350,6 +420,15 @@ describe('correctTranslatedContentStrings', () => { expect(fix('{% 否则 %}', 'zh')).toBe('{% else %}') expect(fix('{%- 否则 %}', 'zh')).toBe('{%- else %}') }) + + test('fixes 行标题 → rowheaders', () => { + expect(fix('{% 行标题 %}', 'zh')).toBe('{% rowheaders %}') + expect(fix('{%- 行标题 %}', 'zh')).toBe('{%- rowheaders %}') + }) + + test('fixes 数据变量 → data variables', () => { + expect(fix('{% 数据变量.product.github %}', 'zh')).toBe('{% data variables.product.github %}') + }) }) // ─── RUSSIAN (ru) ────────────────────────────────────────────────── @@ -453,6 +532,16 @@ describe('correctTranslatedContentStrings', () => { '{% raw %}some content{% endraw %}', ) expect(fix('{% конец %}', 'ru')).toBe('{% endif %}') + expect(fix('{%- конец %}', 'ru')).toBe('{%- endif %}') + }) + + test('fixes конец для → endfor', () => { + expect(fix('{%- конец для %}', 'ru')).toBe('{%- endfor %}') + }) + + test('fixes заголовки строк → rowheaders', () => { + expect(fix('{% заголовки строк %}', 'ru')).toBe('{% rowheaders %}') + expect(fix('{%- заголовки строк %}', 'ru')).toBe('{%- rowheaders %}') }) test('fixes translated feature flag names', () => { @@ -513,6 +602,20 @@ describe('correctTranslatedContentStrings', () => { test('fixes capitalized Mac → mac platform tag', () => { expect(fix('{% Mac %}', 'ru')).toBe('{% mac %}') }) + + test('fixes Endwindows → endwindows', () => { + expect(fix('{% Endwindows %}', 'ru')).toBe('{% endwindows %}') + expect(fix('{%- Endwindows %}', 'ru')).toBe('{%- endwindows %}') + }) + + test('fixes capitalized Elsif → elsif', () => { + expect(fix('{% Elsif ghec %}', 'ru')).toBe('{% elsif ghec %}') + }) + + test('fixes capitalized Linux → linux platform tag', () => { + expect(fix('{% Linux %}', 'ru')).toBe('{% linux %}') + expect(fix('{%- Linux %}', 'ru')).toBe('{%- linux %}') + }) }) // ─── FRENCH (fr) ─────────────────────────────────────────────────── @@ -550,6 +653,13 @@ describe('correctTranslatedContentStrings', () => { ).toBe('{% if query.apiVersion == nil or "2026-03-10" <= query.apiVersion %}') }) + test('fixes et → and in ifversion tags', () => { + expect(fix('{% ifversion ghes > 3.14 et ghes < 3.20 %}', 'fr')).toBe( + '{% ifversion ghes > 3.14 and ghes < 3.20 %}', + ) + expect(fix('{%- ifversion ghes et fpt %}', 'fr')).toBe('{%- ifversion ghes and fpt %}') + }) + test('fixes French guillemets « » → " in if/ifversion tags', () => { expect( fix('{% if query.apiVersion == nil ou « 2026-03-10 » <= query.apiVersion %}', 'fr'), @@ -592,6 +702,16 @@ describe('correctTranslatedContentStrings', () => { expect(fix('{% sinon %}', 'fr')).toBe('{% else %}') expect(fix('{%- sinon %}', 'fr')).toBe('{%- else %}') }) + + test('fixes note de fin → endnote', () => { + expect(fix('{% note de fin %}', 'fr')).toBe('{% endnote %}') + expect(fix('{%- note de fin %}', 'fr')).toBe('{%- endnote %}') + }) + + test('fixes éclipse → eclipse platform tag', () => { + expect(fix('{% éclipse %}', 'fr')).toBe('{% eclipse %}') + expect(fix('{%- éclipse %}', 'fr')).toBe('{%- eclipse %}') + }) }) // ─── KOREAN (ko) ────────────────────────────────────────────────── @@ -625,6 +745,7 @@ describe('correctTranslatedContentStrings', () => { test('fixes translated keywords', () => { expect(fix('{% 기타 %}', 'ko')).toBe('{% else %}') + expect(fix('{%- 기타 %}', 'ko')).toBe('{%- else %}') expect(fix('{% 참고 %}', 'ko')).toBe('{% note %}') expect(fix('{% 원시 %}', 'ko')).toBe('{% raw %}') }) @@ -647,6 +768,28 @@ describe('correctTranslatedContentStrings', () => { '{% octicon "check" aria-label="Supported" %}', ) }) + + test('fixes 데이터 재사용 → data reusables', () => { + expect(fix('{% 데이터 재사용.profile.access_org %}', 'ko')).toBe( + '{% data reusables.profile.access_org %}', + ) + }) + + test('fixes datavariable → data variables', () => { + expect(fix('{% datavariable.product.github %}', 'ko')).toBe( + '{% data variables.product.github %}', + ) + }) + + test('fixes 행 머리글 → rowheaders', () => { + expect(fix('{% 행 머리글 %}', 'ko')).toBe('{% rowheaders %}') + expect(fix('{%- 행 머리글 %}', 'ko')).toBe('{%- rowheaders %}') + }) + + test('fixes 윈도우즈 → windows', () => { + expect(fix('{% 윈도우즈 %}', 'ko')).toBe('{% windows %}') + expect(fix('{%- 윈도우즈 %}', 'ko')).toBe('{%- windows %}') + }) }) // ─── GERMAN (de) ────────────────────────────────────────────────── @@ -723,10 +866,128 @@ describe('correctTranslatedContentStrings', () => { expect(fix('{%- ansonsten %}', 'de')).toBe('{%- else %}') }) + test('fixes andernfalls and sonst → else', () => { + expect(fix('{% andernfalls %}', 'de')).toBe('{% else %}') + expect(fix('{%- andernfalls %}', 'de')).toBe('{%- else %}') + expect(fix('{% sonst %}', 'de')).toBe('{% else %}') + expect(fix('{%- sonst %}', 'de')).toBe('{%- else %}') + }) + + test('fixes andernfalls/sonst ifversion → elsif', () => { + expect(fix('{% andernfalls ifversion ghes %}', 'de')).toBe('{% elsif ghes %}') + expect(fix('{% sonst ifversion ghes %}', 'de')).toBe('{% elsif ghes %}') + }) + + test('fixes Datenvariablen → data variables', () => { + expect(fix('{% Datenvariablen.product.github %}', 'de')).toBe( + '{% data variables.product.github %}', + ) + expect(fix('{%- Datenvariablen.release-phases.public_preview %}', 'de')).toBe( + '{%- data variables.release-phases.public_preview %}', + ) + }) + + test('fixes daten wiederverwendbars → data reusables', () => { + expect(fix('{% daten wiederverwendbars.enterprise-accounts.ai-controls-tab %}', 'de')).toBe( + '{% data reusables.enterprise-accounts.ai-controls-tab %}', + ) + }) + test('fixes Zeilenkopfzeilen → rowheaders', () => { expect(fix('{% Zeilenkopfzeilen %}', 'de')).toBe('{% rowheaders %}') expect(fix('{%- Zeilenkopfzeilen %}', 'de')).toBe('{%- rowheaders %}') }) + + test('fixes Rohdaten → raw', () => { + expect(fix('{% Rohdaten %}', 'de')).toBe('{% raw %}') + expect(fix('{%- Rohdaten %}', 'de')).toBe('{%- raw %}') + expect(fix('{%- Rohdaten -%}', 'de')).toBe('{%- raw -%}') + }) + + test('fixes okticon → octicon', () => { + expect(fix('{% okticon "pencil" %}', 'de')).toBe('{% octicon "pencil" %}') + }) + + test('fixes Endnotiz → endnote', () => { + expect(fix('{% Endnotiz %}', 'de')).toBe('{% endnote %}') + expect(fix('{%- Endnotiz %}', 'de')).toBe('{%- endnote %}') + }) + + test('fixes endifen → endif', () => { + expect(fix('{% endifen %}', 'de')).toBe('{% endif %}') + expect(fix('{%- endifen %}', 'de')).toBe('{%- endif %}') + }) + + test('fixes Dateninstanz → data', () => { + expect(fix('{% Dateninstanz variables.product.github %}', 'de')).toBe( + '{% data variables.product.github %}', + ) + }) + + test('fixes ifversion-Sicherheitskonfigurationen', () => { + expect(fix('{% ifversion-Sicherheitskonfigurationen %}', 'de')).toBe( + '{% ifversion security-configurations %}', + ) + }) + + test('fixes ifversion-Unterprobleme', () => { + expect(fix('{% ifversion-Unterprobleme %}', 'de')).toBe('{% ifversion sub-issues %}') + }) + + test('fixes ifversion-Sicherheitskampagnen', () => { + expect(fix('{% ifversion-Sicherheitskampagnen %}', 'de')).toBe( + '{% ifversion security-campaigns %}', + ) + }) + + test('fixes capitalized Windows → windows platform tag', () => { + expect(fix('{% Windows %}', 'de')).toBe('{% windows %}') + expect(fix('{%- Windows %}', 'de')).toBe('{%- windows %}') + }) + + test('fixes capitalized Linux → linux platform tag', () => { + expect(fix('{% Linux %}', 'de')).toBe('{% linux %}') + expect(fix('{%- Linux %}', 'de')).toBe('{%- linux %}') + }) + + test('fixes capitalized Eclipse → eclipse platform tag', () => { + expect(fix('{% Eclipse %}', 'de')).toBe('{% eclipse %}') + expect(fix('{%- Eclipse %}', 'de')).toBe('{%- eclipse %}') + }) + + test('fixes unformatierte → raw', () => { + expect(fix('{% unformatierte %}', 'de')).toBe('{% raw %}') + }) + + test('fixes Daten variables → data variables', () => { + expect(fix('{% Daten variables.product.github %}', 'de')).toBe( + '{% data variables.product.github %}', + ) + }) + + test('fixes daten wiederverwendbar/wiederverwendbare → data reusables', () => { + expect(fix('{% daten wiederverwendbar.foo.bar %}', 'de')).toBe('{% data reusables.foo.bar %}') + expect(fix('{% daten wiederverwendbare.foo.bar %}', 'de')).toBe( + '{% data reusables.foo.bar %}', + ) + }) + + test('fixes Endifen and Endif → endif', () => { + expect(fix('{% Endifen %}', 'de')).toBe('{% endif %}') + expect(fix('{% Endif %}', 'de')).toBe('{% endif %}') + }) + + test('fixes ifversion-repo-policy-rules', () => { + expect(fix('{% ifversion-repo-policy-rules %}', 'de')).toBe( + '{% ifversion repo-policy-rules %}', + ) + }) + + test('fixes ifversion-enterprise-installed-apps', () => { + expect(fix('{% ifversion-enterprise-installed-apps %}', 'de')).toBe( + '{% ifversion enterprise-installed-apps %}', + ) + }) }) describe('Generic fixes (all languages)', () => { @@ -744,6 +1005,12 @@ describe('correctTranslatedContentStrings', () => { expect(fix('{% Data ifversion ghec %}', 'es')).toBe('{% data ifversion ghec %}') }) + test('fixes capitalized platform tags across all languages', () => { + expect(fix('{% Windows %}', 'zh')).toBe('{% windows %}') + expect(fix('{% Eclipse %}', 'zh')).toBe('{% eclipse %}') + expect(fix('{% Linux %}', 'zh')).toBe('{% linux %}') + }) + test('fixes AUTOTITLE corruption patterns', () => { expect(fix('["AUTOTITLE](/path)', 'es')).toBe('"[AUTOTITLE](/path)') expect(fix('[ AUTOTITLE](/path)', 'es')).toBe('[AUTOTITLE](/path)') diff --git a/src/redirects/middleware/handle-redirects.ts b/src/redirects/middleware/handle-redirects.ts index c7850e3c1215..c5f6b485ab98 100644 --- a/src/redirects/middleware/handle-redirects.ts +++ b/src/redirects/middleware/handle-redirects.ts @@ -41,7 +41,7 @@ export default function handleRedirects(req: ExtendedRequest, res: Response, nex } // Forward query params to the new URL - let queryParams = new URLSearchParams((req?.query as any) || '').toString() + let queryParams = new URLSearchParams(req?.query as URLSearchParamsTypes).toString() if (queryParams) { queryParams = `?${queryParams}` } diff --git a/src/rest/data/ghec-2022-11-28/actions.json b/src/rest/data/ghec-2022-11-28/actions.json index 1dccba3ff451..61dc8084f1aa 100644 --- a/src/rest/data/ghec-2022-11-28/actions.json +++ b/src/rest/data/ghec-2022-11-28/actions.json @@ -28,7 +28,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -37,7 +37,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -632,7 +632,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -641,7 +641,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1645,7 +1645,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1654,7 +1654,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2216,7 +2216,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2225,7 +2225,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2616,7 +2616,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2625,7 +2625,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5110,7 +5110,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5119,7 +5119,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9296,7 +9296,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9305,7 +9305,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9931,7 +9931,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

\n

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

", + "descriptionHTML": "

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

\n

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

", "codeExamples": [ { "request": { @@ -10021,7 +10021,7 @@ "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

" } ], - "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"

\n

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

", + "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"

\n

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

", "codeExamples": [ { "request": { @@ -10766,7 +10766,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10775,7 +10775,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -12185,7 +12185,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -12194,7 +12194,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13321,7 +13321,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -13415,7 +13415,7 @@ "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

" } ], - "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

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

", + "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

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

", "codeExamples": [ { "request": { @@ -13676,7 +13676,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

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

", + "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

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

", "codeExamples": [ { "request": { @@ -13774,7 +13774,7 @@ ] } ], - "descriptionHTML": "

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

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

", + "descriptionHTML": "

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

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

", "codeExamples": [ { "request": { @@ -14572,7 +14572,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

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

", + "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

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

", "codeExamples": [ { "request": { @@ -14676,7 +14676,7 @@ "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

" } ], - "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

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

", + "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

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

", "codeExamples": [ { "request": { @@ -14741,7 +14741,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14750,7 +14750,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15100,7 +15100,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", "isRequired": true }, { @@ -15123,10 +15123,10 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users 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.

", + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users 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.

", "codeExamples": [ { "request": { @@ -15299,7 +15299,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15308,7 +15308,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16194,11 +16194,11 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Add selected repository to an organization secret and Remove selected repository from an organization secret endpoints.

", + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Add selected repository to an organization secret and Remove selected repository from an organization secret endpoints.

", "isRequired": true } ], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\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.

", + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\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.

", "codeExamples": [ { "request": { @@ -16276,7 +16276,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. For more information about setting the visibility, see Create or\nupdate an organization secret.

\n

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

\n

OAuth tokens and personal access tokens (classic) need the admin: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.

", + "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. For more information about setting the visibility, see Create or\nupdate an organization secret.

\n

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

\n

OAuth tokens and personal access tokens (classic) need the admin: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.

", "codeExamples": [ { "request": { @@ -16354,7 +16354,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\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.

", + "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\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.

", "codeExamples": [ { "request": { @@ -16423,7 +16423,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16432,7 +16432,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16559,7 +16559,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16568,7 +16568,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16909,7 +16909,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", "isRequired": true }, { @@ -16919,7 +16919,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

\n

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

", + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

\n

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

", "codeExamples": [ { "request": { @@ -17103,7 +17103,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -17112,7 +17112,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -17483,7 +17483,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

", "isRequired": true }, { @@ -17493,7 +17493,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

\n

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

", + "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

\n

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

", "codeExamples": [ { "request": { @@ -17673,7 +17673,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -17682,7 +17682,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18434,7 +18434,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18443,7 +18443,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18820,7 +18820,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18829,7 +18829,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -19245,7 +19245,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -19254,7 +19254,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20067,7 +20067,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20076,7 +20076,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20378,7 +20378,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20387,7 +20387,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21667,7 +21667,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21676,7 +21676,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -22118,7 +22118,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -22127,7 +22127,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25132,7 +25132,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25141,7 +25141,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28203,7 +28203,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28212,7 +28212,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31370,7 +31370,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31379,7 +31379,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31918,7 +31918,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31927,7 +31927,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -33050,7 +33050,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -33059,7 +33059,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -33194,7 +33194,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -33203,7 +33203,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -33709,7 +33709,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -33718,7 +33718,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -34751,7 +34751,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -34760,7 +34760,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -34769,7 +34769,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists jobs for a specific workflow run attempt. 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.

", + "descriptionHTML": "

Lists jobs for a specific workflow run attempt. 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.

", "codeExamples": [ { "request": { @@ -35209,7 +35209,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35218,7 +35218,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35227,7 +35227,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -35754,7 +35754,7 @@ }, { "name": "event", - "description": "

Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

", + "description": "

Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

", "in": "query", "required": false, "schema": { @@ -35788,7 +35788,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35797,7 +35797,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35806,7 +35806,7 @@ }, { "name": "created", - "description": "

Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"

", + "description": "

Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"

", "in": "query", "required": false, "schema": { @@ -35843,7 +35843,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -40910,7 +40910,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -43537,7 +43537,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -45210,7 +45210,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n


\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.

\n
\n

Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\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.

", + "descriptionHTML": "

Warning

\n


\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.

\n
\n

Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\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.

", "codeExamples": [ { "request": { @@ -45478,7 +45478,7 @@ }, { "name": "event", - "description": "

Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

", + "description": "

Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

", "in": "query", "required": false, "schema": { @@ -45512,7 +45512,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -45521,7 +45521,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -45530,7 +45530,7 @@ }, { "name": "created", - "description": "

Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"

", + "description": "

Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"

", "in": "query", "required": false, "schema": { @@ -45567,7 +45567,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. 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.

", + "descriptionHTML": "

List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. 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.

", "codeExamples": [ { "request": { @@ -47910,7 +47910,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -47919,7 +47919,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -48573,7 +48573,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n


\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.

\n
\n

Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\n

You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\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.

", + "descriptionHTML": "

Warning

\n


\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.

\n
\n

Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\n

You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\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.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/activity.json b/src/rest/data/ghec-2022-11-28/activity.json index 7061b3caa908..4bfde5f297bc 100644 --- a/src/rest/data/ghec-2022-11-28/activity.json +++ b/src/rest/data/ghec-2022-11-28/activity.json @@ -10,7 +10,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -19,7 +19,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9987,7 +9987,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9996,7 +9996,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -19963,7 +19963,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -19972,7 +19972,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -29945,7 +29945,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -29954,7 +29954,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -39909,7 +39909,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -39918,7 +39918,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -49877,7 +49877,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -49886,7 +49886,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -59859,7 +59859,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -59868,7 +59868,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -69818,7 +69818,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -69827,7 +69827,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -79782,7 +79782,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -79791,7 +79791,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -89738,7 +89738,7 @@ "subcategory": "feeds", "parameters": [], "bodyParameters": [], - "descriptionHTML": "

Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

\n
    \n
  • Timeline: The GitHub Enterprise Cloud global public timeline
  • \n
  • User: The public timeline for any user, using uri_template. For more information, see \"Hypermedia.\"
  • \n
  • Current user public: The public timeline for the authenticated user
  • \n
  • Current user: The private timeline for the authenticated user
  • \n
  • Current user actor: The private timeline for activity created by the authenticated user
  • \n
  • Current user organizations: The private timeline for the organizations the authenticated user is a member of.
  • \n
  • Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.
  • \n
\n

By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"

\n

Note

\n

\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

\n
", + "descriptionHTML": "

Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

\n
    \n
  • Timeline: The GitHub Enterprise Cloud global public timeline
  • \n
  • User: The public timeline for any user, using uri_template. For more information, see \"Hypermedia.\"
  • \n
  • Current user public: The public timeline for the authenticated user
  • \n
  • Current user: The private timeline for the authenticated user
  • \n
  • Current user actor: The private timeline for activity created by the authenticated user
  • \n
  • Current user organizations: The private timeline for the organizations the authenticated user is a member of.
  • \n
  • Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.
  • \n
\n

By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"

\n

Note

\n

\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

\n
", "codeExamples": [ { "request": { @@ -90097,7 +90097,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -90106,7 +90106,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 50). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 50). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -91054,7 +91054,7 @@ "description": "

Whether the notification has been read.

" } ], - "descriptionHTML": "

Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the List notifications for the authenticated user endpoint and pass the query parameter all=false.

", + "descriptionHTML": "

Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the List notifications for the authenticated user endpoint and pass the query parameter all=false.

", "codeExamples": [ { "request": { @@ -91124,7 +91124,7 @@ "parameters": [ { "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", + "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", "in": "path", "required": true, "schema": { @@ -92056,7 +92056,7 @@ "parameters": [ { "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", + "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", "in": "path", "required": true, "schema": { @@ -92113,7 +92113,7 @@ "parameters": [ { "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", + "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", "in": "path", "required": true, "schema": { @@ -92162,7 +92162,7 @@ "parameters": [ { "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", + "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", "in": "path", "required": true, "schema": { @@ -92171,7 +92171,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

\n

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were @mentioned, or manually subscribe to a thread.

", + "descriptionHTML": "

This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

\n

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were @mentioned, or manually subscribe to a thread.

", "codeExamples": [ { "request": { @@ -92277,7 +92277,7 @@ "parameters": [ { "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", + "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", "in": "path", "required": true, "schema": { @@ -92293,7 +92293,7 @@ "default": false } ], - "descriptionHTML": "

If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an @mention.

\n

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

\n

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.

", + "descriptionHTML": "

If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an @mention.

\n

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

\n

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.

", "codeExamples": [ { "request": { @@ -92403,7 +92403,7 @@ "parameters": [ { "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", + "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", "in": "path", "required": true, "schema": { @@ -92412,7 +92412,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Mutes all future notifications for a conversation until you comment on the thread or get an @mention. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the Set a thread subscription endpoint and set ignore to true.

", + "descriptionHTML": "

Mutes all future notifications for a conversation until you comment on the thread or get an @mention. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the Set a thread subscription endpoint and set ignore to true.

", "codeExamples": [ { "request": { @@ -92522,7 +92522,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -92531,7 +92531,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -93481,7 +93481,7 @@ "description": "

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

" } ], - "descriptionHTML": "

Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the List repository notifications for the authenticated user endpoint and pass the query parameter all=false.

", + "descriptionHTML": "

Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the List repository notifications for the authenticated user endpoint and pass the query parameter all=false.

", "codeExamples": [ { "request": { @@ -93565,7 +93565,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -93574,7 +93574,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -93583,7 +93583,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the people that have starred the repository.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
  • \n
", + "descriptionHTML": "

Lists the people that have starred the repository.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
  • \n
", "codeExamples": [ { "request": { @@ -94232,7 +94232,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -94241,7 +94241,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -94250,7 +94250,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
  • \n
", + "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
  • \n
", "codeExamples": [ { "request": { @@ -96042,7 +96042,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "codeExamples": [ { "request": { @@ -96221,7 +96221,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -96230,7 +96230,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -96239,7 +96239,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists repositories a user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
  • \n
", + "descriptionHTML": "

Lists repositories a user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
  • \n
", "codeExamples": [ { "request": { @@ -97809,7 +97809,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -97818,7 +97818,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -98156,7 +98156,7 @@ "description": "

Determines if all notifications should be blocked from this repository.

" } ], - "descriptionHTML": "

If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository's subscription completely.

", + "descriptionHTML": "

If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository's subscription completely.

", "codeExamples": [ { "request": { @@ -98270,7 +98270,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.

", + "descriptionHTML": "

This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.

", "codeExamples": [ { "request": { @@ -98311,7 +98311,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -98320,7 +98320,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -99240,7 +99240,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -99249,7 +99249,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/announcement-banners.json b/src/rest/data/ghec-2022-11-28/announcement-banners.json index ace3bb7dd4a2..3cc624155a9a 100644 --- a/src/rest/data/ghec-2022-11-28/announcement-banners.json +++ b/src/rest/data/ghec-2022-11-28/announcement-banners.json @@ -48,7 +48,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ @@ -112,7 +112,7 @@ { "type": "string or null", "name": "announcement", - "description": "

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

", + "description": "

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

", "isRequired": true }, { @@ -162,7 +162,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ @@ -303,7 +303,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ @@ -371,7 +371,7 @@ { "type": "string or null", "name": "announcement", - "description": "

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

", + "description": "

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

", "isRequired": true }, { @@ -421,7 +421,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ diff --git a/src/rest/data/ghec-2022-11-28/apps.json b/src/rest/data/ghec-2022-11-28/apps.json index 4666c19683bd..5bcf4923380a 100644 --- a/src/rest/data/ghec-2022-11-28/apps.json +++ b/src/rest/data/ghec-2022-11-28/apps.json @@ -9,7 +9,7 @@ "subcategory": "apps", "parameters": [], "bodyParameters": [], - "descriptionHTML": "

Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -380,7 +380,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App's id, pem (private key), and webhook_secret.

", + "descriptionHTML": "

Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App's id, pem (private key), and webhook_secret.

", "codeExamples": [ { "request": { @@ -787,7 +787,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -796,7 +796,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1219,7 +1219,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1228,7 +1228,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1256,7 +1256,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The permissions the installation has are included under the permissions key.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

The permissions the installation has are included under the permissions key.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -2226,7 +2226,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

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

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -3198,7 +3198,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -3772,7 +3772,7 @@ ] } ], - "descriptionHTML": "

Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an enterprise, organization, or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.

\n

Optionally, you can use the repositories or repository_ids body parameters to specify individual repositories that the installation access token can access. If you don't use repositories or repository_ids to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.

\n

Optionally, use the permissions body parameter to specify the permissions that the installation access token should have. If permissions is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.

\n

Enterprise account installations do not have access to repositories and cannot be scoped down using the permissions parameter.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an enterprise, organization, or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.

\n

Optionally, you can use the repositories or repository_ids body parameters to specify individual repositories that the installation access token can access. If you don't use repositories or repository_ids to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.

\n

Optionally, use the permissions body parameter to specify the permissions that the installation access token should have. If permissions is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.

\n

Enterprise account installations do not have access to repositories and cannot be scoped down using the permissions parameter.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -5152,7 +5152,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -5205,7 +5205,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes a GitHub App installation suspension.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Removes a GitHub App installation suspension.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -7166,7 +7166,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find its installation on a particular enterprise.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Enables an authenticated GitHub App to find its installation on a particular enterprise.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -8135,7 +8135,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

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

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -9113,7 +9113,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -10091,7 +10091,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find the user’s installation information.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Enables an authenticated GitHub App to find the user’s installation information.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -11053,7 +11053,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11062,7 +11062,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11945,7 +11945,7 @@ "subcategory": "installations", "parameters": [], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -11985,7 +11985,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11994,7 +11994,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13052,7 +13052,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13061,7 +13061,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14112,7 +14112,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "codeExamples": [ { "request": { @@ -14459,7 +14459,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14468,7 +14468,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14477,7 +14477,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "codeExamples": [ { "request": { @@ -14656,7 +14656,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14665,7 +14665,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14674,7 +14674,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "codeExamples": [ { "request": { @@ -15038,7 +15038,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "codeExamples": [ { "request": { @@ -15385,7 +15385,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15394,7 +15394,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15403,7 +15403,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "codeExamples": [ { "request": { @@ -15578,7 +15578,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15587,7 +15587,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15596,7 +15596,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "codeExamples": [ { "request": { @@ -15943,7 +15943,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15952,7 +15952,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16218,7 +16218,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16227,7 +16227,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18520,7 +18520,7 @@ "subcategory": "webhooks", "parameters": [], "bodyParameters": [], - "descriptionHTML": "

Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -18553,7 +18553,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -18607,7 +18607,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -18615,7 +18615,7 @@ "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" } ], - "descriptionHTML": "

Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -18655,7 +18655,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -18697,7 +18697,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18728,7 +18728,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns a list of webhook deliveries for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Returns a list of webhook deliveries for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -18901,7 +18901,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns a delivery for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Returns a delivery for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -19141,7 +19141,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Redeliver a delivery for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Redeliver a delivery for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/billing.json b/src/rest/data/ghec-2022-11-28/billing.json index 69df9c7b6a9c..e5ec4cf73e5c 100644 --- a/src/rest/data/ghec-2022-11-28/billing.json +++ b/src/rest/data/ghec-2022-11-28/billing.json @@ -32,7 +32,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -41,7 +41,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1510,7 +1510,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1519,7 +1519,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2543,7 +2543,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.

\n

Note: This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"About the enhanced billing platform for enterprises.\"

", + "descriptionHTML": "

Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.

\n

Note: This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"About the enhanced billing platform for enterprises.\"

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/branches.json b/src/rest/data/ghec-2022-11-28/branches.json index 69165d31f32a..62ce1c6f4aa2 100644 --- a/src/rest/data/ghec-2022-11-28/branches.json +++ b/src/rest/data/ghec-2022-11-28/branches.json @@ -37,7 +37,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -46,7 +46,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2054,7 +2054,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -4673,7 +4673,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -4689,7 +4689,7 @@ "isRequired": true } ], - "descriptionHTML": "

Renames a branch in a repository.

\n

Note

\n

\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n
\n

The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.

\n

In order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.

", + "descriptionHTML": "

Renames a branch in a repository.

\n

Note

\n

\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n
\n

The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.

\n

In order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.

", "codeExamples": [ { "request": { @@ -8138,7 +8138,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -8147,7 +8147,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -10288,7 +10288,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -10377,7 +10377,7 @@ { "type": "boolean", "name": "require_code_owner_reviews", - "description": "

Blocks merging pull requests until code owners review them.

" + "description": "

Blocks merging pull requests until code owners review them.

" }, { "type": "integer", @@ -10442,17 +10442,17 @@ { "type": "boolean", "name": "required_linear_history", - "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" + "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" }, { "type": "boolean or null", "name": "allow_force_pushes", - "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" + "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" }, { "type": "boolean", "name": "allow_deletions", - "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" + "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" }, { "type": "boolean", @@ -10477,7 +10477,7 @@ "default": false } ], - "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

Protecting a branch requires admin or owner permissions to the repository.

\n

Note

\n

\nPassing new arrays of users and teams replaces their previous values.

\n
\n

Note

\n

\nThe list of users, apps, and teams in total is limited to 100 items.

\n
", + "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

Protecting a branch requires admin or owner permissions to the repository.

\n

Note

\n

\nPassing new arrays of users and teams replaces their previous values.

\n
\n

Note

\n

\nThe list of users, apps, and teams in total is limited to 100 items.

\n
", "codeExamples": [ { "request": { @@ -12560,7 +12560,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -12569,7 +12569,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -12637,7 +12637,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -12646,7 +12646,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -12733,7 +12733,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -12742,7 +12742,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -12829,7 +12829,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -12838,7 +12838,7 @@ } ], "bodyParameters": [], - "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

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

", + "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

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

", "codeExamples": [ { "request": { @@ -12906,7 +12906,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -12915,7 +12915,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -14333,7 +14333,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -14372,7 +14372,7 @@ { "type": "boolean", "name": "require_code_owner_reviews", - "description": "

Blocks merging pull requests until code owners have reviewed.

" + "description": "

Blocks merging pull requests until code owners have reviewed.

" }, { "type": "integer", @@ -14408,7 +14408,7 @@ ] } ], - "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

Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

\n

Note

\n

\nPassing new arrays of users and teams replaces their previous values.

\n
", + "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

Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

\n

Note

\n

\nPassing new arrays of users and teams replaces their previous values.

\n
", "codeExamples": [ { "request": { @@ -15859,7 +15859,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -15868,7 +15868,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -15936,7 +15936,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -15945,7 +15945,7 @@ } ], "bodyParameters": [], - "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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.

\n

Note

\n

\nYou must enable branch protection to require signed commits.

\n
", + "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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.

\n

Note

\n

\nYou must enable branch protection to require signed commits.

\n
", "codeExamples": [ { "request": { @@ -16036,7 +16036,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16045,7 +16045,7 @@ } ], "bodyParameters": [], - "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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.

", + "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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.

", "codeExamples": [ { "request": { @@ -16136,7 +16136,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16145,7 +16145,7 @@ } ], "bodyParameters": [], - "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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.

", + "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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.

", "codeExamples": [ { "request": { @@ -16213,7 +16213,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16222,7 +16222,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -16351,7 +16351,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16389,7 +16389,7 @@ ] } ], - "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

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", + "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

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", "codeExamples": [ { "request": { @@ -16529,7 +16529,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16538,7 +16538,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -16602,7 +16602,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16611,7 +16611,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -16689,7 +16689,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16705,7 +16705,7 @@ "isRequired": true } ], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -16799,7 +16799,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16815,7 +16815,7 @@ "isRequired": true } ], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -16903,7 +16903,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16919,7 +16919,7 @@ "isRequired": true } ], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -17007,7 +17007,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -17016,7 +17016,7 @@ } ], "bodyParameters": [], - "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

Lists who has access to this protected branch.

\n

Note

\n

\nUsers, apps, and teams restrictions are only available for organization-owned repositories.

\n
", + "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

Lists who has access to this protected branch.

\n

Note

\n

\nUsers, apps, and teams restrictions are only available for organization-owned repositories.

\n
", "codeExamples": [ { "request": { @@ -17608,7 +17608,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -17617,7 +17617,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -17681,7 +17681,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -17690,7 +17690,7 @@ } ], "bodyParameters": [], - "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

Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", + "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

Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", "codeExamples": [ { "request": { @@ -18087,7 +18087,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -18103,7 +18103,7 @@ "isRequired": true } ], - "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

Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", + "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

Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", "codeExamples": [ { "request": { @@ -18506,7 +18506,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -18522,7 +18522,7 @@ "isRequired": true } ], - "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

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", + "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

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", "codeExamples": [ { "request": { @@ -18925,7 +18925,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -18941,7 +18941,7 @@ "isRequired": true } ], - "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

Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", + "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

Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", "codeExamples": [ { "request": { @@ -19344,7 +19344,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -19353,7 +19353,7 @@ } ], "bodyParameters": [], - "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

Lists the teams who have push access to this branch. The list includes child teams.

", + "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

Lists the teams who have push access to this branch. The list includes child teams.

", "codeExamples": [ { "request": { @@ -19644,7 +19644,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -19660,7 +19660,7 @@ "isRequired": true } ], - "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

Grants the specified teams push access for this branch. You can also give push access to child teams.

", + "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

Grants the specified teams push access for this branch. You can also give push access to child teams.

", "codeExamples": [ { "request": { @@ -19957,7 +19957,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -19973,7 +19973,7 @@ "isRequired": true } ], - "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

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

", + "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

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

", "codeExamples": [ { "request": { @@ -20270,7 +20270,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -20286,7 +20286,7 @@ "isRequired": true } ], - "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

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

", + "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

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

", "codeExamples": [ { "request": { @@ -20583,7 +20583,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -20592,7 +20592,7 @@ } ], "bodyParameters": [], - "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

Lists the people who have push access to this branch.

", + "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

Lists the people who have push access to this branch.

", "codeExamples": [ { "request": { @@ -20797,7 +20797,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -20813,7 +20813,7 @@ "isRequired": true } ], - "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

Grants the specified people push access for this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "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

Grants the specified people push access for this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", "codeExamples": [ { "request": { @@ -21024,7 +21024,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -21040,7 +21040,7 @@ "isRequired": true } ], - "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

Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "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

Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", "codeExamples": [ { "request": { @@ -21251,7 +21251,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -21267,7 +21267,7 @@ "isRequired": true } ], - "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

Removes the ability of a user to push to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "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

Removes the ability of a user to push to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/campaigns.json b/src/rest/data/ghec-2022-11-28/campaigns.json index ecf12ee39d1d..50c882aef47c 100644 --- a/src/rest/data/ghec-2022-11-28/campaigns.json +++ b/src/rest/data/ghec-2022-11-28/campaigns.json @@ -19,7 +19,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/checks.json b/src/rest/data/ghec-2022-11-28/checks.json index 85bbbe30431e..2214eff4dfce 100644 --- a/src/rest/data/ghec-2022-11-28/checks.json +++ b/src/rest/data/ghec-2022-11-28/checks.json @@ -3317,7 +3317,7 @@ { "type": "array of objects", "name": "annotations", - "description": "

Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"About status checks\".

", + "description": "

Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"About status checks\".

", "childParamsGroups": [ { "type": "string", @@ -3405,7 +3405,7 @@ { "type": "array of objects", "name": "actions", - "description": "

Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", + "description": "

Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "childParamsGroups": [ { "type": "string", @@ -4534,7 +4534,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4543,7 +4543,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4711,7 +4711,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, the status of the check suite it belongs to is reset to queued and the conclusion is cleared. The check run itself is not updated. GitHub apps recieving the check_run webhook with the rerequested action should then decide if the check run should be reset or updated and call the update check_run endpoint to update the check_run if desired.

\n

For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".

", + "descriptionHTML": "

Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, the status of the check suite it belongs to is reset to queued and the conclusion is cleared. The check run itself is not updated. GitHub apps recieving the check_run webhook with the rerequested action should then decide if the check run should be reset or updated and call the update check_run endpoint to update the check_run if desired.

\n

For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".

", "codeExamples": [ { "request": { @@ -4842,7 +4842,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4851,7 +4851,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5985,7 +5985,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5994,7 +5994,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6012,7 +6012,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.

\n

Note

\n

\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
\n

If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the List check suites for a Git reference endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.

\n

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

", + "descriptionHTML": "

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.

\n

Note

\n

\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
\n

If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the List check suites for a Git reference endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -7100,7 +7100,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".

\n

Note

\n

\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

", + "descriptionHTML": "

Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".

\n

Note

\n

\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

", "codeExamples": [ { "request": { @@ -10428,7 +10428,7 @@ ] } ], - "descriptionHTML": "

Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite.\nYou must have admin permissions in the repository to set preferences for check suites.

", + "descriptionHTML": "

Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite.\nYou must have admin permissions in the repository to set preferences for check suites.

", "codeExamples": [ { "request": { @@ -13187,7 +13187,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

", + "descriptionHTML": "

Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

", "codeExamples": [ { "request": { @@ -13287,7 +13287,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13296,7 +13296,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/classroom.json b/src/rest/data/ghec-2022-11-28/classroom.json index 77d6d779a279..c3ab5b51a51d 100644 --- a/src/rest/data/ghec-2022-11-28/classroom.json +++ b/src/rest/data/ghec-2022-11-28/classroom.json @@ -325,7 +325,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -334,7 +334,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -829,7 +829,7 @@ "parameters": [ { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -838,7 +838,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1071,7 +1071,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1080,7 +1080,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/code-scanning.json b/src/rest/data/ghec-2022-11-28/code-scanning.json index 626b610d6698..cc5fb6e50a01 100644 --- a/src/rest/data/ghec-2022-11-28/code-scanning.json +++ b/src/rest/data/ghec-2022-11-28/code-scanning.json @@ -42,7 +42,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -51,7 +51,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -60,7 +60,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -69,7 +69,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -131,7 +131,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. 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 a member of the enterprise to use this endpoint.

\n

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

", + "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. 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 a member of the enterprise to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -1476,7 +1476,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1485,7 +1485,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1494,7 +1494,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1503,7 +1503,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1584,7 +1584,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -2942,7 +2942,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2951,7 +2951,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2993,7 +2993,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3002,7 +3002,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -6040,7 +6040,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6049,7 +6049,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6310,7 +6310,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6319,7 +6319,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6624,7 +6624,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified code scanning analysis for a repository.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

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

\n
    \n
  • application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.
  • \n
\n

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

", + "descriptionHTML": "

Gets a specified code scanning analysis for a repository.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

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

\n
    \n
  • application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -7358,7 +7358,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a CodeQL database for a language in a repository.

\n

By default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the Accept header of the request\nto application/zip, and make sure\nyour HTTP client is configured to follow redirects or use the Location header\nto make a second request to get the redirect URL.

\n

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

", + "descriptionHTML": "

Gets a CodeQL database for a language in a repository.

\n

By default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the Accept header of the request\nto application/zip, and make sure\nyour HTTP client is configured to follow redirects or use the Location header\nto make a second request to get the redirect URL.

\n

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

", "codeExamples": [ { "request": { @@ -7727,7 +7727,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.

\n

Get started by learning more about running CodeQL queries at scale with Multi-Repository Variant Analysis.

\n

Use the owner and repo parameters in the URL to specify the controller repository that\nwill be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.

\n

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

", + "descriptionHTML": "

Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.

\n

Get started by learning more about running CodeQL queries at scale with Multi-Repository Variant Analysis.

\n

Use the owner and repo parameters in the URL to specify the controller repository that\nwill be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.

\n

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

", "codeExamples": [ { "request": { @@ -12921,7 +12921,7 @@ { "type": "string", "name": "sarif", - "description": "

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

", + "description": "

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

", "isRequired": true }, { @@ -12945,7 +12945,7 @@ "description": "

Whether the SARIF file will be validated according to the code scanning specifications.\nThis parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.

" } ], - "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n

SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file20
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Tool extensions per run100
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
Tags per rule20Only 10 tags will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

\n

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

\n

This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.

", + "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n

SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file20
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Tool extensions per run100
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
Tags per rule20Only 10 tags will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

\n

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

\n

This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.

", "codeExamples": [ { "request": { @@ -13230,7 +13230,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13239,7 +13239,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13656,7 +13656,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13665,7 +13665,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/code-security.json b/src/rest/data/ghec-2022-11-28/code-security.json index 01e00fe33a9b..a368c04b2211 100644 --- a/src/rest/data/ghec-2022-11-28/code-security.json +++ b/src/rest/data/ghec-2022-11-28/code-security.json @@ -20,7 +20,7 @@ { "name": "per_page", "in": "query", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "required": false, "schema": { "type": "integer", @@ -29,7 +29,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -38,7 +38,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3301,7 +3301,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3311,7 +3311,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3320,7 +3320,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3877,7 +3877,7 @@ { "name": "per_page", "in": "query", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "required": false, "schema": { "type": "integer", @@ -3886,7 +3886,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3895,7 +3895,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7414,7 +7414,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7424,7 +7424,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7433,7 +7433,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { diff --git a/src/rest/data/ghec-2022-11-28/codespaces.json b/src/rest/data/ghec-2022-11-28/codespaces.json index 26f420520c78..3e581e26236f 100644 --- a/src/rest/data/ghec-2022-11-28/codespaces.json +++ b/src/rest/data/ghec-2022-11-28/codespaces.json @@ -10,7 +10,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -19,7 +19,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4645,7 +4645,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4654,7 +4654,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8160,7 +8160,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8169,7 +8169,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -23748,7 +23748,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -23757,7 +23757,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24105,7 +24105,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

The value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" + "description": "

The value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" }, { "type": "string", @@ -24126,10 +24126,10 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" + "description": "

An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" } ], - "descriptionHTML": "

Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

", + "descriptionHTML": "

Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

", "codeExamples": [ { "request": { @@ -24314,7 +24314,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24323,7 +24323,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25213,11 +25213,11 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", "isRequired": true } ], - "descriptionHTML": "

Replaces all repositories for an organization development environment secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", + "descriptionHTML": "

Replaces all repositories for an organization development environment secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", "codeExamples": [ { "request": { @@ -25303,7 +25303,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Adds a repository to an organization development environment secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Adds a repository to an organization development environment secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -25389,7 +25389,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes a repository from an organization development environment secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", + "descriptionHTML": "

Removes a repository from an organization development environment secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", "codeExamples": [ { "request": { @@ -25450,7 +25450,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25459,7 +25459,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -27361,7 +27361,7 @@ "isRequired": true } ], - "descriptionHTML": "

Codespaces for the specified users will be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

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

", + "descriptionHTML": "

Codespaces for the specified users will be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

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

", "codeExamples": [ { "request": { @@ -27448,7 +27448,7 @@ "isRequired": true } ], - "descriptionHTML": "

Codespaces for the specified users will no longer be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

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

", + "descriptionHTML": "

Codespaces for the specified users will no longer be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

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

", "codeExamples": [ { "request": { @@ -27519,7 +27519,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -27528,7 +27528,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -30940,7 +30940,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -30949,7 +30949,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31293,7 +31293,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" }, { "type": "string", @@ -31301,7 +31301,7 @@ "description": "

ID of the key you used to encrypt the secret.

" } ], - "descriptionHTML": "

Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The associated user must be a repository admin.

", + "descriptionHTML": "

Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The associated user must be a repository admin.

", "codeExamples": [ { "request": { @@ -31460,7 +31460,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31469,7 +31469,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31773,7 +31773,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get the public key for the authenticated user endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get the public key for the authenticated user endpoint.

" }, { "type": "string", @@ -31784,10 +31784,10 @@ { "type": "array", "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the user secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Set selected repositories for a user secret, and Remove a selected repository from a user secret endpoints.

" + "description": "

An array of repository ids that can access the user secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Set selected repositories for a user secret, and Remove a selected repository from a user secret endpoints.

" } ], - "descriptionHTML": "

Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\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.

", + "descriptionHTML": "

Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\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.

", "codeExamples": [ { "request": { @@ -33000,7 +33000,7 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Add a selected repository to a user secret, and Remove a selected repository from a user secret endpoints.

", + "description": "

An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Add a selected repository to a user secret, and Remove a selected repository from a user secret endpoints.

", "isRequired": true } ], diff --git a/src/rest/data/ghec-2022-11-28/collaborators.json b/src/rest/data/ghec-2022-11-28/collaborators.json index f25c08bc8f66..a70154ec176a 100644 --- a/src/rest/data/ghec-2022-11-28/collaborators.json +++ b/src/rest/data/ghec-2022-11-28/collaborators.json @@ -59,7 +59,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -68,7 +68,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -408,7 +408,7 @@ "default": "push" } ], - "descriptionHTML": "

Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an \"outside collaborator\" (if they are not an Enterprise Managed User) or a \"repository collaborator\" if they are an Enterprise Managed User. These users are exempt from some organization policies - see \"Adding outside collaborators to repositories\" to learn more about these collaborator types.

\n

This endpoint triggers notifications.

\n

Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see \"Enforcing repository management policies in your enterprise\" and \"Setting permissions for adding outside collaborators\" for organization settings.

\n

For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

\n
Cannot assign {member} permission of {role name}\n
\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.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the API.

\n

For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise.

\n

Updating an existing collaborator's permission level

\n

The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.

\n

Rate limits

\n

You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", + "descriptionHTML": "

Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an \"outside collaborator\" (if they are not an Enterprise Managed User) or a \"repository collaborator\" if they are an Enterprise Managed User. These users are exempt from some organization policies - see \"Adding outside collaborators to repositories\" to learn more about these collaborator types.

\n

This endpoint triggers notifications.

\n

Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see \"Enforcing repository management policies in your enterprise\" and \"Setting permissions for adding outside collaborators\" for organization settings.

\n

For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

\n
Cannot assign {member} permission of {role name}\n
\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.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the API.

\n

For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise.

\n

Updating an existing collaborator's permission level

\n

The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.

\n

Rate limits

\n

You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", "codeExamples": [ { "request": { @@ -1624,7 +1624,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n
    \n
  • Cancels any outstanding invitations sent by the collaborator
  • \n
  • Unassigns the user from any issues
  • \n
  • Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.
  • \n
  • Unstars the repository
  • \n
  • Updates access permissions to packages
  • \n
\n

Removing a user as a collaborator has the following effects on forks:

\n
    \n
  • If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.
  • \n
  • If the user had their own fork of the repository, the fork will be deleted.
  • \n
  • If the user still has read access to the repository, open pull requests by this user from a fork will be denied.
  • \n
\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", + "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n
    \n
  • Cancels any outstanding invitations sent by the collaborator
  • \n
  • Unassigns the user from any issues
  • \n
  • Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.
  • \n
  • Unstars the repository
  • \n
  • Updates access permissions to packages
  • \n
\n

Removing a user as a collaborator has the following effects on forks:

\n
    \n
  • If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.
  • \n
  • If the user had their own fork of the repository, the fork will be deleted.
  • \n
  • If the user still has read access to the repository, open pull requests by this user from a fork will be denied.
  • \n
\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", "codeExamples": [ { "request": { @@ -1962,7 +1962,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1971,7 +1971,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4451,7 +4451,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4460,7 +4460,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/commits.json b/src/rest/data/ghec-2022-11-28/commits.json index 989c41f6e357..515bc078c525 100644 --- a/src/rest/data/ghec-2022-11-28/commits.json +++ b/src/rest/data/ghec-2022-11-28/commits.json @@ -84,7 +84,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -93,7 +93,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -794,7 +794,7 @@ } ], "bodyParameters": [], - "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

Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.

", + "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

Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.

", "codeExamples": [ { "request": { @@ -923,7 +923,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -932,7 +932,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4514,7 +4514,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4523,7 +4523,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4541,7 +4541,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note

\n

\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
  • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.
  • \n
  • application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
  • \n
\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note

\n

\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
  • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.
  • \n
  • application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
  • \n
\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "codeExamples": [ { "request": { @@ -5301,7 +5301,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5310,7 +5310,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5328,7 +5328,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
  • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
  • \n
\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.
  • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
  • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
  • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
  • \n
\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.
  • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
  • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "codeExamples": [ { "request": { @@ -7397,7 +7397,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7406,7 +7406,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7415,7 +7415,7 @@ } ], "bodyParameters": [], - "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
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "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
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -7779,7 +7779,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified commit comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Gets a specified commit comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -8150,7 +8150,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates the contents of a specified commit comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Updates the contents of a specified commit comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -8594,7 +8594,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8603,7 +8603,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8612,7 +8612,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments for a specified commit.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists the comments for a specified commit.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -8998,7 +8998,7 @@ "description": "

Closing down notice. Use position parameter instead. Line number in the file to comment on.

" } ], - "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -9373,7 +9373,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9382,7 +9382,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10397,7 +10397,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10406,7 +10406,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/copilot.json b/src/rest/data/ghec-2022-11-28/copilot.json index 9578c6bbabe1..6c13b55e3702 100644 --- a/src/rest/data/ghec-2022-11-28/copilot.json +++ b/src/rest/data/ghec-2022-11-28/copilot.json @@ -279,7 +279,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -288,7 +288,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1618,7 +1618,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about an enterprise's Copilot content exclusion path rules.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Enterprise owners can view details about Copilot content exclusion rules for the enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the read:enterprise or copilot scopes to use this endpoint.

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.
  • \n
  • At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.
  • \n
\n
", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about an enterprise's Copilot content exclusion path rules.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Enterprise owners can view details about Copilot content exclusion rules for the enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the read:enterprise or copilot scopes to use this endpoint.

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.
  • \n
  • At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.
  • \n
\n
", "codeExamples": [ { "request": { @@ -1709,7 +1709,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets Copilot content exclusion path rules for an enterprise.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Enterprise owners can set Copilot content exclusion rules for the enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the admin:enterprise or copilot scopes to use this endpoint.

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.
  • \n
  • At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.
  • \n
\n
", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets Copilot content exclusion path rules for an enterprise.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Enterprise owners can set Copilot content exclusion rules for the enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the admin:enterprise or copilot scopes to use this endpoint.

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.
  • \n
  • At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.
  • \n
\n
", "codeExamples": [ { "request": { @@ -1808,7 +1808,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Organization owners can view details about Copilot content exclusion rules for the organization.

\n

OAuth app tokens and personal access tokens (classic) need either the copilot or read:org scopes to use this endpoint.

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.
  • \n
  • At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.
  • \n
\n
", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Organization owners can view details about Copilot content exclusion rules for the organization.

\n

OAuth app tokens and personal access tokens (classic) need either the copilot or read:org scopes to use this endpoint.

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.
  • \n
  • At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.
  • \n
\n
", "codeExamples": [ { "request": { @@ -1895,7 +1895,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Organization owners can set Copilot content exclusion rules for the organization.

\n

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

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.
  • \n
  • At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.
  • \n
\n
", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Organization owners can set Copilot content exclusion rules for the organization.

\n

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

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.
  • \n
  • At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.
  • \n
\n
", "codeExamples": [ { "request": { @@ -1992,7 +1992,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2001,7 +2001,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2542,7 +2542,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2551,7 +2551,7 @@ }, { "name": "per_page", - "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3125,7 +3125,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3134,7 +3134,7 @@ }, { "name": "per_page", - "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3143,7 +3143,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"About enterprise accounts for Copilot Business.\"

\n
\n

Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.

\n

Note

\n

\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.

\n
\n

To access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"About enterprise accounts for Copilot Business.\"

\n
\n

Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.

\n

Note

\n

\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.

\n
\n

To access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -3700,7 +3700,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3709,7 +3709,7 @@ }, { "name": "per_page", - "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4290,7 +4290,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4299,7 +4299,7 @@ }, { "name": "per_page", - "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5301,7 +5301,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.

\n

The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

\n

The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", + "descriptionHTML": "

Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.

\n

The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

\n

The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", "codeExamples": [ { "request": { @@ -5402,7 +5402,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.

\n

The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

\n

The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", + "descriptionHTML": "

Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.

\n

The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

\n

The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", "codeExamples": [ { "request": { @@ -5519,7 +5519,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

\n

The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

\n

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", + "descriptionHTML": "

Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

\n

The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

\n

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", "codeExamples": [ { "request": { @@ -5620,7 +5620,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

\n

The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

\n

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", + "descriptionHTML": "

Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

\n

The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

\n

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", "codeExamples": [ { "request": { @@ -5726,7 +5726,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5735,7 +5735,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5744,7 +5744,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.

\n

Users with access through multiple organizations or enterprise teams will only be counted toward total_seats once.

\n

For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the seats array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at. For more information about activity data,\nsee Metrics data properties for GitHub Copilot.

\n

Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.

\n

Personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.

\n

Users with access through multiple organizations or enterprise teams will only be counted toward total_seats once.

\n

For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the seats array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at. For more information about activity data,\nsee Metrics data properties for GitHub Copilot.

\n

Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.

\n

Personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -7567,7 +7567,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"Managing policies for Copilot in your organization.\"

\n

Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"Managing policies for Copilot in your organization.\"

\n

Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -7758,7 +7758,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7767,7 +7767,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7776,7 +7776,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.

\n

Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see Metrics data properties for GitHub Copilot.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.

\n

Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see Metrics data properties for GitHub Copilot.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -8476,7 +8476,7 @@ "isRequired": true } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response contains the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response contains the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -8583,7 +8583,7 @@ "isRequired": true } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response contains the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response contains the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -8690,7 +8690,7 @@ "isRequired": true } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response contains the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response contains the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -8797,7 +8797,7 @@ "isRequired": true } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response contains the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response contains the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -8906,7 +8906,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.

\n

The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see Metrics data properties for GitHub Copilot.

\n

Only organization owners can view Copilot seat assignment details for members of their organization.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.

\n

The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see Metrics data properties for GitHub Copilot.

\n

Only organization owners can view Copilot seat assignment details for members of their organization.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/dependabot.json b/src/rest/data/ghec-2022-11-28/dependabot.json index a294bd511bd2..7c21f50edad3 100644 --- a/src/rest/data/ghec-2022-11-28/dependabot.json +++ b/src/rest/data/ghec-2022-11-28/dependabot.json @@ -80,7 +80,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -89,7 +89,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -504,7 +504,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -513,7 +513,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1842,7 +1842,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1851,7 +1851,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1860,7 +1860,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1869,7 +1869,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists Dependabot alerts for repositories that are owned by the specified enterprise.

\n

The authenticated user must be a member of the enterprise to use this endpoint.

\n

Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"Managing security managers in your organization.\"

\n

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

", + "descriptionHTML": "

Lists Dependabot alerts for repositories that are owned by the specified enterprise.

\n

The authenticated user must be a member of the enterprise to use this endpoint.

\n

Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"Managing security managers in your organization.\"

\n

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

", "codeExamples": [ { "request": { @@ -3744,7 +3744,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3753,7 +3753,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3762,7 +3762,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5646,7 +5646,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -5655,7 +5655,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -5664,7 +5664,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8084,7 +8084,7 @@ "description": "

Usernames to assign to this Dependabot Alert.\nPass one or more user logins to replace the set of assignees on this alert.\nSend an empty array ([]) to clear all assignees from the alert.

" } ], - "descriptionHTML": "

The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"Granting access to security alerts.\"

\n

OAuth app tokens and personal access tokens (classic) need the 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.

", + "descriptionHTML": "

The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"Granting access to security alerts.\"

\n

OAuth app tokens and personal access tokens (classic) need the 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.

", "codeExamples": [ { "request": { @@ -9893,7 +9893,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9902,7 +9902,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10240,7 +10240,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" }, { "type": "string", @@ -10261,10 +10261,10 @@ { "type": "array", "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

", + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

", "codeExamples": [ { "request": { @@ -10437,7 +10437,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10446,7 +10446,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11332,11 +11332,11 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", "isRequired": true } ], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", "codeExamples": [ { "request": { @@ -11414,7 +11414,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.

\n

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

", + "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.

\n

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

", "codeExamples": [ { "request": { @@ -11492,7 +11492,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", + "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", "codeExamples": [ { "request": { @@ -11561,7 +11561,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11570,7 +11570,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11899,7 +11899,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" }, { "type": "string", @@ -11907,7 +11907,7 @@ "description": "

ID of the key you used to encrypt the secret.

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

", + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/deploy-keys.json b/src/rest/data/ghec-2022-11-28/deploy-keys.json index 9c4f1b6ce244..3a69259a954a 100644 --- a/src/rest/data/ghec-2022-11-28/deploy-keys.json +++ b/src/rest/data/ghec-2022-11-28/deploy-keys.json @@ -28,7 +28,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -37,7 +37,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -194,7 +194,7 @@ { "type": "boolean", "name": "read_only", - "description": "

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

\n

Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

" + "description": "

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

\n

Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

" } ], "descriptionHTML": "

You can create a read-only deploy key.

", diff --git a/src/rest/data/ghec-2022-11-28/deployments.json b/src/rest/data/ghec-2022-11-28/deployments.json index bef9ebbc2131..d1af0ffefc38 100644 --- a/src/rest/data/ghec-2022-11-28/deployments.json +++ b/src/rest/data/ghec-2022-11-28/deployments.json @@ -71,7 +71,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -80,7 +80,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -719,7 +719,7 @@ { "type": "array of strings", "name": "required_contexts", - "description": "

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

" + "description": "

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

" }, { "type": "object or string", @@ -750,7 +750,7 @@ "description": "

Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

" } ], - "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Merged branch response:

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n
    \n
  • Auto-merge option is enabled in the repository
  • \n
  • Topic branch does not include the latest changes on the base branch, which is master in the response example
  • \n
  • There are no merge conflicts
  • \n
\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response:

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks:

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

\n

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

", + "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Merged branch response:

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n
    \n
  • Auto-merge option is enabled in the repository
  • \n
  • Topic branch does not include the latest changes on the base branch, which is master in the response example
  • \n
  • There are no merge conflicts
  • \n
\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response:

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks:

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

\n

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

", "codeExamples": [ { "request": { @@ -1998,7 +1998,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.

\n

To set a deployment as inactive, you must:

\n
    \n
  • Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
  • \n
  • Mark the active deployment as inactive by adding any non-successful deployment status.
  • \n
\n

For more information, see \"Create a deployment\" and \"Create a deployment status.\"

\n

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

", + "descriptionHTML": "

If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.

\n

To set a deployment as inactive, you must:

\n
    \n
  • Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
  • \n
  • Mark the active deployment as inactive by adding any non-successful deployment status.
  • \n
\n

For more information, see \"Create a deployment\" and \"Create a deployment status.\"

\n

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

", "codeExamples": [ { "request": { @@ -2081,7 +2081,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2090,7 +2090,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2787,7 +2787,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2796,7 +2796,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4835,7 +4835,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

\n

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

", + "descriptionHTML": "

Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -5009,7 +5009,7 @@ "description": "

The ID of the custom app that will be enabled on the environment.

" } ], - "descriptionHTML": "

Enable a custom deployment protection rule for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.

\n

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

", + "descriptionHTML": "

Enable a custom deployment protection rule for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.

\n

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

", "codeExamples": [ { "request": { @@ -5152,7 +5152,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5161,7 +5161,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5170,7 +5170,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets all custom deployment protection rule integrations that are available for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see \"GET an app\".

\n

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

", + "descriptionHTML": "

Gets all custom deployment protection rule integrations that are available for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see \"GET an app\".

\n

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

", "codeExamples": [ { "request": { @@ -5315,7 +5315,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.

\n

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

", + "descriptionHTML": "

Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.

\n

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

", "codeExamples": [ { "request": { @@ -5541,7 +5541,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5550,7 +5550,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/enterprise-admin.json b/src/rest/data/ghec-2022-11-28/enterprise-admin.json index 0fb465ee444f..1ba1eec431cd 100644 --- a/src/rest/data/ghec-2022-11-28/enterprise-admin.json +++ b/src/rest/data/ghec-2022-11-28/enterprise-admin.json @@ -19,7 +19,7 @@ }, { "name": "date_start", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", "in": "query", "required": false, "schema": { @@ -28,7 +28,7 @@ }, { "name": "date_end", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", "in": "query", "required": false, "schema": { @@ -484,7 +484,7 @@ }, { "name": "phrase", - "description": "

A search phrase. For more information, see Searching the audit log.

", + "description": "

A search phrase. For more information, see Searching the audit log.

", "in": "query", "required": false, "schema": { @@ -507,7 +507,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", "in": "query", "required": false, "schema": { @@ -516,7 +516,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", "in": "query", "required": false, "schema": { @@ -538,7 +538,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -547,7 +547,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -556,7 +556,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the audit log for an enterprise.

\n

This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"Rate limits for the REST API\" and \"Best practices for integrators.\"

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

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

", + "descriptionHTML": "

Gets the audit log for an enterprise.

\n

This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"Rate limits for the REST API\" and \"Best practices for integrators.\"

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -2068,7 +2068,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2077,7 +2077,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2437,7 +2437,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to fetch code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Gets code security and analysis settings for the specified enterprise.

\n

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

\n

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

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to fetch code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Gets code security and analysis settings for the specified enterprise.

\n

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -2550,32 +2550,32 @@ { "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", - "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"About GitHub Advanced Security.\"

" + "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"About GitHub Advanced Security.\"

" }, { "type": "boolean", "name": "advanced_security_enabled_new_user_namespace_repos", - "description": "

Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"About GitHub Advanced Security.\"

" + "description": "

Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"About GitHub Advanced Security.\"

" }, { "type": "boolean", "name": "dependabot_alerts_enabled_for_new_repositories", - "description": "

Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"About Dependabot alerts.\"

" + "description": "

Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"About Dependabot alerts.\"

" }, { "type": "boolean", "name": "secret_scanning_enabled_for_new_repositories", - "description": "

Whether secret scanning is automatically enabled for new repositories. For more information, see \"About secret scanning.\"

" + "description": "

Whether secret scanning is automatically enabled for new repositories. For more information, see \"About secret scanning.\"

" }, { "type": "boolean", "name": "secret_scanning_push_protection_enabled_for_new_repositories", - "description": "

Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"Protecting pushes with secret scanning.\"

" + "description": "

Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"Protecting pushes with secret scanning.\"

" }, { "type": "string or null", "name": "secret_scanning_push_protection_custom_link", - "description": "

The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"Protecting pushes with secret scanning.\"\nTo disable this functionality, set this field to null.

" + "description": "

The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"Protecting pushes with secret scanning.\"\nTo disable this functionality, set this field to null.

" }, { "type": "boolean or null", @@ -2583,7 +2583,7 @@ "description": "

Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise.

" } ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to update code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.

\n

The authenticated user must be an administrator of the enterprise to use this endpoint.

\n

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

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to update code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.

\n

The authenticated user must be an administrator of the enterprise to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -2680,7 +2680,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all repositories in an enterprise.

\n

The authenticated user must be an administrator of the enterprise to use this endpoint.

\n

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

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all repositories in an enterprise.

\n

The authenticated user must be an administrator of the enterprise to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -4917,7 +4917,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4926,7 +4926,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6196,7 +6196,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6205,7 +6205,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6374,7 +6374,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6383,7 +6383,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6917,7 +6917,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6926,7 +6926,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7294,7 +7294,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7303,7 +7303,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7467,7 +7467,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7476,7 +7476,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8234,7 +8234,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8243,7 +8243,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8350,7 +8350,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8359,7 +8359,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8475,7 +8475,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8484,7 +8484,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10194,7 +10194,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10203,7 +10203,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -12985,7 +12985,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -12997,7 +12997,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -14377,7 +14377,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -14387,7 +14387,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -15809,7 +15809,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -15819,7 +15819,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -17330,7 +17330,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -17342,7 +17342,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -18723,7 +18723,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -18733,7 +18733,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -18924,7 +18924,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18933,7 +18933,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/enterprise-teams.json b/src/rest/data/ghec-2022-11-28/enterprise-teams.json index c63119e73259..74552928deaa 100644 --- a/src/rest/data/ghec-2022-11-28/enterprise-teams.json +++ b/src/rest/data/ghec-2022-11-28/enterprise-teams.json @@ -19,7 +19,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -207,7 +207,7 @@ { "type": "string", "name": "organization_selection_type", - "description": "

Specifies which organizations in the enterprise should have access to this team. Can be one of disabled, selected, or all.\ndisabled: The team is not assigned to any organizations. This is the default when you create a new team.\nselected: The team is assigned to specific organizations. You can then use the add organization assignments API endpoint.\nall: The team is assigned to all current and future organizations in the enterprise.

", + "description": "

Specifies which organizations in the enterprise should have access to this team. Can be one of disabled, selected, or all.\ndisabled: The team is not assigned to any organizations. This is the default when you create a new team.\nselected: The team is assigned to specific organizations. You can then use the add organization assignments API endpoint.\nall: The team is assigned to all current and future organizations in the enterprise.

", "enum": [ "disabled", "selected", @@ -218,7 +218,7 @@ { "type": "string or null", "name": "group_id", - "description": "

The ID of the IdP group to assign team membership with. You can get this value from the REST API endpoints for SCIM.

" + "description": "

The ID of the IdP group to assign team membership with. You can get this value from the REST API endpoints for SCIM.

" } ], "descriptionHTML": "

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

", @@ -547,7 +547,7 @@ { "type": "string", "name": "organization_selection_type", - "description": "

Specifies which organizations in the enterprise should have access to this team. Can be one of disabled, selected, or all.\ndisabled: The team is not assigned to any organizations. This is the default when you create a new team.\nselected: The team is assigned to specific organizations. You can then use the add organization assignments API.\nall: The team is assigned to all current and future organizations in the enterprise.

", + "description": "

Specifies which organizations in the enterprise should have access to this team. Can be one of disabled, selected, or all.\ndisabled: The team is not assigned to any organizations. This is the default when you create a new team.\nselected: The team is assigned to specific organizations. You can then use the add organization assignments API.\nall: The team is assigned to all current and future organizations in the enterprise.

", "enum": [ "disabled", "selected", @@ -788,7 +788,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -797,7 +797,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1929,7 +1929,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1938,7 +1938,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/gists.json b/src/rest/data/ghec-2022-11-28/gists.json index 3c8ae0626b74..3b3b473baf42 100644 --- a/src/rest/data/ghec-2022-11-28/gists.json +++ b/src/rest/data/ghec-2022-11-28/gists.json @@ -20,7 +20,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -29,7 +29,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1655,7 +1655,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1664,7 +1664,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1673,7 +1673,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List public gists sorted by most recently updated to least recently updated.

\n

Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

", + "descriptionHTML": "

List public gists sorted by most recently updated to least recently updated.

\n

Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

", "codeExamples": [ { "request": { @@ -2136,7 +2136,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2145,7 +2145,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2616,7 +2616,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Gets a specified gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { @@ -3768,7 +3768,7 @@ ] } ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { @@ -7109,7 +7109,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7118,7 +7118,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7382,7 +7382,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7391,7 +7391,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9018,7 +9018,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "codeExamples": [ { "request": { @@ -9157,7 +9157,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Gets a specified gist revision.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { @@ -10290,7 +10290,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10299,7 +10299,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10767,7 +10767,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10776,7 +10776,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10785,7 +10785,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Lists the comments on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { @@ -11062,7 +11062,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Creates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { @@ -11344,7 +11344,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Gets a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { @@ -11627,7 +11627,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Updates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/git.json b/src/rest/data/ghec-2022-11-28/git.json index bd7d9e17f801..bc329d54af99 100644 --- a/src/rest/data/ghec-2022-11-28/git.json +++ b/src/rest/data/ghec-2022-11-28/git.json @@ -156,7 +156,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw blob data.
  • \n
  • application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.
  • \n
\n

Note This endpoint supports blobs up to 100 megabytes in size.

", + "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw blob data.
  • \n
  • application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.
  • \n
\n

Note This endpoint supports blobs up to 100 megabytes in size.

", "codeExamples": [ { "request": { @@ -939,7 +939,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note

\n

\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n
\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

", + "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note

\n

\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n
\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

", "codeExamples": [ { "request": { @@ -1089,7 +1089,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note

\n

\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n
", + "descriptionHTML": "

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note

\n

\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n
", "codeExamples": [ { "request": { @@ -1666,7 +1666,7 @@ ] } ], - "descriptionHTML": "

Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "codeExamples": [ { "request": { @@ -2156,7 +2156,7 @@ "description": "

The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

" } ], - "descriptionHTML": "

The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

\n

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"

\n

Returns an error if you try to delete a file that does not exist.

", + "descriptionHTML": "

The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

\n

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"

\n

Returns an error if you try to delete a file that does not exist.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/gitignore.json b/src/rest/data/ghec-2022-11-28/gitignore.json index 22f18c22914d..4c44a07d8577 100644 --- a/src/rest/data/ghec-2022-11-28/gitignore.json +++ b/src/rest/data/ghec-2022-11-28/gitignore.json @@ -9,7 +9,7 @@ "subcategory": "gitignore", "parameters": [], "bodyParameters": [], - "descriptionHTML": "

List all templates available to pass as an option when creating a repository.

", + "descriptionHTML": "

List all templates available to pass as an option when creating a repository.

", "codeExamples": [ { "request": { @@ -77,7 +77,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
  • \n
", + "descriptionHTML": "

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
  • \n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/issues.json b/src/rest/data/ghec-2022-11-28/issues.json index c7ad419bc969..ea608154f724 100644 --- a/src/rest/data/ghec-2022-11-28/issues.json +++ b/src/rest/data/ghec-2022-11-28/issues.json @@ -127,7 +127,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -136,7 +136,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -145,7 +145,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -3375,7 +3375,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3384,7 +3384,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3393,7 +3393,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -6645,7 +6645,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6654,7 +6654,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6663,7 +6663,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -9756,7 +9756,7 @@ "description": "

The name of the issue type to associate with this issue. NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise.

" } ], - "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -12839,7 +12839,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -19027,7 +19027,7 @@ "description": "

The name of the issue type to associate with this issue or use null to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.

" } ], - "descriptionHTML": "

Issue owners and users with push access or Triage role can edit an issue.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Issue owners and users with push access or Triage role can edit an issue.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -22127,7 +22127,7 @@ ] } ], - "descriptionHTML": "

Users with push access can lock an issue or pull request's conversation.

\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.\"

", + "descriptionHTML": "

Users with push access can lock an issue or pull request's conversation.

\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.\"

", "codeExamples": [ { "request": { @@ -22361,7 +22361,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -22370,7 +22370,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -22379,7 +22379,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -25526,7 +25526,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25535,7 +25535,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25544,7 +25544,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the available assignees for issues in a repository.

", + "descriptionHTML": "

Lists the available assignees for issues in a repository.

", "codeExamples": [ { "request": { @@ -32091,7 +32091,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -32100,7 +32100,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -32109,7 +32109,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.

\n

By default, issue comments are ordered by ascending ID.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.

\n

By default, issue comments are ordered by ascending ID.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -32898,7 +32898,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -33687,7 +33687,7 @@ "isRequired": true } ], - "descriptionHTML": "

You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -34549,7 +34549,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to pin comments on issues.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to pin comments on issues.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -35468,7 +35468,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35477,7 +35477,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35486,7 +35486,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

Issue comments are ordered by ascending ID.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

Issue comments are ordered by ascending ID.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -36282,7 +36282,7 @@ "isRequired": true } ], - "descriptionHTML": "

You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -37071,7 +37071,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -37080,7 +37080,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -45811,7 +45811,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -45820,7 +45820,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -54150,7 +54150,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -54159,7 +54159,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -54168,7 +54168,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to list the dependencies an issue is blocked by.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to list the dependencies an issue is blocked by.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -57241,7 +57241,7 @@ "isRequired": true } ], - "descriptionHTML": "

You can use the REST API to add a 'blocked by' relationship to an issue.

\n

Creating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see Rate limits for the API\nand Best practices for using the REST API.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to add a 'blocked by' relationship to an issue.

\n

Creating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see Rate limits for the API\nand Best practices for using the REST API.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -60323,7 +60323,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to remove a dependency that an issue is blocked by.

\n

Removing content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see Rate limits for the API\nand Best practices for using the REST API.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass a specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to remove a dependency that an issue is blocked by.

\n

Removing content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see Rate limits for the API\nand Best practices for using the REST API.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass a specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -63397,7 +63397,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -63406,7 +63406,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -63415,7 +63415,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to list the dependencies an issue is blocking.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to list the dependencies an issue is blocking.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -66483,7 +66483,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -66492,7 +66492,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -66711,7 +66711,7 @@ ] } ], - "descriptionHTML": "

Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.

\n

This endpoint supports the following field data types:

\n
    \n
  • text: String values for text fields
  • \n
  • single_select: Option names for single-select fields (must match an existing option name)
  • \n
  • number: Numeric values for number fields
  • \n
  • date: ISO 8601 date strings for date fields
  • \n
\n

Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.

\n

This endpoint supports the following field data types:

\n
    \n
  • text: String values for text fields
  • \n
  • single_select: Option names for single-select fields (must match an existing option name)
  • \n
  • number: Numeric values for number fields
  • \n
  • date: ISO 8601 date strings for date fields
  • \n
\n

Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", "codeExamples": [ { "request": { @@ -66948,7 +66948,7 @@ ] } ], - "descriptionHTML": "

Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.

\n

This endpoint supports the following field data types:

\n
    \n
  • text: String values for text fields
  • \n
  • single_select: Option names for single-select fields (must match an existing option name)
  • \n
  • number: Numeric values for number fields
  • \n
  • date: ISO 8601 date strings for date fields
  • \n
\n

This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.

\n

Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.

\n

This endpoint supports the following field data types:

\n
    \n
  • text: String values for text fields
  • \n
  • single_select: Option names for single-select fields (must match an existing option name)
  • \n
  • number: Numeric values for number fields
  • \n
  • date: ISO 8601 date strings for date fields
  • \n
\n

This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.

\n

Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", "codeExamples": [ { "request": { @@ -67174,7 +67174,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Remove a specific custom field value from an issue.

\n

Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

\n

If the specified field does not have a value set on the issue, this operation will return a 404 error.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Remove a specific custom field value from an issue.

\n

Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

\n

If the specified field does not have a value set on the issue, this operation will return a 404 error.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", "codeExamples": [ { "request": { @@ -67268,7 +67268,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -67277,7 +67277,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -67450,7 +67450,7 @@ { "type": "array of strings", "name": "labels", - "description": "

The names of the labels to add to the issue's existing labels. You can also pass an array of labels directly, but GitHub recommends passing an object with the labels key. To replace all of the labels for an issue, use \"Set labels for an issue.\"

" + "description": "

The names of the labels to add to the issue's existing labels. You can also pass an array of labels directly, but GitHub recommends passing an object with the labels key. To replace all of the labels for an issue, use \"Set labels for an issue.\"

" } ], "descriptionHTML": "

Adds labels to an issue.

", @@ -67627,7 +67627,7 @@ { "type": "array of strings", "name": "labels", - "description": "

The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

" + "description": "

The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

" } ], "descriptionHTML": "

Removes any previous labels and sets the new labels for an issue.

", @@ -68041,7 +68041,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -68050,7 +68050,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -68737,7 +68737,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -68746,7 +68746,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -68940,7 +68940,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -68949,7 +68949,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -70423,7 +70423,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to get the parent issue of a sub-issue.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to get the parent issue of a sub-issue.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -73491,7 +73491,7 @@ "isRequired": true } ], - "descriptionHTML": "

You can use the REST API to remove a sub-issue from an issue.\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass a specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to remove a sub-issue from an issue.\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass a specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -76551,7 +76551,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -76560,7 +76560,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -76569,7 +76569,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to list the sub-issues on an issue.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to list the sub-issues on an issue.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -79643,7 +79643,7 @@ "description": "

Option that, when true, instructs the operation to replace the sub-issues current parent issue

" } ], - "descriptionHTML": "

You can use the REST API to add sub-issues to issues.

\n

Creating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to add sub-issues to issues.

\n

Creating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -85799,7 +85799,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -85808,7 +85808,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/licenses.json b/src/rest/data/ghec-2022-11-28/licenses.json index 82943c2f3916..2aa7f8366b41 100644 --- a/src/rest/data/ghec-2022-11-28/licenses.json +++ b/src/rest/data/ghec-2022-11-28/licenses.json @@ -19,7 +19,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -37,7 +37,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the most commonly used licenses on GitHub. For more information, see \"Licensing a repository .\"

", + "descriptionHTML": "

Lists the most commonly used licenses on GitHub. For more information, see \"Licensing a repository .\"

", "codeExamples": [ { "request": { @@ -184,7 +184,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets information about a specific license. For more information, see \"Licensing a repository .\"

", + "descriptionHTML": "

Gets information about a specific license. For more information, see \"Licensing a repository .\"

", "codeExamples": [ { "request": { @@ -370,7 +370,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

This method returns the contents of the repository's license file, if one is detected.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw contents of the license.
  • \n
  • application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
", + "descriptionHTML": "

This method returns the contents of the repository's license file, if one is detected.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw contents of the license.
  • \n
  • application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/meta.json b/src/rest/data/ghec-2022-11-28/meta.json index 8343ecf8830d..8fd0de00dff7 100644 --- a/src/rest/data/ghec-2022-11-28/meta.json +++ b/src/rest/data/ghec-2022-11-28/meta.json @@ -254,7 +254,7 @@ "subcategory": "meta", "parameters": [], "bodyParameters": [], - "descriptionHTML": "

Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"

\n

The API's response also includes a list of GitHub's domain names.

\n

The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.

\n

Note

\n

\nThis endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.

\n
", + "descriptionHTML": "

Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"

\n

The API's response also includes a list of GitHub's domain names.

\n

The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.

\n

Note

\n

\nThis endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.

\n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/metrics.json b/src/rest/data/ghec-2022-11-28/metrics.json index e13000d72de1..225305dcedf2 100644 --- a/src/rest/data/ghec-2022-11-28/metrics.json +++ b/src/rest/data/ghec-2022-11-28/metrics.json @@ -28,7 +28,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns all community profile metrics for a repository. The repository cannot be a fork.

\n

The returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.

\n

The health_percentage score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"About community profiles for public repositories.\"

\n

content_reports_enabled is only returned for organization-owned repositories.

", + "descriptionHTML": "

Returns all community profile metrics for a repository. The repository cannot be a fork.

\n

The returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.

\n

The health_percentage score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"About community profiles for public repositories.\"

\n

content_reports_enabled is only returned for organization-owned repositories.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/migrations.json b/src/rest/data/ghec-2022-11-28/migrations.json index 21326647b5db..e640d4acd37b 100644 --- a/src/rest/data/ghec-2022-11-28/migrations.json +++ b/src/rest/data/ghec-2022-11-28/migrations.json @@ -19,7 +19,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3575,7 +3575,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

", + "descriptionHTML": "

Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

", "codeExamples": [ { "request": { @@ -3639,7 +3639,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3648,7 +3648,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4570,7 +4570,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

View the progress of an import.

\n

Warning

\n

\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.

\n
\n

Import status

\n

This section includes details about the possible values of the status field of the Import Progress response.

\n

An import that does not have errors will progress through these steps:

\n
    \n
  • detecting - the \"detection\" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.
  • \n
  • importing - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).
  • \n
  • mapping - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
  • \n
  • pushing - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include push_percent, which is the percent value reported by git push when it is \"Writing objects\".
  • \n
  • complete - the import is complete, and the repository is ready on GitHub Enterprise Cloud.
  • \n
\n

If there are problems, you will see one of these in the status field:

\n
    \n
  • auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.
  • \n
  • error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Enterprise Cloud Support for more information.
  • \n
  • detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.
  • \n
  • detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.
  • \n
  • detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.
  • \n
\n

The project_choices field

\n

When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

\n

Git LFS related fields

\n

This section includes details about Git LFS related fields that may be present in the Import Progress response.

\n
    \n
  • use_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.
  • \n
  • has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.
  • \n
  • large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.
  • \n
  • large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.
  • \n
", + "descriptionHTML": "

View the progress of an import.

\n

Warning

\n

\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.

\n
\n

Import status

\n

This section includes details about the possible values of the status field of the Import Progress response.

\n

An import that does not have errors will progress through these steps:

\n
    \n
  • detecting - the \"detection\" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.
  • \n
  • importing - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).
  • \n
  • mapping - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
  • \n
  • pushing - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include push_percent, which is the percent value reported by git push when it is \"Writing objects\".
  • \n
  • complete - the import is complete, and the repository is ready on GitHub Enterprise Cloud.
  • \n
\n

If there are problems, you will see one of these in the status field:

\n
    \n
  • auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.
  • \n
  • error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Enterprise Cloud Support for more information.
  • \n
  • detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.
  • \n
  • detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.
  • \n
  • detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.
  • \n
\n

The project_choices field

\n

When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

\n

Git LFS related fields

\n

This section includes details about Git LFS related fields that may be present in the Import Progress response.

\n
    \n
  • use_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.
  • \n
  • has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.
  • \n
  • large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.
  • \n
  • large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.
  • \n
", "codeExamples": [ { "request": { @@ -5775,7 +5775,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

\n

This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.

\n

Warning

\n

\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.

\n
", + "descriptionHTML": "

Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

\n

This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.

\n

Warning

\n

\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.

\n
", "codeExamples": [ { "request": { @@ -6195,7 +6195,7 @@ ] } ], - "descriptionHTML": "

You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.

\n

You can learn more about our LFS feature and working with large files on our help\nsite.

\n

Warning

\n

\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.

\n
", + "descriptionHTML": "

You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.

\n

You can learn more about our LFS feature and working with large files on our help\nsite.

\n

Warning

\n

\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.

\n
", "codeExamples": [ { "request": { @@ -6416,7 +6416,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6425,7 +6425,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8698,7 +8698,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Fetches a single user migration. The response includes the state of the migration, which can be one of the following values:

\n
    \n
  • pending - the migration hasn't started yet.
  • \n
  • exporting - the migration is in progress.
  • \n
  • exported - the migration finished successfully.
  • \n
  • failed - the migration failed.
  • \n
\n

Once the migration has been exported you can download the migration archive.

", + "descriptionHTML": "

Fetches a single user migration. The response includes the state of the migration, which can be one of the following values:

\n
    \n
  • pending - the migration hasn't started yet.
  • \n
  • exporting - the migration is in progress.
  • \n
  • exported - the migration finished successfully.
  • \n
  • failed - the migration failed.
  • \n
\n

Once the migration has been exported you can download the migration archive.

", "codeExamples": [ { "request": { @@ -9852,7 +9852,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the List user migrations and Get a user migration status endpoints, will continue to be available even after an archive is deleted.

", + "descriptionHTML": "

Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the List user migrations and Get a user migration status endpoints, will continue to be available even after an archive is deleted.

", "codeExamples": [ { "request": { @@ -9926,7 +9926,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -9992,7 +9992,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10001,7 +10001,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/orgs.json b/src/rest/data/ghec-2022-11-28/orgs.json index 09cf3d3bf18e..6163d9659373 100644 --- a/src/rest/data/ghec-2022-11-28/orgs.json +++ b/src/rest/data/ghec-2022-11-28/orgs.json @@ -19,7 +19,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all organizations, in the order that they were created.

\n

Note

\n

\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.

\n
", + "descriptionHTML": "

Lists all organizations, in the order that they were created.

\n

Note

\n

\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.

\n
", "codeExamples": [ { "request": { @@ -163,7 +163,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the Organization plan permission.

", + "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the Organization plan permission.

", "codeExamples": [ { "request": { @@ -489,32 +489,32 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { @@ -530,7 +530,7 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true }, "created_at": { @@ -687,17 +687,17 @@ { "type": "boolean", "name": "members_can_create_internal_repositories", - "description": "

Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" + "description": "

Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" }, { "type": "boolean", "name": "members_can_create_private_repositories", - "description": "

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" + "description": "

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" }, { "type": "boolean", "name": "members_can_create_public_repositories", - "description": "

Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" + "description": "

Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" }, { "type": "string", @@ -747,32 +747,32 @@ { "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_alerts_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_security_updates_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependency_graph_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_push_protection_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", @@ -787,7 +787,7 @@ { "type": "boolean", "name": "secret_scanning_validity_checks_enabled", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.

" }, { "type": "boolean", @@ -795,7 +795,7 @@ "description": "

Controls whether or not deploy keys may be added and used for repositories in the organization.

" } ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Cloud will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n
\n

Warning

\n

\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down. Please use code security configurations to set defaults instead. For more information on setting a default security configuration, see the changelog.

\n
\n

Updates the organization's profile and member privileges.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Cloud will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n
\n

Warning

\n

\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down. Please use code security configurations to set defaults instead. For more information on setting a default security configuration, see the changelog.

\n
\n

Updates the organization's profile and member privileges.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -1134,32 +1134,32 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_custom_link_enabled": { @@ -1175,7 +1175,7 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true }, "created_at": { @@ -1272,7 +1272,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes an organization and all its repositories.

\n

The organization login will be unavailable for 90 days after deletion.

\n

Please review the Terms of Service regarding account deletion before using this endpoint:

\n

https://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service

", + "descriptionHTML": "

Deletes an organization and all its repositories.

\n

The organization login will be unavailable for 90 days after deletion.

\n

Please review the Terms of Service regarding account deletion before using this endpoint:

\n

https://docs.github.com/enterprise-cloud@latest/site-policy/github-terms/github-terms-of-service

", "codeExamples": [ { "request": { @@ -1338,7 +1338,7 @@ }, { "name": "phrase", - "description": "

A search phrase. For more information, see Searching the audit log.

", + "description": "

A search phrase. For more information, see Searching the audit log.

", "in": "query", "required": false, "schema": { @@ -1361,7 +1361,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", "in": "query", "required": false, "schema": { @@ -1370,7 +1370,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", "in": "query", "required": false, "schema": { @@ -1392,7 +1392,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1401,7 +1401,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"

\n

By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"

\n

Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"

\n

This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"Rate limits for the REST API\" and \"Best practices for integrators.\"

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", + "descriptionHTML": "

Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"

\n

By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"

\n

Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"

\n

This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"Rate limits for the REST API\" and \"Best practices for integrators.\"

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -1653,7 +1653,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1678,7 +1678,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see About authentication with SAML single sign-on.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", + "descriptionHTML": "

Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see About authentication with SAML single sign-on.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -1913,7 +1913,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1922,7 +1922,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3018,7 +3018,7 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the enforced_repositories is set to selected. You can add and remove individual repositories using the Enable a selected repository for immutable releases in an organization and Disable a selected repository for immutable releases in an organization endpoints.

" + "description": "

An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the enforced_repositories is set to selected. You can add and remove individual repositories using the Enable a selected repository for immutable releases in an organization and Disable a selected repository for immutable releases in an organization endpoints.

" } ], "descriptionHTML": "

Sets the immutable releases policy for repositories in an organization.

\n

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

", @@ -3078,7 +3078,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3087,7 +3087,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3963,7 +3963,7 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the enforced_repositories is set to selected. You can add and remove individual repositories using the Enable a selected repository for immutable releases in an organization and Disable a selected repository for immutable releases in an organization endpoints.

", + "description": "

An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the enforced_repositories is set to selected. You can add and remove individual repositories using the Enable a selected repository for immutable releases in an organization and Disable a selected repository for immutable releases in an organization endpoints.

", "isRequired": true } ], @@ -4196,7 +4196,7 @@ ] } ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

\n

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

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -4248,7 +4248,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4257,7 +4257,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4407,7 +4407,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4416,7 +4416,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4425,7 +4425,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List public organization memberships for the specified user.

\n

This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.

", + "descriptionHTML": "

List public organization memberships for the specified user.

\n

This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.

", "codeExamples": [ { "request": { @@ -4604,7 +4604,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4613,7 +4613,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4787,7 +4787,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4796,7 +4796,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5730,7 +5730,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5739,7 +5739,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6897,7 +6897,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6906,7 +6906,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -6915,7 +6915,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -6945,7 +6945,7 @@ "description": "

Optional filter for fetching attestations with a given predicate type.\nThis option accepts provenance, sbom, release, or freeform text\nfor custom predicate types.

" } ], - "descriptionHTML": "

List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", + "descriptionHTML": "

List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", "codeExamples": [ { "request": { @@ -7327,7 +7327,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7336,7 +7336,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7345,7 +7345,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7530,7 +7530,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7539,7 +7539,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7548,7 +7548,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7584,7 +7584,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", + "descriptionHTML": "

List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", "codeExamples": [ { "request": { @@ -7809,7 +7809,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7818,7 +7818,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8278,7 +8278,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8287,7 +8287,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9625,7 +9625,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9634,7 +9634,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9643,7 +9643,7 @@ }, { "name": "repository_query", - "description": "

Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.

", + "description": "

Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.

", "in": "query", "required": false, "schema": { @@ -10131,7 +10131,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -10392,7 +10392,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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 an 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.

", + "descriptionHTML": "

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 an 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.

", "codeExamples": [ { "request": { @@ -10730,7 +10730,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a custom repository role that can be used by all repositories owned by the organization. For more information on 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.

", + "descriptionHTML": "

Creates a custom repository role that can be used by all repositories owned by the organization. For more information on 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.

", "codeExamples": [ { "request": { @@ -11002,7 +11002,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an 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.

", + "descriptionHTML": "

Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an 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.

", "codeExamples": [ { "request": { @@ -11292,7 +11292,7 @@ "description": "

A list of additional permissions included in this role.

" } ], - "descriptionHTML": "

Updates a custom repository role that can be used by all repositories owned by the organization. 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.

", + "descriptionHTML": "

Updates a custom repository role that can be used by all repositories owned by the organization. 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.

", "codeExamples": [ { "request": { @@ -11566,7 +11566,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -11650,7 +11650,7 @@ "isRequired": true } ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Create a custom repository role\" endpoint instead.

\n
\n

Creates a custom repository role that can be used by all repositories owned by the organization. For more information on 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.

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Create a custom repository role\" endpoint instead.

\n
\n

Creates a custom repository role that can be used by all repositories owned by the organization. For more information on 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.

", "codeExamples": [ { "request": { @@ -11922,7 +11922,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Get a custom repository role\" endpoint instead.

\n
\n

Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an 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.

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Get a custom repository role\" endpoint instead.

\n
\n

Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an 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.

", "codeExamples": [ { "request": { @@ -12212,7 +12212,7 @@ "description": "

A list of additional permissions included in this role.

" } ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Update a custom repository role\" endpoint instead.

\n
\n

Updates a custom repository role that can be used by all repositories owned by the organization. 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.

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Update a custom repository role\" endpoint instead.

\n
\n

Updates a custom repository role that can be used by all repositories owned by the organization. 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.

", "codeExamples": [ { "request": { @@ -12486,7 +12486,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Delete a custom repository role\" endpoint instead.

\n
\n

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.

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Delete a custom repository role\" endpoint instead.

\n
\n

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.

", "codeExamples": [ { "request": { @@ -12540,7 +12540,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"List fine-grained repository permissions\" endpoint instead.

\n
\n

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.

\n

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

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"List fine-grained repository permissions\" endpoint instead.

\n
\n

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.

\n

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

", "codeExamples": [ { "request": { @@ -12631,7 +12631,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

The authenticated user must be an 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.

", + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

The authenticated user must be an 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.

", "codeExamples": [ { "request": { @@ -13024,7 +13024,7 @@ ] } ], - "descriptionHTML": "

Creates a new issue field for an organization.

\n

You can find out more about issue fields in Managing issue fields in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Creates a new issue field for an organization.

\n

You can find out more about issue fields in Managing issue fields in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -13345,7 +13345,7 @@ ] } ], - "descriptionHTML": "

Updates an issue field for an organization.

\n

You can find out more about issue fields in Managing issue fields in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Updates an issue field for an organization.

\n

You can find out more about issue fields in Managing issue fields in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -13589,7 +13589,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes an issue field for an organization.

\n

You can find out more about issue fields in Managing issue fields in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Deletes an issue field for an organization.

\n

You can find out more about issue fields in Managing issue fields in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -13833,7 +13833,7 @@ ] } ], - "descriptionHTML": "

Create a new issue type for an organization.

\n

You can find out more about issue types in Managing issue types in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Create a new issue type for an organization.

\n

You can find out more about issue types in Managing issue types in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -14020,7 +14020,7 @@ ] } ], - "descriptionHTML": "

Updates an issue type for an organization.

\n

You can find out more about issue types in Managing issue types in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Updates an issue type for an organization.

\n

You can find out more about issue types in Managing issue types in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -14174,7 +14174,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes an issue type for an organization.

\n

You can find out more about issue types in Managing issue types in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Deletes an issue type for an organization.

\n

You can find out more about issue types in Managing issue types in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -14238,7 +14238,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14247,7 +14247,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14256,7 +14256,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The return hash contains failed_at and failed_reason fields which\nrepresent the time at which the invitation failed and the reason for the failure.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

", + "descriptionHTML": "

The return hash contains failed_at and failed_reason fields which\nrepresent the time at which the invitation failed and the reason for the failure.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

", "codeExamples": [ { "request": { @@ -14527,7 +14527,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14536,7 +14536,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14577,7 +14577,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The return hash contains a role field which refers to the Organization\nInvitation role and will be one of the following values: direct_member, admin,\nbilling_manager, or hiring_manager. If the invitee is not a GitHub Enterprise Cloud\nmember, the login field in the return hash will be null.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

", + "descriptionHTML": "

The return hash contains a role field which refers to the Organization\nInvitation role and will be one of the following values: direct_member, admin,\nbilling_manager, or hiring_manager. If the invitee is not a GitHub Enterprise Cloud\nmember, the login field in the return hash will be null.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

", "codeExamples": [ { "request": { @@ -14876,7 +14876,7 @@ "description": "

Specify IDs for the teams you want to invite new members to.

" } ], - "descriptionHTML": "

Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

", + "descriptionHTML": "

Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

", "codeExamples": [ { "request": { @@ -15162,7 +15162,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

\n

This endpoint triggers notifications.

", + "descriptionHTML": "

Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

\n

This endpoint triggers notifications.

", "codeExamples": [ { "request": { @@ -15233,7 +15233,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15242,7 +15242,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15251,7 +15251,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List all teams associated with an invitation. In order to see invitations\nin an organization, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

", + "descriptionHTML": "

List all teams associated with an invitation. In order to see invitations\nin an organization, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

", "codeExamples": [ { "request": { @@ -15532,7 +15532,7 @@ }, { "name": "filter", - "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. 2fa_insecure means that only members with insecure 2FA methods will be returned. These options are only available for organization owners.

", + "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. 2fa_insecure means that only members with insecure 2FA methods will be returned. These options are only available for organization owners.

", "in": "query", "required": false, "schema": { @@ -15562,7 +15562,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15571,7 +15571,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16295,7 +16295,7 @@ "default": "member" } ], - "descriptionHTML": "

Only authenticated organization owners can add a member to the organization or update the member's role.

\n
    \n
  • \n

    If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending until they accept the invitation.

    \n
  • \n
  • \n

    Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.

    \n
  • \n
\n

Rate limits

\n

To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.

", + "descriptionHTML": "

Only authenticated organization owners can add a member to the organization or update the member's role.

\n
    \n
  • \n

    If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending until they accept the invitation.

    \n
  • \n
  • \n

    Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.

    \n
  • \n
\n

Rate limits

\n

To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.

", "codeExamples": [ { "request": { @@ -16722,7 +16722,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16731,7 +16731,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -17008,7 +17008,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The user can publicize their own membership. (A user cannot publicize the membership for another user.)

\n

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

", + "descriptionHTML": "

The user can publicize their own membership. (A user cannot publicize the membership for another user.)

\n

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

", "codeExamples": [ { "request": { @@ -17133,7 +17133,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -17142,7 +17142,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18273,7 +18273,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18282,7 +18282,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -19064,7 +19064,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -19156,7 +19156,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", + "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -19523,7 +19523,7 @@ ] } ], - "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", + "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -19830,7 +19830,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes all assigned organization roles from a team. 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.

", + "descriptionHTML": "

Removes all assigned organization roles from a team. 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.

", "codeExamples": [ { "request": { @@ -19902,7 +19902,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Assigns an organization role to a team in an organization. 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.

", + "descriptionHTML": "

Assigns an organization role to a team in an organization. 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.

", "codeExamples": [ { "request": { @@ -19983,7 +19983,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes an organization role from a team. 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.

", + "descriptionHTML": "

Removes an organization role from a team. 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.

", "codeExamples": [ { "request": { @@ -20047,7 +20047,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -20119,7 +20119,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Assigns an organization role to a member of an organization. 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.

", + "descriptionHTML": "

Assigns an organization role to a member of an organization. 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.

", "codeExamples": [ { "request": { @@ -20200,7 +20200,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Remove an organization role 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.

", + "descriptionHTML": "

Remove an organization role 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.

", "codeExamples": [ { "request": { @@ -20264,7 +20264,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -20586,7 +20586,7 @@ ] } ], - "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", + "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -20887,7 +20887,7 @@ } ], "bodyParameters": [], - "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
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", + "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
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -20950,7 +20950,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20959,7 +20959,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20968,7 +20968,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the teams 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.

", + "descriptionHTML": "

Lists the teams 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.

", "codeExamples": [ { "request": { @@ -21272,7 +21272,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21281,7 +21281,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21290,7 +21290,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -21593,7 +21593,7 @@ }, { "name": "filter", - "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned. 2fa_insecure means that only outside collaborators with insecure 2FA methods will be returned.

", + "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned. 2fa_insecure means that only outside collaborators with insecure 2FA methods will be returned.

", "in": "query", "required": false, "schema": { @@ -21608,7 +21608,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21617,7 +21617,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21832,7 +21832,7 @@ "default": false } ], - "descriptionHTML": "

When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"

", + "descriptionHTML": "

When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"

", "codeExamples": [ { "request": { @@ -21887,7 +21887,7 @@ }, { "httpStatusCode": "403", - "description": "

Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"

" + "description": "

Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"

" }, { "httpStatusCode": "404", @@ -21994,7 +21994,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -22003,7 +22003,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -22656,7 +22656,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -22665,7 +22665,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -23589,7 +23589,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -23598,7 +23598,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24229,7 +24229,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24238,7 +24238,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25219,7 +25219,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25228,7 +25228,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25237,7 +25237,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists suites of rule evaluations at the organization level.\nFor more information, see \"Managing rulesets for repositories in your organization.\"

", + "descriptionHTML": "

Lists suites of rule evaluations at the organization level.\nFor more information, see \"Managing rulesets for repositories in your organization.\"

", "codeExamples": [ { "request": { @@ -25390,7 +25390,7 @@ }, { "name": "rule_suite_id", - "description": "

The unique identifier of the rule suite result.\nTo get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites\nfor repositories and GET /orgs/{org}/rulesets/rule-suites\nfor organizations.

", + "description": "

The unique identifier of the rule suite result.\nTo get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites\nfor repositories and GET /orgs/{org}/rulesets/rule-suites\nfor organizations.

", "in": "path", "required": true, "schema": { @@ -25399,7 +25399,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"Managing rulesets for repositories in your organization.\"

", + "descriptionHTML": "

Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"Managing rulesets for repositories in your organization.\"

", "codeExamples": [ { "request": { @@ -25639,7 +25639,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25648,7 +25648,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -26966,7 +26966,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -26976,7 +26976,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -28094,7 +28094,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -28106,7 +28106,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -29521,7 +29521,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -29531,7 +29531,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -30976,7 +30976,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -30986,7 +30986,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -32109,7 +32109,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -32121,7 +32121,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -33537,7 +33537,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -33547,7 +33547,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -33740,7 +33740,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -33749,7 +33749,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -34076,7 +34076,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.

\n
", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.

\n
", "codeExamples": [ { "request": { @@ -34249,7 +34249,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.

\n
", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.

\n
", "codeExamples": [ { "request": { @@ -34312,7 +34312,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.

\n
", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.

\n
", "codeExamples": [ { "request": { @@ -34368,7 +34368,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -34377,7 +34377,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -34568,7 +34568,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -34590,7 +34590,7 @@ { "type": "array of strings", "name": "events", - "description": "

Determines what events the hook is triggered for. Set to [\"*\"] to receive all possible events.

", + "description": "

Determines what events the hook is triggered for. Set to [\"*\"] to receive all possible events.

", "default": [ "push" ] @@ -34959,7 +34959,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -34971,7 +34971,7 @@ { "type": "array of strings", "name": "events", - "description": "

Determines what events the hook is triggered for.

", + "description": "

Determines what events the hook is triggered for.

", "default": [ "push" ] @@ -35263,7 +35263,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -35340,7 +35340,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -35392,7 +35392,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -35456,7 +35456,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/packages.json b/src/rest/data/ghec-2022-11-28/packages.json index adb07cbd8af5..ba0022e0cddb 100644 --- a/src/rest/data/ghec-2022-11-28/packages.json +++ b/src/rest/data/ghec-2022-11-28/packages.json @@ -1071,7 +1071,7 @@ }, { "name": "visibility", - "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", + "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", "in": "query", "required": false, "schema": { @@ -1085,7 +1085,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1094,7 +1094,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1103,7 +1103,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists packages in an organization readable by the 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.\"

", + "descriptionHTML": "

Lists packages in an organization readable by the 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.\"

", "codeExamples": [ { "request": { @@ -2168,7 +2168,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specific package in an organization.

\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.\"

", + "descriptionHTML": "

Gets a specific package in an organization.

\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.\"

", "codeExamples": [ { "request": { @@ -3187,7 +3187,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -3287,7 +3287,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Restores an entire package in an organization.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Restores an entire package in an organization.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -3378,7 +3378,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3387,7 +3387,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3410,7 +3410,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists package versions for a package owned by an organization.

\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.\"

", + "descriptionHTML": "

Lists package versions for a package owned by an organization.

\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.\"

", "codeExamples": [ { "request": { @@ -3640,7 +3640,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specific package version in an organization.

\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.\"

", + "descriptionHTML": "

Gets a specific package version in an organization.

\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.\"

", "codeExamples": [ { "request": { @@ -3847,7 +3847,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -3948,7 +3948,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Restores a specific package version in an organization.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Restores a specific package version in an organization.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -5035,7 +5035,7 @@ }, { "name": "visibility", - "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", + "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", "in": "query", "required": false, "schema": { @@ -5049,7 +5049,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5058,7 +5058,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5067,7 +5067,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists packages owned by the authenticated user within the user's namespace.

\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.\"

", + "descriptionHTML": "

Lists packages owned by the authenticated user within the user's namespace.

\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.\"

", "codeExamples": [ { "request": { @@ -6112,7 +6112,7 @@ } ], "bodyParameters": [], - "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.\"

", + "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.\"

", "codeExamples": [ { "request": { @@ -7188,7 +7188,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

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

", + "descriptionHTML": "

Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

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

", "codeExamples": [ { "request": { @@ -7278,7 +7278,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Restores a package owned by the authenticated user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

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

", + "descriptionHTML": "

Restores a package owned by the authenticated user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -7359,7 +7359,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7368,7 +7368,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7391,7 +7391,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists package versions 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.\"

", + "descriptionHTML": "

Lists package versions 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.\"

", "codeExamples": [ { "request": { @@ -7619,7 +7619,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specific package version 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.\"

", + "descriptionHTML": "

Gets a specific package version 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.\"

", "codeExamples": [ { "request": { @@ -7816,7 +7816,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint.

\n

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

", + "descriptionHTML": "

Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -7907,7 +7907,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Restores a package version owned by the authenticated user.

\n

You can restore a deleted package version under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

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

", + "descriptionHTML": "

Restores a package version owned by the authenticated user.

\n

You can restore a deleted package version under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -9015,7 +9015,7 @@ }, { "name": "visibility", - "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", + "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", "in": "query", "required": false, "schema": { @@ -9038,7 +9038,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9047,7 +9047,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9056,7 +9056,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all packages in a user's namespace for which the requesting user has access.

\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.\"

", + "descriptionHTML": "

Lists all packages in a user's namespace for which the requesting user has access.

\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.\"

", "codeExamples": [ { "request": { @@ -10121,7 +10121,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specific package metadata for a public package owned by a 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.\"

", + "descriptionHTML": "

Gets a specific package metadata for a public package owned by a 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.\"

", "codeExamples": [ { "request": { @@ -11207,7 +11207,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -11307,7 +11307,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Restores an entire package for a user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Restores an entire package for a user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -11398,7 +11398,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists package versions 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.\"

", + "descriptionHTML": "

Lists package versions 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.\"

", "codeExamples": [ { "request": { @@ -11645,7 +11645,7 @@ } ], "bodyParameters": [], - "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.\"

", + "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.\"

", "codeExamples": [ { "request": { @@ -11849,7 +11849,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -11950,7 +11950,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Restores a specific package version for a user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Restores a specific package version for a user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/pages.json b/src/rest/data/ghec-2022-11-28/pages.json index 03129f2a429b..879b2a198b41 100644 --- a/src/rest/data/ghec-2022-11-28/pages.json +++ b/src/rest/data/ghec-2022-11-28/pages.json @@ -555,7 +555,7 @@ { "type": "string or null", "name": "cname", - "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

" + "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

" }, { "type": "boolean", @@ -760,7 +760,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -769,7 +769,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/private-registries.json b/src/rest/data/ghec-2022-11-28/private-registries.json index ff05e1da0606..1e9e87b57174 100644 --- a/src/rest/data/ghec-2022-11-28/private-registries.json +++ b/src/rest/data/ghec-2022-11-28/private-registries.json @@ -19,7 +19,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -294,7 +294,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint. Required when auth_type is token or username_password. Should be omitted for OIDC auth types.

" + "description": "

The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint. Required when auth_type is token or username_password. Should be omitted for OIDC auth types.

" }, { "type": "string", @@ -315,7 +315,7 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when visibility is set to selected. You can manage the list of selected repositories using the Update a private registry for an organization endpoint. This field should be omitted if visibility is set to all or private.

" + "description": "

An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when visibility is set to selected. You can manage the list of selected repositories using the Update a private registry for an organization endpoint. This field should be omitted if visibility is set to all or private.

" }, { "type": "string", @@ -380,7 +380,7 @@ "description": "

The JFrog identity mapping name. Optional for oidc_jfrog auth type.

" } ], - "descriptionHTML": "

Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, or oidc_jfrog), the encrypted_value and key_id fields should be omitted.

\n

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

", + "descriptionHTML": "

Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, or oidc_jfrog), the encrypted_value and key_id fields should be omitted.

\n

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

", "codeExamples": [ { "request": { @@ -1084,7 +1084,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint.

" + "description": "

The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint.

" }, { "type": "string", @@ -1169,7 +1169,7 @@ "description": "

The JFrog identity mapping name. Optional for oidc_jfrog auth type.

" } ], - "descriptionHTML": "

Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, or oidc_jfrog), the encrypted_value and key_id fields should be omitted.

\n

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

", + "descriptionHTML": "

Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, or oidc_jfrog), the encrypted_value and key_id fields should be omitted.

\n

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

", "codeExamples": [], "statusCodes": [ { diff --git a/src/rest/data/ghec-2022-11-28/projects.json b/src/rest/data/ghec-2022-11-28/projects.json index 744332c68d54..c7d8a309f250 100644 --- a/src/rest/data/ghec-2022-11-28/projects.json +++ b/src/rest/data/ghec-2022-11-28/projects.json @@ -28,7 +28,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -37,7 +37,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -46,7 +46,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1623,7 +1623,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1632,7 +1632,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1641,7 +1641,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3353,7 +3353,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3362,7 +3362,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3371,7 +3371,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -5483,7 +5483,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5492,7 +5492,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -5501,7 +5501,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7594,7 +7594,7 @@ }, { "name": "q", - "description": "

Search query to filter items, see Filtering projects for more information.

", + "description": "

Search query to filter items, see Filtering projects for more information.

", "in": "query", "required": false, "schema": { @@ -7623,7 +7623,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7632,7 +7632,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7641,7 +7641,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -39668,7 +39668,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -39677,7 +39677,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -39686,7 +39686,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -40721,7 +40721,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -40730,7 +40730,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -40739,7 +40739,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -40748,7 +40748,7 @@ }, { "name": "q", - "description": "

Search query to filter items, see Filtering projects for more information.

", + "description": "

Search query to filter items, see Filtering projects for more information.

", "in": "query", "required": false, "schema": { @@ -72772,7 +72772,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -72781,7 +72781,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -72790,7 +72790,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -73842,7 +73842,7 @@ { "type": "string", "name": "filter", - "description": "

The filter query for the view. See Filtering projects for more information.

" + "description": "

The filter query for the view. See Filtering projects for more information.

" }, { "type": "array of integers", @@ -74867,7 +74867,7 @@ { "type": "string", "name": "filter", - "description": "

The filter query for the view. See Filtering projects for more information.

" + "description": "

The filter query for the view. See Filtering projects for more information.

" }, { "type": "array of integers", diff --git a/src/rest/data/ghec-2022-11-28/pulls.json b/src/rest/data/ghec-2022-11-28/pulls.json index c8341d911ba3..67ed44b577fc 100644 --- a/src/rest/data/ghec-2022-11-28/pulls.json +++ b/src/rest/data/ghec-2022-11-28/pulls.json @@ -90,7 +90,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -99,7 +99,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -108,7 +108,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists pull requests in a specified repository.

\n

Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists pull requests in a specified repository.

\n

Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -3714,12 +3714,12 @@ { "type": "boolean", "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" + "description": "

Indicates whether maintainers can modify the pull request.

" }, { "type": "boolean", "name": "draft", - "description": "

Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

" + "description": "

Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

" }, { "type": "integer", @@ -3727,7 +3727,7 @@ "description": "

An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

" } ], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -7375,7 +7375,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
  • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
  • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
  • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
  • \n
", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
  • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
  • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
  • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
  • \n
", "codeExamples": [ { "request": { @@ -7390,7 +7390,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Pass the appropriate media type to fetch diff and patch formats.

", + "description": "

Pass the appropriate media type to fetch diff and patch formats.

", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -10957,7 +10957,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Pass the appropriate media type to fetch diff and patch formats.

" + "description": "

Pass the appropriate media type to fetch diff and patch formats.

" }, { "httpStatusCode": "304", @@ -11060,10 +11060,10 @@ { "type": "boolean", "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" + "description": "

Indicates whether maintainers can modify the pull request.

" } ], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -14712,7 +14712,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14721,7 +14721,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14730,7 +14730,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -15407,7 +15407,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15416,7 +15416,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15425,7 +15425,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the files in a specified pull request.

\n

Note

\n

\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists the files in a specified pull request.

\n

Note

\n

\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -15699,7 +15699,7 @@ ] } ], - "descriptionHTML": "

Merges a pull request into the base branch.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Merges a pull request into the base branch.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", "codeExamples": [ { "request": { @@ -15827,7 +15827,7 @@ { "type": "string", "name": "expected_head_sha", - "description": "

The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

" + "description": "

The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

" } ], "descriptionHTML": "

Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.\nNote: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.

", @@ -15961,7 +15961,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15970,7 +15970,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15979,7 +15979,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -16497,7 +16497,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Provides details for a specified review comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Provides details for a specified review comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -17022,7 +17022,7 @@ "isRequired": true } ], - "descriptionHTML": "

Edits the content of a specified review comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Edits the content of a specified review comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -17653,7 +17653,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -17662,7 +17662,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -17671,7 +17671,7 @@ } ], "bodyParameters": [], - "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
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "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
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -18215,7 +18215,7 @@ { "type": "string", "name": "side", - "description": "

In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", + "description": "

In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", "enum": [ "LEFT", "RIGHT" @@ -18229,12 +18229,12 @@ { "type": "integer", "name": "start_line", - "description": "

Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

" + "description": "

Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

" }, { "type": "string", "name": "start_side", - "description": "

Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", + "description": "

Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", "enum": [ "LEFT", "RIGHT", @@ -18256,7 +18256,7 @@ ] } ], - "descriptionHTML": "

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\n

If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request.

\n

The position parameter is closing down. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\n

If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request.

\n

The position parameter is closing down. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -18803,7 +18803,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -19326,7 +19326,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

", + "descriptionHTML": "

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

", "codeExamples": [ { "request": { @@ -19783,7 +19783,7 @@ "description": "

An array of team slugs that will be requested.

" } ], - "descriptionHTML": "

Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", "codeExamples": [ { "request": { @@ -27015,7 +27015,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -27024,7 +27024,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -27033,7 +27033,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -27388,7 +27388,7 @@ { "type": "string", "name": "event", - "description": "

The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

", + "description": "

The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

", "enum": [ "APPROVE", "REQUEST_CHANGES", @@ -27440,7 +27440,7 @@ ] } ], - "descriptionHTML": "

Creates a review on a specified pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note

\n

\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.

\n
\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Creates a review on a specified pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note

\n

\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.

\n
\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -27806,7 +27806,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Retrieves a pull request review by its ID.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Retrieves a pull request review by its ID.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -28164,7 +28164,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates the contents of a specified review summary comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Updates the contents of a specified review summary comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -28518,7 +28518,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -28872,7 +28872,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28881,7 +28881,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28890,7 +28890,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists comments for a specific pull request review.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists comments for a specific pull request review.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -29426,7 +29426,7 @@ ] } ], - "descriptionHTML": "

Dismisses a specified review on a pull request.

\n

Note

\n

\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

\n
\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Dismisses a specified review on a pull request.

\n

Note

\n

\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

\n
\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -29802,7 +29802,7 @@ ] } ], - "descriptionHTML": "

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/rate-limit.json b/src/rest/data/ghec-2022-11-28/rate-limit.json index 3edf2f6fb22e..4359706e5865 100644 --- a/src/rest/data/ghec-2022-11-28/rate-limit.json +++ b/src/rest/data/ghec-2022-11-28/rate-limit.json @@ -9,7 +9,7 @@ "subcategory": "rate-limit", "parameters": [], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nAccessing this endpoint does not count against your REST API rate limit.

\n
\n

Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:

\n
    \n
  • The core object provides your rate limit status for all non-search-related resources in the REST API.
  • \n
  • The search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"
  • \n
  • The code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"
  • \n
  • The graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"
  • \n
  • The integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"
  • \n
  • The dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"
  • \n
  • The dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"
  • \n
  • The code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"
  • \n
  • The actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"
  • \n
  • The source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"
  • \n
\n

Note

\n

\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.

\n
", + "descriptionHTML": "

Note

\n

\nAccessing this endpoint does not count against your REST API rate limit.

\n
\n

Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:

\n
    \n
  • The core object provides your rate limit status for all non-search-related resources in the REST API.
  • \n
  • The search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"
  • \n
  • The code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"
  • \n
  • The graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"
  • \n
  • The integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"
  • \n
  • The dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"
  • \n
  • The dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"
  • \n
  • The code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"
  • \n
  • The actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"
  • \n
  • The source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"
  • \n
\n

Note

\n

\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.

\n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/reactions.json b/src/rest/data/ghec-2022-11-28/reactions.json index 47b08b8c4e4e..3b3c4123005f 100644 --- a/src/rest/data/ghec-2022-11-28/reactions.json +++ b/src/rest/data/ghec-2022-11-28/reactions.json @@ -38,7 +38,7 @@ }, { "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.

", + "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.

", "in": "query", "required": false, "schema": { @@ -57,7 +57,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -66,7 +66,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -75,7 +75,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List the reactions to a commit comment.

", + "descriptionHTML": "

List the reactions to a commit comment.

", "codeExamples": [ { "request": { @@ -345,7 +345,7 @@ { "type": "string", "name": "content", - "description": "

The reaction type to add to the commit comment.

", + "description": "

The reaction type to add to the commit comment.

", "isRequired": true, "enum": [ "+1", @@ -359,7 +359,7 @@ ] } ], - "descriptionHTML": "

Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.

", + "descriptionHTML": "

Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.

", "codeExamples": [ { "request": { @@ -839,7 +839,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a commit comment.

", + "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a commit comment.

", "codeExamples": [ { "request": { @@ -914,7 +914,7 @@ }, { "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.

", + "description": "

Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.

", "in": "query", "required": false, "schema": { @@ -933,7 +933,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -942,7 +942,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -951,7 +951,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List the reactions to an issue comment.

", + "descriptionHTML": "

List the reactions to an issue comment.

", "codeExamples": [ { "request": { @@ -1221,7 +1221,7 @@ { "type": "string", "name": "content", - "description": "

The reaction type to add to the issue comment.

", + "description": "

The reaction type to add to the issue comment.

", "isRequired": true, "enum": [ "+1", @@ -1235,7 +1235,7 @@ ] } ], - "descriptionHTML": "

Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.

", + "descriptionHTML": "

Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.

", "codeExamples": [ { "request": { @@ -1715,7 +1715,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

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

\n
\n

Delete a reaction to an issue comment.

", + "descriptionHTML": "

Note

\n

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

\n
\n

Delete a reaction to an issue comment.

", "codeExamples": [ { "request": { @@ -1789,7 +1789,7 @@ }, { "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to an issue.

", + "description": "

Returns a single reaction type. Omit this parameter to list all reactions to an issue.

", "in": "query", "required": false, "schema": { @@ -1808,7 +1808,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1817,7 +1817,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1826,7 +1826,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List the reactions to an issue.

", + "descriptionHTML": "

List the reactions to an issue.

", "codeExamples": [ { "request": { @@ -2099,7 +2099,7 @@ { "type": "string", "name": "content", - "description": "

The reaction type to add to the issue.

", + "description": "

The reaction type to add to the issue.

", "isRequired": true, "enum": [ "+1", @@ -2113,7 +2113,7 @@ ] } ], - "descriptionHTML": "

Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.

", + "descriptionHTML": "

Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.

", "codeExamples": [ { "request": { @@ -2592,7 +2592,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.

\n
\n

Delete a reaction to an issue.

", + "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.

\n
\n

Delete a reaction to an issue.

", "codeExamples": [ { "request": { @@ -2667,7 +2667,7 @@ }, { "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.

", + "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.

", "in": "query", "required": false, "schema": { @@ -2686,7 +2686,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2695,7 +2695,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2704,7 +2704,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List the reactions to a pull request review comment.

", + "descriptionHTML": "

List the reactions to a pull request review comment.

", "codeExamples": [ { "request": { @@ -2974,7 +2974,7 @@ { "type": "string", "name": "content", - "description": "

The reaction type to add to the pull request review comment.

", + "description": "

The reaction type to add to the pull request review comment.

", "isRequired": true, "enum": [ "+1", @@ -2988,7 +2988,7 @@ ] } ], - "descriptionHTML": "

Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.

", + "descriptionHTML": "

Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.

", "codeExamples": [ { "request": { @@ -3468,7 +3468,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a pull request review comment.

", + "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a pull request review comment.

", "codeExamples": [ { "request": { @@ -3542,7 +3542,7 @@ }, { "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a release.

", + "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a release.

", "in": "query", "required": false, "schema": { @@ -3559,7 +3559,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3568,7 +3568,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3577,7 +3577,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List the reactions to a release.

", + "descriptionHTML": "

List the reactions to a release.

", "codeExamples": [ { "request": { @@ -3842,7 +3842,7 @@ { "type": "string", "name": "content", - "description": "

The reaction type to add to the release.

", + "description": "

The reaction type to add to the release.

", "isRequired": true, "enum": [ "+1", @@ -3854,7 +3854,7 @@ ] } ], - "descriptionHTML": "

Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.

", + "descriptionHTML": "

Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.

", "codeExamples": [ { "request": { @@ -4330,7 +4330,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/releases.json b/src/rest/data/ghec-2022-11-28/releases.json index 7a288b88cb21..ba5404e608c7 100644 --- a/src/rest/data/ghec-2022-11-28/releases.json +++ b/src/rest/data/ghec-2022-11-28/releases.json @@ -28,7 +28,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -37,7 +37,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -46,7 +46,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.

\n

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.

", + "descriptionHTML": "

This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.

\n

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.

", "codeExamples": [ { "request": { @@ -716,7 +716,7 @@ { "type": "string", "name": "discussion_category_name", - "description": "

If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"Managing categories for discussions in your repository.\"

" + "description": "

If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"Managing categories for discussions in your repository.\"

" }, { "type": "boolean", @@ -736,7 +736,7 @@ "default": "true" } ], - "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", "codeExamples": [ { "request": { @@ -1405,7 +1405,7 @@ "description": "

Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

" } ], - "descriptionHTML": "

Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.

", + "descriptionHTML": "

Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.

", "codeExamples": [ { "request": { @@ -2782,7 +2782,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a public release with the specified release ID.

\n

Note

\n

\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

\n
", + "descriptionHTML": "

Gets a public release with the specified release ID.

\n

Note

\n

\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

\n
", "codeExamples": [ { "request": { @@ -2797,7 +2797,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

", + "description": "

Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -3365,7 +3365,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

" + "description": "

Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

" }, { "httpStatusCode": "401", @@ -3466,7 +3466,7 @@ { "type": "string", "name": "discussion_category_name", - "description": "

If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"Managing categories for discussions in your repository.\"

" + "description": "

If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"Managing categories for discussions in your repository.\"

" } ], "descriptionHTML": "

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

", @@ -4196,7 +4196,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

To download the asset's binary content:

\n
    \n
  • If within a browser, fetch the location specified in the browser_download_url key provided in the response.
  • \n
  • Alternatively, set the Accept header of the request to\napplication/octet-stream.\nThe API will either redirect the client to the location, or stream it directly if possible.\nAPI clients should handle both a 200 or 302 response.
  • \n
", + "descriptionHTML": "

To download the asset's binary content:

\n
    \n
  • If within a browser, fetch the location specified in the browser_download_url key provided in the response.
  • \n
  • Alternatively, set the Accept header of the request to\napplication/octet-stream.\nThe API will either redirect the client to the location, or stream it directly if possible.\nAPI clients should handle both a 200 or 302 response.
  • \n
", "codeExamples": [ { "request": { @@ -4913,7 +4913,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4922,7 +4922,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5259,7 +5259,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.

\n

You need to use an HTTP client which supports SNI to make calls to this endpoint.

\n

Most libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:

\n

application/zip

\n

GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.

\n

When an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.

\n

Notes:

\n
    \n
  • GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"List release assets\"\nendpoint lists the renamed filenames. For more information and help, contact GitHub Enterprise Cloud Support.
  • \n
  • To find the release_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.
  • \n
  • If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
  • \n
", + "descriptionHTML": "

This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.

\n

You need to use an HTTP client which supports SNI to make calls to this endpoint.

\n

Most libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:

\n

application/zip

\n

GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.

\n

When an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.

\n

Notes:

\n
    \n
  • GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"List release assets\"\nendpoint lists the renamed filenames. For more information and help, contact GitHub Enterprise Cloud Support.
  • \n
  • To find the release_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.
  • \n
  • If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
  • \n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/repos.json b/src/rest/data/ghec-2022-11-28/repos.json index 3f2bdaa1ca57..2711a453676a 100644 --- a/src/rest/data/ghec-2022-11-28/repos.json +++ b/src/rest/data/ghec-2022-11-28/repos.json @@ -65,7 +65,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -74,7 +74,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -83,7 +83,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists repositories for the specified organization.

\n

Note

\n

\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n
", + "descriptionHTML": "

Lists repositories for the specified organization.

\n

Note

\n

\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n
", "codeExamples": [ { "request": { @@ -1066,7 +1066,7 @@ { "type": "string", "name": "license_template", - "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

" + "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

" }, { "type": "boolean", @@ -4724,7 +4724,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.

\n

Note

\n

\n
    \n
  • In order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
  • \n
  • To view merge-related settings, you must have the contents:read and contents:write permissions.
  • \n
\n
", + "descriptionHTML": "

The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.

\n

Note

\n

\n
    \n
  • In order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
  • \n
  • To view merge-related settings, you must have the contents:read and contents:write permissions.
  • \n
\n
", "codeExamples": [ { "request": { @@ -8336,7 +8336,7 @@ { "type": "boolean", "name": "private", - "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", + "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", "default": false }, { @@ -8352,7 +8352,7 @@ { "type": "object or null", "name": "security_and_analysis", - "description": "

Specify which security and analysis features to enable or disable for the repository.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

\n

You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

", + "description": "

Specify which security and analysis features to enable or disable for the repository.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

\n

You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

", "childParamsGroups": [ { "type": "object", @@ -8405,7 +8405,7 @@ { "type": "object", "name": "secret_scanning_ai_detection", - "description": "

Use the status property to enable or disable secret scanning AI detection for this repository. For more information, see \"Responsible detection of generic secrets with AI.\"

", + "description": "

Use the status property to enable or disable secret scanning AI detection for this repository. For more information, see \"Responsible detection of generic secrets with AI.\"

", "childParamsGroups": [ { "type": "string", @@ -8632,7 +8632,7 @@ "default": false } ], - "descriptionHTML": "

Note: To edit a repository's topics, use the Replace all repository topics endpoint.

", + "descriptionHTML": "

Note: To edit a repository's topics, use the Replace all repository topics endpoint.

", "codeExamples": [ { "request": { @@ -12310,7 +12310,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -12319,7 +12319,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -12328,7 +12328,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -12388,7 +12388,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.

\n

For more information about viewing repository activity,\nsee \"Viewing activity and data for your repository.\"

", + "descriptionHTML": "

Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.

\n

For more information about viewing repository activity,\nsee \"Viewing activity and data for your repository.\"

", "codeExamples": [ { "request": { @@ -12661,7 +12661,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"Configuring Dependabot security updates\".

", + "descriptionHTML": "

Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"Configuring Dependabot security updates\".

", "codeExamples": [ { "request": { @@ -12752,7 +12752,7 @@ } ], "bodyParameters": [], - "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\".

", + "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\".

", "codeExamples": [ { "request": { @@ -12815,7 +12815,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "codeExamples": [ { "request": { @@ -12887,7 +12887,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List any syntax errors that are detected in the CODEOWNERS\nfile.

\n

For more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"

", + "descriptionHTML": "

List any syntax errors that are detected in the CODEOWNERS\nfile.

\n

For more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"

", "codeExamples": [ { "request": { @@ -13043,7 +13043,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13052,7 +13052,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13264,7 +13264,7 @@ "description": "

JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB.

" } ], - "descriptionHTML": "

You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub Enterprise Cloud to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see \"RepositoryDispatchEvent.\"

\n

The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow.

\n

This input example shows how you can use the client_payload as a test to debug your workflow.

\n

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

", + "descriptionHTML": "

You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub Enterprise Cloud to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see \"RepositoryDispatchEvent.\"

\n

The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow.

\n

This input example shows how you can use the client_payload as a test to debug your workflow.

\n

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

", "codeExamples": [ { "request": { @@ -13645,7 +13645,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"Evaluating the security settings of a repository\".

", + "descriptionHTML": "

Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"Evaluating the security settings of a repository\".

", "codeExamples": [ { "request": { @@ -13729,7 +13729,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability.\"

", + "descriptionHTML": "

Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability.\"

", "codeExamples": [ { "request": { @@ -13796,7 +13796,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability\".

", + "descriptionHTML": "

Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability\".

", "codeExamples": [ { "request": { @@ -13863,7 +13863,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13872,7 +13872,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14005,7 +14005,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14014,7 +14014,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14313,7 +14313,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14322,7 +14322,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14553,7 +14553,7 @@ "description": "

ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

" } ], - "descriptionHTML": "

A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

", + "descriptionHTML": "

A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

", "codeExamples": [ { "request": { @@ -15574,7 +15574,7 @@ } ], "bodyParameters": [], - "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\".

", + "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\".

", "codeExamples": [ { "request": { @@ -15641,7 +15641,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".

", + "descriptionHTML": "

Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".

", "codeExamples": [ { "request": { @@ -15704,7 +15704,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".

", + "descriptionHTML": "

Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".

", "codeExamples": [ { "request": { @@ -15796,7 +15796,7 @@ "default": false } ], - "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\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.

", + "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\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.

", "codeExamples": [ { "request": { @@ -19355,7 +19355,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all public repositories in the order that they were created.

\n

Note:

\n
    \n
  • For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
  • \n
  • Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
  • \n
", + "descriptionHTML": "

Lists all public repositories in the order that they were created.

\n

Note:

\n
    \n
  • For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
  • \n
  • Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
  • \n
", "codeExamples": [ { "request": { @@ -20272,7 +20272,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20281,7 +20281,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24943,7 +24943,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24952,7 +24952,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25898,7 +25898,7 @@ ] } ], - "descriptionHTML": "

Store an artifact attestation and associate it with a repository.

\n

The authenticated user must have write permission to the repository and, if using a fine-grained access token, the attestations:write permission is required.

\n

Artifact attestations are meant to be created using the attest action. For more information, see our guide on using artifact attestations to establish a build's provenance.

", + "descriptionHTML": "

Store an artifact attestation and associate it with a repository.

\n

The authenticated user must have write permission to the repository and, if using a fine-grained access token, the attestations:write permission is required.

\n

Artifact attestations are meant to be created using the attest action. For more information, see our guide on using artifact attestations to establish a build's provenance.

", "codeExamples": [ { "request": { @@ -26043,7 +26043,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -26052,7 +26052,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -26061,7 +26061,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -26088,7 +26088,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List a collection of artifact attestations with a given subject digest that are associated with a repository.

\n

The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", + "descriptionHTML": "

List a collection of artifact attestations with a given subject digest that are associated with a repository.

\n

The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", "codeExamples": [ { "request": { @@ -26819,7 +26819,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -26828,7 +26828,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -27544,7 +27544,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory with the path parameter. If you omit the path parameter, you will receive the contents of the repository's root directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents for files and symlinks.
  • \n
  • application/vnd.github.html+json: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
  • application/vnd.github.object+json: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an entries attribute containing the array of objects.
  • \n
\n

If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value should be \"submodule\". This behavior exists for backwards compatibility purposes. In the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

\n

If the content is a submodule, the submodule_git_url field identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the github.com URLs (html_url and _links[\"html\"]) will have null values.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
  • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the Git Trees API.
  • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
  • \n
  • If the requested file's size is:\n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
    • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty\nstring and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
    • \n
    • Greater than 100 MB: This endpoint is not supported.
    • \n
    \n
  • \n
", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory with the path parameter. If you omit the path parameter, you will receive the contents of the repository's root directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents for files and symlinks.
  • \n
  • application/vnd.github.html+json: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
  • application/vnd.github.object+json: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an entries attribute containing the array of objects.
  • \n
\n

If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value should be \"submodule\". This behavior exists for backwards compatibility purposes. In the next major version of the API, the type will be returned as \"submodule\".

\n

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

\n

If the content is a submodule, the submodule_git_url field identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the github.com URLs (html_url and _links[\"html\"]) will have null values.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
  • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the Git Trees API.
  • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
  • \n
  • If the requested file's size is:\n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
    • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty\nstring and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
    • \n
    • Greater than 100 MB: This endpoint is not supported.
    • \n
    \n
  • \n
", "codeExamples": [ { "response": { @@ -29892,7 +29892,7 @@ ] } ], - "descriptionHTML": "

Creates a new file or replaces an existing file in a repository.

\n

Note

\n

\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

\n
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.

", + "descriptionHTML": "

Creates a new file or replaces an existing file in a repository.

\n

Note

\n

\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

\n
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.

", "codeExamples": [ { "request": { @@ -30509,7 +30509,7 @@ ] } ], - "descriptionHTML": "

Deletes a file in a repository.

\n

You can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.

\n

The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.

\n

You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.

\n

Note

\n

\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

\n
", + "descriptionHTML": "

Deletes a file in a repository.

\n

You can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.

\n

The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.

\n

You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.

\n

Note

\n

\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

\n
", "codeExamples": [ { "request": { @@ -30815,7 +30815,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the preferred README for a repository.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
  • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
", + "descriptionHTML": "

Gets the preferred README for a repository.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
  • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
", "codeExamples": [ { "request": { @@ -31032,7 +31032,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the README from a repository directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
  • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
", + "descriptionHTML": "

Gets the README from a repository directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
  • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
", "codeExamples": [ { "request": { @@ -31633,7 +31633,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31642,7 +31642,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -36336,7 +36336,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -36345,7 +36345,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -36354,7 +36354,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists suites of rule evaluations at the repository level.\nFor more information, see \"Managing rulesets for a repository.\"

", + "descriptionHTML": "

Lists suites of rule evaluations at the repository level.\nFor more information, see \"Managing rulesets for a repository.\"

", "codeExamples": [ { "request": { @@ -36517,7 +36517,7 @@ }, { "name": "rule_suite_id", - "description": "

The unique identifier of the rule suite result.\nTo get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites\nfor repositories and GET /orgs/{org}/rulesets/rule-suites\nfor organizations.

", + "description": "

The unique identifier of the rule suite result.\nTo get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites\nfor repositories and GET /orgs/{org}/rulesets/rule-suites\nfor organizations.

", "in": "path", "required": true, "schema": { @@ -36526,7 +36526,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"Managing rulesets for a repository.\"

", + "descriptionHTML": "

Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"Managing rulesets for a repository.\"

", "codeExamples": [ { "request": { @@ -36776,7 +36776,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -36785,7 +36785,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -36794,7 +36794,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -38195,7 +38195,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -38205,7 +38205,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -38365,7 +38365,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -38374,7 +38374,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -39703,7 +39703,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -39713,7 +39713,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -40758,7 +40758,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -40770,7 +40770,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -42166,7 +42166,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -42176,7 +42176,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -43631,7 +43631,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -43641,7 +43641,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -44691,7 +44691,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -44703,7 +44703,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -46100,7 +46100,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -46110,7 +46110,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -46322,7 +46322,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -46331,7 +46331,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -46668,7 +46668,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -46677,7 +46677,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -46774,7 +46774,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -46935,7 +46935,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -46947,7 +46947,7 @@ { "type": "array of strings", "name": "events", - "description": "

Determines what events the hook is triggered for.

", + "description": "

Determines what events the hook is triggered for.

", "default": [ "push" ] @@ -47057,7 +47057,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47296,7 +47296,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47460,7 +47460,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -47472,7 +47472,7 @@ { "type": "array of strings", "name": "events", - "description": "

Determines what events the hook is triggered for. This replaces the entire array of events.

", + "description": "

Determines what events the hook is triggered for. This replaces the entire array of events.

", "default": [ "push" ] @@ -47586,7 +47586,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47851,7 +47851,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47937,7 +47937,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -47988,7 +47988,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -48061,7 +48061,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -48662,7 +48662,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/scim.json b/src/rest/data/ghec-2022-11-28/scim.json index a46572506290..7401c7e12103 100644 --- a/src/rest/data/ghec-2022-11-28/scim.json +++ b/src/rest/data/ghec-2022-11-28/scim.json @@ -768,7 +768,7 @@ "description": "" } ], - "descriptionHTML": "

Provisions organization membership for a user, and sends an activation email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see \"Reinstating a former member of your organization.\"

", + "descriptionHTML": "

Provisions organization membership for a user, and sends an activation email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see \"Reinstating a former member of your organization.\"

", "codeExamples": [ { "request": { @@ -1475,7 +1475,7 @@ ] } ], - "descriptionHTML": "

Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.

\n

You must at least provide the required values for the user: userName, name, and emails.

\n

Warning

\n

\nSetting active: false removes the user from the organization, deletes the external identity, and deletes the associated {scim_user_id}.

\n
", + "descriptionHTML": "

Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.

\n

You must at least provide the required values for the user: userName, name, and emails.

\n

Warning

\n

\nSetting active: false removes the user from the organization, deletes the external identity, and deletes the associated {scim_user_id}.

\n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/search.json b/src/rest/data/ghec-2022-11-28/search.json index 588c5a5a8beb..1cd38f0738f4 100644 --- a/src/rest/data/ghec-2022-11-28/search.json +++ b/src/rest/data/ghec-2022-11-28/search.json @@ -10,7 +10,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { @@ -19,7 +19,7 @@ }, { "name": "sort", - "description": "

This field is closing down. Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: best match

", + "description": "

This field is closing down. Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: best match

", "in": "query", "required": false, "schema": { @@ -45,7 +45,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -54,7 +54,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -63,7 +63,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search:

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n
    \n
  • Only the default branch is considered. In most cases, this will be the master branch.
  • \n
  • Only files smaller than 384 KB are searchable.
  • \n
  • You must always include at least one search term when searching source code. For example, searching for language:go is not valid, while amazing language:go is.
  • \n
\n

Note

\n

\nrepository.description, repository.owner.type, and repository.owner.node_id are closing down on this endpoint and will return null in a future API version. Use the Get a repository endpoint (GET /repos/{owner}/{repo}) to retrieve full repository metadata.

\n
\n

This endpoint requires you to authenticate and limits you to 10 requests per minute.

", + "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search:

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n
    \n
  • Only the default branch is considered. In most cases, this will be the master branch.
  • \n
  • Only files smaller than 384 KB are searchable.
  • \n
  • You must always include at least one search term when searching source code. For example, searching for language:go is not valid, while amazing language:go is.
  • \n
\n

Note

\n

\nrepository.description, repository.owner.type, and repository.owner.node_id are closing down on this endpoint and will return null in a future API version. Use the Get a repository endpoint (GET /repos/{owner}/{repo}) to retrieve full repository metadata.

\n
\n

This endpoint requires you to authenticate and limits you to 10 requests per minute.

", "codeExamples": [ { "request": { @@ -1042,7 +1042,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching commits\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching commits\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { @@ -1051,7 +1051,7 @@ }, { "name": "sort", - "description": "

Sorts the results of your query by author-date or committer-date. Default: best match

", + "description": "

Sorts the results of your query by author-date or committer-date. Default: best match

", "in": "query", "required": false, "schema": { @@ -1078,7 +1078,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1087,7 +1087,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1096,7 +1096,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.

\n

When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.

\n

For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:

\n

q=repo:octocat/Spoon-Knife+css

", + "descriptionHTML": "

Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.

\n

When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.

\n

For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:

\n

q=repo:octocat/Spoon-Knife+css

", "codeExamples": [ { "request": { @@ -2369,7 +2369,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching issues and pull requests\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching issues and pull requests\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { @@ -2378,7 +2378,7 @@ }, { "name": "sort", - "description": "

Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

", + "description": "

Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

", "in": "query", "required": false, "schema": { @@ -2414,7 +2414,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2423,7 +2423,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2454,7 +2454,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note

\n

\nFor requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

\n
", + "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note

\n

\nFor requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

\n
", "codeExamples": [ { "request": { @@ -8157,7 +8157,7 @@ }, { "name": "q", - "description": "

The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.

", + "description": "

The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.

", "in": "query", "required": true, "schema": { @@ -8166,7 +8166,7 @@ }, { "name": "sort", - "description": "

Sorts the results of your query by when the label was created or updated. Default: best match

", + "description": "

Sorts the results of your query by when the label was created or updated. Default: best match

", "in": "query", "required": false, "schema": { @@ -8193,7 +8193,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8202,7 +8202,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8211,7 +8211,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.

\n

When searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:

\n

q=bug+defect+enhancement&repository_id=64778136

\n

The labels that best match the query appear first in the search results.

", + "descriptionHTML": "

Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.

\n

When searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:

\n

q=bug+defect+enhancement&repository_id=64778136

\n

The labels that best match the query appear first in the search results.

", "codeExamples": [ { "request": { @@ -8401,7 +8401,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { @@ -8410,7 +8410,7 @@ }, { "name": "sort", - "description": "

Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match

", + "description": "

Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match

", "in": "query", "required": false, "schema": { @@ -8439,7 +8439,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8448,7 +8448,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8457,7 +8457,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Find repositories via various criteria. This method returns up to 100 results per page.

\n

When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

\n

q=tetris+language:assembly&sort=stars&order=desc

\n

This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.

", + "descriptionHTML": "

Find repositories via various criteria. This method returns up to 100 results per page.

\n

When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

\n

q=tetris+language:assembly&sort=stars&order=desc

\n

This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.

", "codeExamples": [ { "request": { @@ -9256,7 +9256,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query.

", "in": "query", "required": true, "schema": { @@ -9265,7 +9265,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9274,7 +9274,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9283,7 +9283,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.

\n

When searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

\n

q=ruby+is:featured

\n

This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.

", + "descriptionHTML": "

Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.

\n

When searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

\n

q=ruby+is:featured

\n

This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.

", "codeExamples": [ { "request": { @@ -9610,7 +9610,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching users\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching users\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { @@ -9619,7 +9619,7 @@ }, { "name": "sort", - "description": "

Sorts the results of your query by number of followers or repositories, or when the person joined GitHub Enterprise Cloud. Default: best match

", + "description": "

Sorts the results of your query by number of followers or repositories, or when the person joined GitHub Enterprise Cloud. Default: best match

", "in": "query", "required": false, "schema": { @@ -9647,7 +9647,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9656,7 +9656,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9665,7 +9665,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Find users via various criteria. This method returns up to 100 results per page.

\n

When searching for users, you can get text match metadata for the issue login, public email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you're looking for a list of popular users, you might try this query:

\n

q=tom+repos:%3E42+followers:%3E1000

\n

This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.

\n

This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"GraphQL Queries.\"

", + "descriptionHTML": "

Find users via various criteria. This method returns up to 100 results per page.

\n

When searching for users, you can get text match metadata for the issue login, public email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you're looking for a list of popular users, you might try this query:

\n

q=tom+repos:%3E42+followers:%3E1000

\n

This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.

\n

This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"GraphQL Queries.\"

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/secret-scanning.json b/src/rest/data/ghec-2022-11-28/secret-scanning.json index e11b8bebdba9..c94cda1cde58 100644 --- a/src/rest/data/ghec-2022-11-28/secret-scanning.json +++ b/src/rest/data/ghec-2022-11-28/secret-scanning.json @@ -33,7 +33,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "description": "

A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -114,7 +114,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -123,7 +123,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -132,7 +132,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -180,7 +180,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the repo scope or security_events scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager, or for repositories owned by enterprise managed users.

", + "descriptionHTML": "

Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the repo scope or security_events scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager, or for repositories owned by enterprise managed users.

", "codeExamples": [ { "request": { @@ -578,7 +578,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -1905,7 +1905,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "description": "

A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -1914,7 +1914,7 @@ { "name": "exclude_secret_types", "in": "query", - "description": "

A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "description": "

A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -1986,7 +1986,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1995,7 +1995,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2004,7 +2004,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.

", "in": "query", "required": false, "schema": { @@ -2013,7 +2013,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.

", "in": "query", "required": false, "schema": { @@ -2459,7 +2459,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -3799,7 +3799,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "description": "

A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -3808,7 +3808,7 @@ { "name": "exclude_secret_types", "in": "query", - "description": "

A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "description": "

A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -3880,7 +3880,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3889,7 +3889,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3898,7 +3898,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.

", "in": "query", "required": false, "schema": { @@ -3907,7 +3907,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.

", "in": "query", "required": false, "schema": { @@ -4294,7 +4294,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -5515,7 +5515,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -6805,7 +6805,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -7777,7 +7777,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7786,7 +7786,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8435,7 +8435,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.

\n

Note

\n

\nThis endpoint requires GitHub Advanced Security.\"

\n
\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.

", + "descriptionHTML": "

Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.

\n

Note

\n

\nThis endpoint requires GitHub Advanced Security.\"

\n
\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.

", "codeExamples": [ { "request": { @@ -9183,7 +9183,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9192,7 +9192,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9602,7 +9602,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9611,7 +9611,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10473,7 +10473,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10482,7 +10482,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10891,7 +10891,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10900,7 +10900,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11315,7 +11315,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11324,7 +11324,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2022-11-28/security-advisories.json b/src/rest/data/ghec-2022-11-28/security-advisories.json index 229112dbeb96..74c3b264e0c1 100644 --- a/src/rest/data/ghec-2022-11-28/security-advisories.json +++ b/src/rest/data/ghec-2022-11-28/security-advisories.json @@ -125,7 +125,7 @@ { "name": "published", "in": "query", - "description": "

If specified, only return advisories that were published on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", + "description": "

If specified, only return advisories that were published on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", "schema": { "type": "string" } @@ -133,14 +133,14 @@ { "name": "updated", "in": "query", - "description": "

If specified, only return advisories that were updated on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", + "description": "

If specified, only return advisories that were updated on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", "schema": { "type": "string" } }, { "name": "modified", - "description": "

If specified, only show advisories that were updated or published on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", + "description": "

If specified, only show advisories that were updated or published on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", "in": "query", "schema": { "type": "string" @@ -164,7 +164,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -173,7 +173,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -196,7 +196,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -223,7 +223,7 @@ } ], "bodyParameters": [], - "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.\"

", + "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.\"

", "codeExamples": [ { "request": { @@ -1649,7 +1649,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1658,7 +1658,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1667,7 +1667,7 @@ }, { "name": "per_page", - "description": "

The number of advisories to return per page. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of advisories to return per page. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3760,7 +3760,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3769,7 +3769,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3778,7 +3778,7 @@ }, { "name": "per_page", - "description": "

The number of advisories to return per page. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of advisories to return per page. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7959,7 +7959,7 @@ "default": false } ], - "descriptionHTML": "

Report a security vulnerability to the maintainers of the repository.\nSee \"Privately reporting a security vulnerability\" for more information about private vulnerability reporting.

", + "descriptionHTML": "

Report a security vulnerability to the maintainers of the repository.\nSee \"Privately reporting a security vulnerability\" for more information about private vulnerability reporting.

", "codeExamples": [ { "request": { @@ -15402,7 +15402,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"Requesting a CVE identification number.\"

\n

You may request a CVE for public repositories, but cannot do so for private repositories.

\n

In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.

\n

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

", + "descriptionHTML": "

If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"Requesting a CVE identification number.\"

\n

You may request a CVE for public repositories, but cannot do so for private repositories.

\n

In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.

\n

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/teams.json b/src/rest/data/ghec-2022-11-28/teams.json index 2b65b5174c3c..5c7a9ae0720b 100644 --- a/src/rest/data/ghec-2022-11-28/teams.json +++ b/src/rest/data/ghec-2022-11-28/teams.json @@ -19,7 +19,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -37,7 +37,7 @@ }, { "name": "team_type", - "description": "

Filter team results by their type. For more information, see \"What kind of team should I use?\"

", + "description": "

Filter team results by their type. For more information, see \"What kind of team should I use?\"

", "in": "query", "required": false, "schema": { @@ -387,7 +387,7 @@ "description": "

The ID of a team to set as the parent team.

" } ], - "descriptionHTML": "

To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"

\n

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".

", + "descriptionHTML": "

To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"

\n

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".

", "codeExamples": [ { "request": { @@ -2771,7 +2771,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2780,7 +2780,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3718,7 +3718,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.

\n

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.

\n

If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.

\n

If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.

\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/{owner}/{repo}.

\n
", + "descriptionHTML": "

Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.

\n

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.

\n

If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.

\n

If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.

\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/{owner}/{repo}.

\n
", "codeExamples": [ { "request": { @@ -4551,7 +4551,7 @@ "description": "

The permission to grant the team on this repository. We accept the following permissions to be set: pull, triage, push, maintain, admin and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

" } ], - "descriptionHTML": "

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. 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.\"

\n

Note

\n

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

\n
\n

For more information about the permission levels, see \"Repository permission levels for an organization\".

", + "descriptionHTML": "

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. 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.\"

\n

Note

\n

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

\n
\n

For more information about the permission levels, see \"Repository permission levels for an organization\".

", "codeExamples": [ { "request": { @@ -4707,7 +4707,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4716,7 +4716,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5015,7 +5015,7 @@ } ], "bodyParameters": [], - "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 Get a team by name endpoint.

\n
", + "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 Get a team by name endpoint.

\n
", "codeExamples": [ { "request": { @@ -5623,7 +5623,7 @@ "description": "

The ID of a team to set as the parent 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 Update a team endpoint.

\n
\n

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

\n

Note

\n

\nWith nested teams, the privacy for parent teams cannot be secret.

\n
", + "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 Update a team endpoint.

\n
\n

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

\n

Note

\n

\nWith nested teams, the privacy for parent teams cannot be secret.

\n
", "codeExamples": [ { "request": { @@ -6729,7 +6729,7 @@ } ], "bodyParameters": [], - "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 team endpoint.

\n
\n

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.

", + "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 team endpoint.

\n
\n

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.

", "codeExamples": [ { "request": { @@ -6790,7 +6790,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6799,7 +6799,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6808,7 +6808,7 @@ } ], "bodyParameters": [], - "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 List team repositories endpoint.

\n
", + "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 List team repositories endpoint.

\n
", "codeExamples": [ { "request": { @@ -7731,7 +7731,7 @@ } ], "bodyParameters": [], - "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 Check team permissions for a repository endpoint.

\n
\n

Note

\n

\nRepositories inherited through a parent team will also be checked.

\n
\n

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:

", + "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 Check team permissions for a repository endpoint.

\n
\n

Note

\n

\nRepositories inherited through a parent team will also be checked.

\n
\n

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:

", "codeExamples": [ { "request": { @@ -8559,7 +8559,7 @@ ] } ], - "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 repository permissions\" endpoint.

\n
\n

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.

\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.\"

", + "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 repository permissions\" endpoint.

\n
\n

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.

\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.\"

", "codeExamples": [ { "request": { @@ -8646,7 +8646,7 @@ } ], "bodyParameters": [], - "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 Remove a repository from a team endpoint.

\n
\n

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the 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 Remove a repository from a team endpoint.

\n
\n

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.

", "codeExamples": [ { "request": { @@ -8703,7 +8703,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8712,7 +8712,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8721,7 +8721,7 @@ } ], "bodyParameters": [], - "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 List child teams endpoint.

\n
", + "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 List child teams endpoint.

\n
", "codeExamples": [ { "request": { @@ -9013,7 +9013,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9022,7 +9022,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9611,7 +9611,7 @@ }, { "name": "per_page", - "description": "

The number of results per page for the \"members\" array (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page for the \"members\" array (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9620,7 +9620,7 @@ }, { "name": "page", - "description": "

The page number of the \"members\" array results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the \"members\" array results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9629,7 +9629,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.

\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.

", + "descriptionHTML": "

Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.

\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.

", "codeExamples": [ { "request": { @@ -9790,7 +9790,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9815,7 +9815,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Cloud generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\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.

", + "descriptionHTML": "

Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Cloud generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\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.

", "codeExamples": [ { "request": { @@ -9925,7 +9925,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -10047,7 +10047,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a connection between a team and an external group. Only one external group can be linked to a team.

\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.

", + "descriptionHTML": "

Creates a connection between a team and an external group. Only one external group can be linked to a team.

\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.

", "codeExamples": [ { "request": { @@ -10225,7 +10225,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a connection between a team and an external group.

\n

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

", + "descriptionHTML": "

Deletes a connection between a team and an external group.

\n

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

", "codeExamples": [ { "request": { @@ -10294,7 +10294,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10303,7 +10303,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10608,7 +10608,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10617,7 +10617,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10835,7 +10835,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Team members will include the members of child teams.

\n

To get a user's membership with a team, the team must be 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}/memberships/{username}.

\n
\n

Note

\n

\nThe response contains the state of the membership and the member's role.

\n
\n

The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

", + "descriptionHTML": "

Team members will include the members of child teams.

\n

To get a user's membership with a team, the team must be 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}/memberships/{username}.

\n
\n

Note

\n

\nThe response contains the state of the membership and the member's role.

\n
\n

The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

", "codeExamples": [ { "request": { @@ -10962,7 +10962,7 @@ "default": "member" } ], - "descriptionHTML": "

Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a 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

An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person 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.

\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.

\n

Note

\n

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

\n
", + "descriptionHTML": "

Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a 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

An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person 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.

\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.

\n

Note

\n

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

\n
", "codeExamples": [ { "request": { @@ -11086,7 +11086,7 @@ } ], "bodyParameters": [], - "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
", + "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
", "codeExamples": [ { "request": { @@ -11145,7 +11145,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11154,7 +11154,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11163,7 +11163,7 @@ } ], "bodyParameters": [], - "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 List pending team invitations endpoint.

\n
\n

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.

", + "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 List pending team invitations endpoint.

\n
\n

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.

", "codeExamples": [ { "request": { @@ -11445,7 +11445,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11454,7 +11454,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11463,7 +11463,7 @@ } ], "bodyParameters": [], - "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 List team members endpoint.

\n
\n

Team members will include the members of child teams.

", + "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 List team members endpoint.

\n
\n

Team members will include the members of child teams.

", "codeExamples": [ { "request": { @@ -11666,7 +11666,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The \"Get team member\" endpoint (described below) is closing down.

\n

We recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.

\n

To list members in a team, the team must be visible to the authenticated user.

", + "descriptionHTML": "

The \"Get team member\" endpoint (described below) is closing down.

\n

We recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.

\n

To list members in a team, the team must be visible to the authenticated user.

", "codeExamples": [ { "request": { @@ -11733,7 +11733,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The \"Add team member\" endpoint (described below) is closing down.

\n

We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

\n

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

\n

To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

\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 that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

", + "descriptionHTML": "

The \"Add team member\" endpoint (described below) is closing down.

\n

We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

\n

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

\n

To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

\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 that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

", "codeExamples": [ { "request": { @@ -11808,7 +11808,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The \"Remove team member\" endpoint (described below) is closing down.

\n

We recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.

\n

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

\n

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

\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
", + "descriptionHTML": "

The \"Remove team member\" endpoint (described below) is closing down.

\n

We recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.

\n

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

\n

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

\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
", "codeExamples": [ { "request": { @@ -11875,7 +11875,7 @@ } ], "bodyParameters": [], - "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 Get team membership for a user endpoint.

\n
\n

Team members will include the members of child teams.

\n

To get a user's membership with a team, the team must be visible to the authenticated user.

\n

Note:\nThe response contains the state of the membership and the member's role.

\n

The role for organization owners is set to maintainer. For more information about maintainer roles, see Create 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 Get team membership for a user endpoint.

\n
\n

Team members will include the members of child teams.

\n

To get a user's membership with a team, the team must be visible to the authenticated user.

\n

Note:\nThe response contains the state of the membership and the member's role.

\n

The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

", "codeExamples": [ { "request": { @@ -11992,7 +11992,7 @@ "default": "member" } ], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -12110,7 +12110,7 @@ } ], "bodyParameters": [], - "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 Remove 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

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

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
", + "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 Remove 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

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

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
", "codeExamples": [ { "request": { @@ -12170,7 +12170,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -12316,7 +12316,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List IdP groups connected to a team on GitHub Enterprise Cloud.

\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

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

\n
", + "descriptionHTML": "

List IdP groups connected to a team on GitHub Enterprise Cloud.

\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

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

\n
", "codeExamples": [ { "request": { @@ -12468,7 +12468,7 @@ ] } ], - "descriptionHTML": "

Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a 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

\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.

\n
", + "descriptionHTML": "

Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a 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

\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.

\n
", "codeExamples": [ { "request": { @@ -12595,7 +12595,7 @@ } ], "bodyParameters": [], - "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 List IdP groups for a team 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

List IdP groups connected to a team on GitHub Enterprise Cloud.

", + "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 List IdP groups for a team 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

List IdP groups connected to a team on GitHub Enterprise Cloud.

", "codeExamples": [ { "request": { @@ -12762,7 +12762,7 @@ "description": "" } ], - "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 Create or update IdP group connections 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

Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for 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 Create or update IdP group connections 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

Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/users.json b/src/rest/data/ghec-2022-11-28/users.json index cfe4b30e65ef..f00440d518d0 100644 --- a/src/rest/data/ghec-2022-11-28/users.json +++ b/src/rest/data/ghec-2022-11-28/users.json @@ -1483,7 +1483,7 @@ } ], "bodyParameters": [], - "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

If you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Cloud 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 Cloud. 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.

", + "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

If you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Cloud 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 Cloud. 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.

", "codeExamples": [ { "request": { @@ -2559,7 +2559,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2568,7 +2568,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all users, in the order that they signed up on GitHub Enterprise Cloud. 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.

", + "descriptionHTML": "

Lists all users, in the order that they signed up on GitHub Enterprise Cloud. 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.

", "codeExamples": [ { "request": { @@ -2757,7 +2757,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

If you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Cloud 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 Cloud. 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.

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

If you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Cloud 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 Cloud. 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.

", "codeExamples": [ { "request": { @@ -3944,7 +3944,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3953,7 +3953,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3962,7 +3962,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3992,7 +3992,7 @@ "description": "

Optional filter for fetching attestations with a given predicate type.\nThis option accepts provenance, sbom, release, or freeform text\nfor custom predicate types.

" } ], - "descriptionHTML": "

List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", + "descriptionHTML": "

List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", "codeExamples": [ { "request": { @@ -4463,7 +4463,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4472,7 +4472,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -4481,7 +4481,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -4517,7 +4517,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", + "descriptionHTML": "

List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", "codeExamples": [ { "request": { @@ -4742,7 +4742,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4751,7 +4751,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5283,7 +5283,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5292,7 +5292,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5601,7 +5601,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5610,7 +5610,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5619,7 +5619,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists your publicly visible email address, which you can set with the\nSet primary email visibility for the authenticated user\nendpoint.

\n

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

", + "descriptionHTML": "

Lists your publicly visible email address, which you can set with the\nSet primary email visibility for the authenticated user\nendpoint.

\n

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

", "codeExamples": [ { "request": { @@ -5720,7 +5720,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5729,7 +5729,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5928,7 +5928,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5937,7 +5937,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6214,7 +6214,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

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

", + "descriptionHTML": "

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

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

", "codeExamples": [ { "request": { @@ -6356,7 +6356,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6365,7 +6365,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6562,7 +6562,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6571,7 +6571,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6826,7 +6826,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6835,7 +6835,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7728,7 +7728,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7737,7 +7737,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7992,7 +7992,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8001,7 +8001,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8473,7 +8473,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8482,7 +8482,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8577,7 +8577,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8586,7 +8586,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8860,7 +8860,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8869,7 +8869,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8949,7 +8949,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8958,7 +8958,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9075,7 +9075,7 @@ { "type": "string", "name": "key", - "description": "

The public SSH key to add to your GitHub account. For more information, see \"Checking for existing SSH keys.\"

", + "description": "

The public SSH key to add to your GitHub account. For more information, see \"Checking for existing SSH keys.\"

", "isRequired": true } ], @@ -9358,7 +9358,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9367,7 +9367,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/actions.json b/src/rest/data/ghec-2026-03-10/actions.json index 17b8c87d71bb..6a4ce16cddd0 100644 --- a/src/rest/data/ghec-2026-03-10/actions.json +++ b/src/rest/data/ghec-2026-03-10/actions.json @@ -28,7 +28,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -37,7 +37,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -632,7 +632,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -641,7 +641,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1645,7 +1645,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1654,7 +1654,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2216,7 +2216,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2225,7 +2225,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2616,7 +2616,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2625,7 +2625,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5110,7 +5110,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5119,7 +5119,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9296,7 +9296,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9305,7 +9305,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9931,7 +9931,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

\n

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

", + "descriptionHTML": "

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

\n

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

", "codeExamples": [ { "request": { @@ -10021,7 +10021,7 @@ "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

" } ], - "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"

\n

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

", + "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an enterprise, and sets\nwhether GitHub Actions can submit approving pull request reviews. For more information, see\n\"Enforcing a policy for workflow permissions in your enterprise.\"

\n

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

", "codeExamples": [ { "request": { @@ -10766,7 +10766,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10775,7 +10775,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -12169,7 +12169,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -12178,7 +12178,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13289,7 +13289,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -13383,7 +13383,7 @@ "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

" } ], - "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

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

", + "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in an organization, and sets if GitHub Actions\ncan submit approving pull request reviews. For more information, see\n\"Setting the permissions of the GITHUB_TOKEN for your organization.\"

\n

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

", "codeExamples": [ { "request": { @@ -13644,7 +13644,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

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

", + "descriptionHTML": "

Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

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

", "codeExamples": [ { "request": { @@ -13742,7 +13742,7 @@ ] } ], - "descriptionHTML": "

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

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

", + "descriptionHTML": "

Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal and private repositories.\nFor more information, see \"Allowing access to components in a private repository\" and\n\"Allowing access to components in an internal repository.\"

\n

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

", "codeExamples": [ { "request": { @@ -14540,7 +14540,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

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

", + "descriptionHTML": "

Gets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository,\nas well as if GitHub Actions can submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

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

", "codeExamples": [ { "request": { @@ -14644,7 +14644,7 @@ "description": "

Whether GitHub Actions can approve pull requests. Enabling this can be a security risk.

" } ], - "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

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

", + "descriptionHTML": "

Sets the default workflow permissions granted to the GITHUB_TOKEN when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"Setting the permissions of the GITHUB_TOKEN for your repository.\"

\n

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

", "codeExamples": [ { "request": { @@ -14709,7 +14709,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14718,7 +14718,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15068,7 +15068,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", "isRequired": true }, { @@ -15091,10 +15091,10 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users 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.

", + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

Authenticated users 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.

", "codeExamples": [ { "request": { @@ -15267,7 +15267,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15276,7 +15276,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16159,11 +16159,11 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Add selected repository to an organization secret and Remove selected repository from an organization secret endpoints.

", + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Add selected repository to an organization secret and Remove selected repository from an organization secret endpoints.

", "isRequired": true } ], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\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.

", + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\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.

", "codeExamples": [ { "request": { @@ -16241,7 +16241,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. For more information about setting the visibility, see Create or\nupdate an organization secret.

\n

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

\n

OAuth tokens and personal access tokens (classic) need the admin: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.

", + "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. For more information about setting the visibility, see Create or\nupdate an organization secret.

\n

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

\n

OAuth tokens and personal access tokens (classic) need the admin: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.

", "codeExamples": [ { "request": { @@ -16319,7 +16319,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\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.

", + "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\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.

", "codeExamples": [ { "request": { @@ -16388,7 +16388,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16397,7 +16397,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16524,7 +16524,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16533,7 +16533,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16874,7 +16874,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", "isRequired": true }, { @@ -16884,7 +16884,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

\n

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

", + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

\n

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

", "codeExamples": [ { "request": { @@ -17068,7 +17068,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -17077,7 +17077,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -17448,7 +17448,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

", "isRequired": true }, { @@ -17458,7 +17458,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

\n

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

", + "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

\n

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

", "codeExamples": [ { "request": { @@ -17638,7 +17638,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -17647,7 +17647,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18399,7 +18399,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18408,7 +18408,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18785,7 +18785,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18794,7 +18794,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -19210,7 +19210,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -19219,7 +19219,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20032,7 +20032,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20041,7 +20041,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20343,7 +20343,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20352,7 +20352,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21629,7 +21629,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21638,7 +21638,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -22080,7 +22080,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -22089,7 +22089,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25062,7 +25062,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25071,7 +25071,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28101,7 +28101,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28110,7 +28110,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31236,7 +31236,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31245,7 +31245,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31784,7 +31784,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31793,7 +31793,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -32913,7 +32913,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -32922,7 +32922,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -33057,7 +33057,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -33066,7 +33066,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -33572,7 +33572,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 30). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -33581,7 +33581,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -34614,7 +34614,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -34623,7 +34623,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -34632,7 +34632,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists jobs for a specific workflow run attempt. 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.

", + "descriptionHTML": "

Lists jobs for a specific workflow run attempt. 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.

", "codeExamples": [ { "request": { @@ -35072,7 +35072,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35081,7 +35081,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35090,7 +35090,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -35617,7 +35617,7 @@ }, { "name": "event", - "description": "

Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

", + "description": "

Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

", "in": "query", "required": false, "schema": { @@ -35651,7 +35651,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35660,7 +35660,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35669,7 +35669,7 @@ }, { "name": "created", - "description": "

Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"

", + "description": "

Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"

", "in": "query", "required": false, "schema": { @@ -35706,7 +35706,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -40761,7 +40761,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -43382,7 +43382,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -45055,7 +45055,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n


\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.

\n
\n

Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\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.

", + "descriptionHTML": "

Warning

\n


\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.

\n
\n

Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\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.

", "codeExamples": [ { "request": { @@ -45323,7 +45323,7 @@ }, { "name": "event", - "description": "

Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

", + "description": "

Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

", "in": "query", "required": false, "schema": { @@ -45357,7 +45357,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -45366,7 +45366,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -45375,7 +45375,7 @@ }, { "name": "created", - "description": "

Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"

", + "description": "

Returns workflow runs created within the given date-time range. For more information on the syntax, see \"Understanding the search syntax.\"

", "in": "query", "required": false, "schema": { @@ -45412,7 +45412,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. 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.

", + "descriptionHTML": "

List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. 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.

", "codeExamples": [ { "request": { @@ -47749,7 +47749,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -47758,7 +47758,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -48403,7 +48403,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n


\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.

\n
\n

Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\n

You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\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.

", + "descriptionHTML": "

Warning

\n


\nThis endpoint is in the process of closing down. Refer to \"Actions Get workflow usage and Get workflow run usage endpoints closing down\" for more information.

\n
\n

Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\n

You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\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.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/activity.json b/src/rest/data/ghec-2026-03-10/activity.json index a7169288d841..6d72778497a6 100644 --- a/src/rest/data/ghec-2026-03-10/activity.json +++ b/src/rest/data/ghec-2026-03-10/activity.json @@ -10,7 +10,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -19,7 +19,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9727,7 +9727,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9736,7 +9736,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -19443,7 +19443,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -19452,7 +19452,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -29165,7 +29165,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -29174,7 +29174,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -38869,7 +38869,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -38878,7 +38878,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -48577,7 +48577,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -48586,7 +48586,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -58299,7 +58299,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -58308,7 +58308,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -67998,7 +67998,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -68007,7 +68007,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -77702,7 +77702,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -77711,7 +77711,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -87398,7 +87398,7 @@ "subcategory": "feeds", "parameters": [], "bodyParameters": [], - "descriptionHTML": "

Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

\n
    \n
  • Timeline: The GitHub Enterprise Cloud global public timeline
  • \n
  • User: The public timeline for any user, using uri_template. For more information, see \"Hypermedia.\"
  • \n
  • Current user public: The public timeline for the authenticated user
  • \n
  • Current user: The private timeline for the authenticated user
  • \n
  • Current user actor: The private timeline for activity created by the authenticated user
  • \n
  • Current user organizations: The private timeline for the organizations the authenticated user is a member of.
  • \n
  • Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.
  • \n
\n

By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"

\n

Note

\n

\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

\n
", + "descriptionHTML": "

Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.

\n
    \n
  • Timeline: The GitHub Enterprise Cloud global public timeline
  • \n
  • User: The public timeline for any user, using uri_template. For more information, see \"Hypermedia.\"
  • \n
  • Current user public: The public timeline for the authenticated user
  • \n
  • Current user: The private timeline for the authenticated user
  • \n
  • Current user actor: The private timeline for activity created by the authenticated user
  • \n
  • Current user organizations: The private timeline for the organizations the authenticated user is a member of.
  • \n
  • Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud.
  • \n
\n

By default, timeline resources are returned in JSON. You can specify the application/atom+xml type in the Accept header to return timeline resources in Atom format. For more information, see \"Media types.\"

\n

Note

\n

\nPrivate feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

\n
", "codeExamples": [ { "request": { @@ -87757,7 +87757,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -87766,7 +87766,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 50). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 50). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -88711,7 +88711,7 @@ "description": "

Whether the notification has been read.

" } ], - "descriptionHTML": "

Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the List notifications for the authenticated user endpoint and pass the query parameter all=false.

", + "descriptionHTML": "

Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the List notifications for the authenticated user endpoint and pass the query parameter all=false.

", "codeExamples": [ { "request": { @@ -88781,7 +88781,7 @@ "parameters": [ { "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", + "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", "in": "path", "required": true, "schema": { @@ -89710,7 +89710,7 @@ "parameters": [ { "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", + "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", "in": "path", "required": true, "schema": { @@ -89767,7 +89767,7 @@ "parameters": [ { "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", + "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", "in": "path", "required": true, "schema": { @@ -89816,7 +89816,7 @@ "parameters": [ { "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", + "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", "in": "path", "required": true, "schema": { @@ -89825,7 +89825,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

\n

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were @mentioned, or manually subscribe to a thread.

", + "descriptionHTML": "

This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

\n

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were @mentioned, or manually subscribe to a thread.

", "codeExamples": [ { "request": { @@ -89931,7 +89931,7 @@ "parameters": [ { "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", + "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", "in": "path", "required": true, "schema": { @@ -89947,7 +89947,7 @@ "default": false } ], - "descriptionHTML": "

If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an @mention.

\n

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

\n

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.

", + "descriptionHTML": "

If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an @mention.

\n

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

\n

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.

", "codeExamples": [ { "request": { @@ -90057,7 +90057,7 @@ "parameters": [ { "name": "thread_id", - "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", + "description": "

The unique identifier of the notification thread. This corresponds to the value returned in the id field when you retrieve notifications (for example with the GET /notifications operation).

", "in": "path", "required": true, "schema": { @@ -90066,7 +90066,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Mutes all future notifications for a conversation until you comment on the thread or get an @mention. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the Set a thread subscription endpoint and set ignore to true.

", + "descriptionHTML": "

Mutes all future notifications for a conversation until you comment on the thread or get an @mention. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the Set a thread subscription endpoint and set ignore to true.

", "codeExamples": [ { "request": { @@ -90176,7 +90176,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -90185,7 +90185,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -91132,7 +91132,7 @@ "description": "

Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

" } ], - "descriptionHTML": "

Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the List repository notifications for the authenticated user endpoint and pass the query parameter all=false.

", + "descriptionHTML": "

Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub Enterprise Cloud will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the List repository notifications for the authenticated user endpoint and pass the query parameter all=false.

", "codeExamples": [ { "request": { @@ -91216,7 +91216,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -91225,7 +91225,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -91234,7 +91234,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the people that have starred the repository.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
  • \n
", + "descriptionHTML": "

Lists the people that have starred the repository.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
  • \n
", "codeExamples": [ { "request": { @@ -91883,7 +91883,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -91892,7 +91892,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -91901,7 +91901,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
  • \n
", + "descriptionHTML": "

Lists repositories the authenticated user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
  • \n
", "codeExamples": [ { "request": { @@ -93661,7 +93661,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "codeExamples": [ { "request": { @@ -93840,7 +93840,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -93849,7 +93849,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -93858,7 +93858,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists repositories a user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
  • \n
", + "descriptionHTML": "

Lists repositories a user has starred.

\n

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

\n
    \n
  • application/vnd.github.star+json: Includes a timestamp of when the star was created.
  • \n
", "codeExamples": [ { "request": { @@ -95396,7 +95396,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -95405,7 +95405,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -95743,7 +95743,7 @@ "description": "

Determines if all notifications should be blocked from this repository.

" } ], - "descriptionHTML": "

If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository's subscription completely.

", + "descriptionHTML": "

If you would like to watch a repository, set subscribed to true. If you would like to ignore notifications made within a repository, set ignored to true. If you would like to stop watching a repository, delete the repository's subscription completely.

", "codeExamples": [ { "request": { @@ -95857,7 +95857,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.

", + "descriptionHTML": "

This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, set the repository's subscription manually.

", "codeExamples": [ { "request": { @@ -95898,7 +95898,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -95907,7 +95907,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -96824,7 +96824,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -96833,7 +96833,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/announcement-banners.json b/src/rest/data/ghec-2026-03-10/announcement-banners.json index ace3bb7dd4a2..3cc624155a9a 100644 --- a/src/rest/data/ghec-2026-03-10/announcement-banners.json +++ b/src/rest/data/ghec-2026-03-10/announcement-banners.json @@ -48,7 +48,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ @@ -112,7 +112,7 @@ { "type": "string or null", "name": "announcement", - "description": "

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

", + "description": "

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

", "isRequired": true }, { @@ -162,7 +162,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ @@ -303,7 +303,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ @@ -371,7 +371,7 @@ { "type": "string or null", "name": "announcement", - "description": "

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

", + "description": "

The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"Basic writing and formatting syntax.\"

", "isRequired": true }, { @@ -421,7 +421,7 @@ "string", "null" ], - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest//github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" + "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-cloud@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"" }, "expires_at": { "type": [ diff --git a/src/rest/data/ghec-2026-03-10/apps.json b/src/rest/data/ghec-2026-03-10/apps.json index de5e23220ac5..145a1d43e854 100644 --- a/src/rest/data/ghec-2026-03-10/apps.json +++ b/src/rest/data/ghec-2026-03-10/apps.json @@ -9,7 +9,7 @@ "subcategory": "apps", "parameters": [], "bodyParameters": [], - "descriptionHTML": "

Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the installations_count in the response. For more details about your app's installations, see the \"List installations for the authenticated app\" endpoint.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -380,7 +380,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App's id, pem (private key), and webhook_secret.

", + "descriptionHTML": "

Use this endpoint to complete the handshake necessary when implementing the GitHub App Manifest flow. When you create a GitHub App with the manifest flow, you receive a temporary code used to retrieve the GitHub App's id, pem (private key), and webhook_secret.

", "codeExamples": [ { "request": { @@ -787,7 +787,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -796,7 +796,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1219,7 +1219,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1228,7 +1228,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1256,7 +1256,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The permissions the installation has are included under the permissions key.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

The permissions the installation has are included under the permissions key.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -2226,7 +2226,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

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

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -3198,7 +3198,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"Suspend an app installation\" endpoint.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -3772,7 +3772,7 @@ ] } ], - "descriptionHTML": "

Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an enterprise, organization, or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.

\n

Optionally, you can use the repositories or repository_ids body parameters to specify individual repositories that the installation access token can access. If you don't use repositories or repository_ids to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.

\n

Optionally, use the permissions body parameter to specify the permissions that the installation access token should have. If permissions is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.

\n

Enterprise account installations do not have access to repositories and cannot be scoped down using the permissions parameter.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an enterprise, organization, or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of 401 - Unauthorized, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.

\n

Optionally, you can use the repositories or repository_ids body parameters to specify individual repositories that the installation access token can access. If you don't use repositories or repository_ids to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.

\n

Optionally, use the permissions body parameter to specify the permissions that the installation access token should have. If permissions is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.

\n

Enterprise account installations do not have access to repositories and cannot be scoped down using the permissions parameter.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -5136,7 +5136,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -5189,7 +5189,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes a GitHub App installation suspension.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Removes a GitHub App installation suspension.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -7150,7 +7150,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find its installation on a particular enterprise.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Enables an authenticated GitHub App to find its installation on a particular enterprise.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -8119,7 +8119,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

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

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -9097,7 +9097,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -10075,7 +10075,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find the user’s installation information.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Enables an authenticated GitHub App to find the user’s installation information.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -11037,7 +11037,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11046,7 +11046,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11913,7 +11913,7 @@ "subcategory": "installations", "parameters": [], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -11953,7 +11953,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11962,7 +11962,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13020,7 +13020,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13029,7 +13029,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14064,7 +14064,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "codeExamples": [ { "request": { @@ -14411,7 +14411,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14420,7 +14420,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14429,7 +14429,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "codeExamples": [ { "request": { @@ -14608,7 +14608,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14617,7 +14617,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14626,7 +14626,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "codeExamples": [ { "request": { @@ -14990,7 +14990,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "codeExamples": [ { "request": { @@ -15337,7 +15337,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15346,7 +15346,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15355,7 +15355,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "codeExamples": [ { "request": { @@ -15530,7 +15530,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15539,7 +15539,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15548,7 +15548,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", + "descriptionHTML": "

Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.

\n

GitHub Apps must use a JWT to access this endpoint. OAuth apps must use basic authentication with their client ID and client secret to access this endpoint.

", "codeExamples": [ { "request": { @@ -15895,7 +15895,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15904,7 +15904,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16170,7 +16170,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16179,7 +16179,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18472,7 +18472,7 @@ "subcategory": "webhooks", "parameters": [], "bodyParameters": [], - "descriptionHTML": "

Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -18505,7 +18505,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -18559,7 +18559,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -18567,7 +18567,7 @@ "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" } ], - "descriptionHTML": "

Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"Creating a GitHub App.\"

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -18607,7 +18607,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -18649,7 +18649,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18680,7 +18680,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns a list of webhook deliveries for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Returns a list of webhook deliveries for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -18853,7 +18853,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns a delivery for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Returns a delivery for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { @@ -19093,7 +19093,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Redeliver a delivery for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", + "descriptionHTML": "

Redeliver a delivery for the webhook configured for a GitHub App.

\n

You must use a JWT to access this endpoint.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/billing.json b/src/rest/data/ghec-2026-03-10/billing.json index 69df9c7b6a9c..e5ec4cf73e5c 100644 --- a/src/rest/data/ghec-2026-03-10/billing.json +++ b/src/rest/data/ghec-2026-03-10/billing.json @@ -32,7 +32,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -41,7 +41,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1510,7 +1510,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1519,7 +1519,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2543,7 +2543,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.

\n

Note: This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"About the enhanced billing platform for enterprises.\"

", + "descriptionHTML": "

Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.

\n

Note: This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see \"About the enhanced billing platform for enterprises.\"

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/branches.json b/src/rest/data/ghec-2026-03-10/branches.json index 69165d31f32a..62ce1c6f4aa2 100644 --- a/src/rest/data/ghec-2026-03-10/branches.json +++ b/src/rest/data/ghec-2026-03-10/branches.json @@ -37,7 +37,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -46,7 +46,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2054,7 +2054,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -4673,7 +4673,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -4689,7 +4689,7 @@ "isRequired": true } ], - "descriptionHTML": "

Renames a branch in a repository.

\n

Note

\n

\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n
\n

The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.

\n

In order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.

", + "descriptionHTML": "

Renames a branch in a repository.

\n

Note

\n

\nAlthough the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see \"Renaming a branch\".

\n
\n

The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions.

\n

In order to rename the default branch, fine-grained access tokens also need the administration:write repository permission.

", "codeExamples": [ { "request": { @@ -8138,7 +8138,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -8147,7 +8147,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -10288,7 +10288,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -10377,7 +10377,7 @@ { "type": "boolean", "name": "require_code_owner_reviews", - "description": "

Blocks merging pull requests until code owners review them.

" + "description": "

Blocks merging pull requests until code owners review them.

" }, { "type": "integer", @@ -10442,17 +10442,17 @@ { "type": "boolean", "name": "required_linear_history", - "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" + "description": "

Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see \"Requiring a linear commit history\" in the GitHub Help documentation.

" }, { "type": "boolean or null", "name": "allow_force_pushes", - "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" + "description": "

Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.\"

" }, { "type": "boolean", "name": "allow_deletions", - "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" + "description": "

Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see \"Enabling force pushes to a protected branch\" in the GitHub Help documentation.

" }, { "type": "boolean", @@ -10477,7 +10477,7 @@ "default": false } ], - "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

Protecting a branch requires admin or owner permissions to the repository.

\n

Note

\n

\nPassing new arrays of users and teams replaces their previous values.

\n
\n

Note

\n

\nThe list of users, apps, and teams in total is limited to 100 items.

\n
", + "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

Protecting a branch requires admin or owner permissions to the repository.

\n

Note

\n

\nPassing new arrays of users and teams replaces their previous values.

\n
\n

Note

\n

\nThe list of users, apps, and teams in total is limited to 100 items.

\n
", "codeExamples": [ { "request": { @@ -12560,7 +12560,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -12569,7 +12569,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -12637,7 +12637,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -12646,7 +12646,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -12733,7 +12733,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -12742,7 +12742,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -12829,7 +12829,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -12838,7 +12838,7 @@ } ], "bodyParameters": [], - "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

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

", + "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

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

", "codeExamples": [ { "request": { @@ -12906,7 +12906,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -12915,7 +12915,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -14333,7 +14333,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -14372,7 +14372,7 @@ { "type": "boolean", "name": "require_code_owner_reviews", - "description": "

Blocks merging pull requests until code owners have reviewed.

" + "description": "

Blocks merging pull requests until code owners have reviewed.

" }, { "type": "integer", @@ -14408,7 +14408,7 @@ ] } ], - "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

Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

\n

Note

\n

\nPassing new arrays of users and teams replaces their previous values.

\n
", + "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

Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.

\n

Note

\n

\nPassing new arrays of users and teams replaces their previous values.

\n
", "codeExamples": [ { "request": { @@ -15859,7 +15859,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -15868,7 +15868,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -15936,7 +15936,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -15945,7 +15945,7 @@ } ], "bodyParameters": [], - "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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.

\n

Note

\n

\nYou must enable branch protection to require signed commits.

\n
", + "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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of true indicates you must sign commits on this branch. For more information, see Signing commits with GPG in GitHub Help.

\n

Note

\n

\nYou must enable branch protection to require signed commits.

\n
", "codeExamples": [ { "request": { @@ -16036,7 +16036,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16045,7 +16045,7 @@ } ], "bodyParameters": [], - "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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.

", + "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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.

", "codeExamples": [ { "request": { @@ -16136,7 +16136,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16145,7 +16145,7 @@ } ], "bodyParameters": [], - "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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.

", + "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

When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.

", "codeExamples": [ { "request": { @@ -16213,7 +16213,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16222,7 +16222,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -16351,7 +16351,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16389,7 +16389,7 @@ ] } ], - "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

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", + "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

Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.

", "codeExamples": [ { "request": { @@ -16529,7 +16529,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16538,7 +16538,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -16602,7 +16602,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16611,7 +16611,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -16689,7 +16689,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16705,7 +16705,7 @@ "isRequired": true } ], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -16799,7 +16799,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16815,7 +16815,7 @@ "isRequired": true } ], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -16903,7 +16903,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -16919,7 +16919,7 @@ "isRequired": true } ], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -17007,7 +17007,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -17016,7 +17016,7 @@ } ], "bodyParameters": [], - "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

Lists who has access to this protected branch.

\n

Note

\n

\nUsers, apps, and teams restrictions are only available for organization-owned repositories.

\n
", + "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

Lists who has access to this protected branch.

\n

Note

\n

\nUsers, apps, and teams restrictions are only available for organization-owned repositories.

\n
", "codeExamples": [ { "request": { @@ -17608,7 +17608,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -17617,7 +17617,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -17681,7 +17681,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -17690,7 +17690,7 @@ } ], "bodyParameters": [], - "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

Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", + "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

Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", "codeExamples": [ { "request": { @@ -18087,7 +18087,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -18103,7 +18103,7 @@ "isRequired": true } ], - "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

Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", + "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

Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", "codeExamples": [ { "request": { @@ -18506,7 +18506,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -18522,7 +18522,7 @@ "isRequired": true } ], - "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

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", + "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

Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", "codeExamples": [ { "request": { @@ -18925,7 +18925,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -18941,7 +18941,7 @@ "isRequired": true } ], - "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

Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", + "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

Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch.

", "codeExamples": [ { "request": { @@ -19344,7 +19344,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -19353,7 +19353,7 @@ } ], "bodyParameters": [], - "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

Lists the teams who have push access to this branch. The list includes child teams.

", + "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

Lists the teams who have push access to this branch. The list includes child teams.

", "codeExamples": [ { "request": { @@ -19644,7 +19644,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -19660,7 +19660,7 @@ "isRequired": true } ], - "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

Grants the specified teams push access for this branch. You can also give push access to child teams.

", + "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

Grants the specified teams push access for this branch. You can also give push access to child teams.

", "codeExamples": [ { "request": { @@ -19957,7 +19957,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -19973,7 +19973,7 @@ "isRequired": true } ], - "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

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

", + "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

Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.

", "codeExamples": [ { "request": { @@ -20270,7 +20270,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -20286,7 +20286,7 @@ "isRequired": true } ], - "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

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

", + "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

Removes the ability of a team to push to this branch. You can also remove push access for child teams.

", "codeExamples": [ { "request": { @@ -20583,7 +20583,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -20592,7 +20592,7 @@ } ], "bodyParameters": [], - "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

Lists the people who have push access to this branch.

", + "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

Lists the people who have push access to this branch.

", "codeExamples": [ { "request": { @@ -20797,7 +20797,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -20813,7 +20813,7 @@ "isRequired": true } ], - "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

Grants the specified people push access for this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "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

Grants the specified people push access for this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", "codeExamples": [ { "request": { @@ -21024,7 +21024,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -21040,7 +21040,7 @@ "isRequired": true } ], - "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

Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "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

Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames for people who can have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", "codeExamples": [ { "request": { @@ -21251,7 +21251,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -21267,7 +21267,7 @@ "isRequired": true } ], - "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

Removes the ability of a user to push to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", + "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

Removes the ability of a user to push to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
arrayUsernames of the people who should no longer have push access. Note: The list of users, apps, and teams in total is limited to 100 items.
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/campaigns.json b/src/rest/data/ghec-2026-03-10/campaigns.json index ecf12ee39d1d..50c882aef47c 100644 --- a/src/rest/data/ghec-2026-03-10/campaigns.json +++ b/src/rest/data/ghec-2026-03-10/campaigns.json @@ -19,7 +19,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/checks.json b/src/rest/data/ghec-2026-03-10/checks.json index c87d544213cd..94df3e667316 100644 --- a/src/rest/data/ghec-2026-03-10/checks.json +++ b/src/rest/data/ghec-2026-03-10/checks.json @@ -3317,7 +3317,7 @@ { "type": "array of objects", "name": "annotations", - "description": "

Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"About status checks\".

", + "description": "

Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see \"About status checks\".

", "childParamsGroups": [ { "type": "string", @@ -3405,7 +3405,7 @@ { "type": "array of objects", "name": "actions", - "description": "

Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", + "description": "

Possible further actions the integrator can perform, which a user may trigger. Each action includes a label, identifier and description. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"

", "childParamsGroups": [ { "type": "string", @@ -4534,7 +4534,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4543,7 +4543,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4711,7 +4711,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, the status of the check suite it belongs to is reset to queued and the conclusion is cleared. The check run itself is not updated. GitHub apps recieving the check_run webhook with the rerequested action should then decide if the check run should be reset or updated and call the update check_run endpoint to update the check_run if desired.

\n

For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".

", + "descriptionHTML": "

Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the check_run webhook event with the action rerequested. When a check run is rerequested, the status of the check suite it belongs to is reset to queued and the conclusion is cleared. The check run itself is not updated. GitHub apps recieving the check_run webhook with the rerequested action should then decide if the check run should be reset or updated and call the update check_run endpoint to update the check_run if desired.

\n

For more information about how to re-run GitHub Actions jobs, see \"Re-run a job from a workflow run\".

", "codeExamples": [ { "request": { @@ -4842,7 +4842,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4851,7 +4851,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5985,7 +5985,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5994,7 +5994,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6012,7 +6012,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.

\n

Note

\n

\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
\n

If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the List check suites for a Git reference endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.

\n

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

", + "descriptionHTML": "

Lists check runs for a commit ref. The ref can be a SHA, branch name, or a tag name.

\n

Note

\n

\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n
\n

If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the List check suites for a Git reference endpoint and provide the check_suite_id parameter to the List check runs in a check suite endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -7100,7 +7100,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".

\n

Note

\n

\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

", + "descriptionHTML": "

Creates a check suite manually. By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\".

\n

Note

\n

\nThe Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
\n

OAuth apps and personal access tokens (classic) cannot use this endpoint.

", "codeExamples": [ { "request": { @@ -10422,7 +10422,7 @@ ] } ], - "descriptionHTML": "

Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite.\nYou must have admin permissions in the repository to set preferences for check suites.

", + "descriptionHTML": "

Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite.\nYou must have admin permissions in the repository to set preferences for check suites.

", "codeExamples": [ { "request": { @@ -13175,7 +13175,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

", + "descriptionHTML": "

Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

", "codeExamples": [ { "request": { @@ -13275,7 +13275,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13284,7 +13284,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/classroom.json b/src/rest/data/ghec-2026-03-10/classroom.json index 77d6d779a279..c3ab5b51a51d 100644 --- a/src/rest/data/ghec-2026-03-10/classroom.json +++ b/src/rest/data/ghec-2026-03-10/classroom.json @@ -325,7 +325,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -334,7 +334,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -829,7 +829,7 @@ "parameters": [ { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -838,7 +838,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1071,7 +1071,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1080,7 +1080,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/code-scanning.json b/src/rest/data/ghec-2026-03-10/code-scanning.json index 77d1a20ca2db..14eecd6ebe3a 100644 --- a/src/rest/data/ghec-2026-03-10/code-scanning.json +++ b/src/rest/data/ghec-2026-03-10/code-scanning.json @@ -42,7 +42,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -51,7 +51,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -60,7 +60,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -69,7 +69,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -131,7 +131,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. 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 a member of the enterprise to use this endpoint.

\n

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

", + "descriptionHTML": "

Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. 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 a member of the enterprise to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -1476,7 +1476,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1485,7 +1485,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1494,7 +1494,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1503,7 +1503,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1584,7 +1584,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -2942,7 +2942,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2951,7 +2951,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2993,7 +2993,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3002,7 +3002,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -6040,7 +6040,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6049,7 +6049,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6310,7 +6310,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6319,7 +6319,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6624,7 +6624,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified code scanning analysis for a repository.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

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

\n
    \n
  • application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.
  • \n
\n

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

", + "descriptionHTML": "

Gets a specified code scanning analysis for a repository.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

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

\n
    \n
  • application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -7358,7 +7358,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a CodeQL database for a language in a repository.

\n

By default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the Accept header of the request\nto application/zip, and make sure\nyour HTTP client is configured to follow redirects or use the Location header\nto make a second request to get the redirect URL.

\n

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

", + "descriptionHTML": "

Gets a CodeQL database for a language in a repository.

\n

By default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the Accept header of the request\nto application/zip, and make sure\nyour HTTP client is configured to follow redirects or use the Location header\nto make a second request to get the redirect URL.

\n

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

", "codeExamples": [ { "request": { @@ -7727,7 +7727,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.

\n

Get started by learning more about running CodeQL queries at scale with Multi-Repository Variant Analysis.

\n

Use the owner and repo parameters in the URL to specify the controller repository that\nwill be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.

\n

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

", + "descriptionHTML": "

Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.

\n

Get started by learning more about running CodeQL queries at scale with Multi-Repository Variant Analysis.

\n

Use the owner and repo parameters in the URL to specify the controller repository that\nwill be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.

\n

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

", "codeExamples": [ { "request": { @@ -12919,7 +12919,7 @@ { "type": "string", "name": "sarif", - "description": "

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

", + "description": "

A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

", "isRequired": true }, { @@ -12943,7 +12943,7 @@ "description": "

Whether the SARIF file will be validated according to the code scanning specifications.\nThis parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.

" } ], - "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n

SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file20
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Tool extensions per run100
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
Tags per rule20Only 10 tags will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

\n

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

\n

This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.

", + "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"

\n

There are two places where you can upload code scanning results.

\n\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64 -w0\n
\n

SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
SARIF dataMaximum valuesAdditional limits
Runs per file20
Results per run25,000Only the top 5,000 results will be included, prioritized by severity.
Rules per run25,000
Tool extensions per run100
Thread Flow Locations per result10,000Only the top 1,000 Thread Flow Locations will be included, using prioritization.
Location per result1,000Only 100 locations will be included.
Tags per rule20Only 10 tags will be included.
\n

The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

\n

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

\n

This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.

", "codeExamples": [ { "request": { @@ -13228,7 +13228,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13237,7 +13237,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13654,7 +13654,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13663,7 +13663,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/code-security.json b/src/rest/data/ghec-2026-03-10/code-security.json index 01e00fe33a9b..a368c04b2211 100644 --- a/src/rest/data/ghec-2026-03-10/code-security.json +++ b/src/rest/data/ghec-2026-03-10/code-security.json @@ -20,7 +20,7 @@ { "name": "per_page", "in": "query", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "required": false, "schema": { "type": "integer", @@ -29,7 +29,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -38,7 +38,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3301,7 +3301,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3311,7 +3311,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3320,7 +3320,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3877,7 +3877,7 @@ { "name": "per_page", "in": "query", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "required": false, "schema": { "type": "integer", @@ -3886,7 +3886,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3895,7 +3895,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7414,7 +7414,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7424,7 +7424,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7433,7 +7433,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { diff --git a/src/rest/data/ghec-2026-03-10/codespaces.json b/src/rest/data/ghec-2026-03-10/codespaces.json index 45570f73e88e..1e7e595b3187 100644 --- a/src/rest/data/ghec-2026-03-10/codespaces.json +++ b/src/rest/data/ghec-2026-03-10/codespaces.json @@ -10,7 +10,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -19,7 +19,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4636,7 +4636,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4645,7 +4645,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8145,7 +8145,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8154,7 +8154,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -23658,7 +23658,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -23667,7 +23667,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24015,7 +24015,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

The value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" + "description": "

The value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" }, { "type": "string", @@ -24036,10 +24036,10 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" + "description": "

An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" } ], - "descriptionHTML": "

Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

", + "descriptionHTML": "

Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

", "codeExamples": [ { "request": { @@ -24224,7 +24224,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24233,7 +24233,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25120,11 +25120,11 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", "isRequired": true } ], - "descriptionHTML": "

Replaces all repositories for an organization development environment secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", + "descriptionHTML": "

Replaces all repositories for an organization development environment secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", "codeExamples": [ { "request": { @@ -25210,7 +25210,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Adds a repository to an organization development environment secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Adds a repository to an organization development environment secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret.\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -25296,7 +25296,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes a repository from an organization development environment secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", + "descriptionHTML": "

Removes a repository from an organization development environment secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", "codeExamples": [ { "request": { @@ -25357,7 +25357,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25366,7 +25366,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -27265,7 +27265,7 @@ "isRequired": true } ], - "descriptionHTML": "

Codespaces for the specified users will be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

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

", + "descriptionHTML": "

Codespaces for the specified users will be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

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

", "codeExamples": [ { "request": { @@ -27352,7 +27352,7 @@ "isRequired": true } ], - "descriptionHTML": "

Codespaces for the specified users will no longer be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

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

", + "descriptionHTML": "

Codespaces for the specified users will no longer be billed to the organization.

\n

To use this endpoint, the access settings for the organization must be set to selected_members.\nFor information on how to change this setting, see \"Manage access control for organization codespaces.\"

\n

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

", "codeExamples": [ { "request": { @@ -27423,7 +27423,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -27432,7 +27432,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -30838,7 +30838,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -30847,7 +30847,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31191,7 +31191,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" }, { "type": "string", @@ -31199,7 +31199,7 @@ "description": "

ID of the key you used to encrypt the secret.

" } ], - "descriptionHTML": "

Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The associated user must be a repository admin.

", + "descriptionHTML": "

Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The associated user must be a repository admin.

", "codeExamples": [ { "request": { @@ -31358,7 +31358,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31367,7 +31367,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31671,7 +31671,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get the public key for the authenticated user endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get the public key for the authenticated user endpoint.

" }, { "type": "string", @@ -31682,10 +31682,10 @@ { "type": "array", "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the user secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Set selected repositories for a user secret, and Remove a selected repository from a user secret endpoints.

" + "description": "

An array of repository ids that can access the user secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Set selected repositories for a user secret, and Remove a selected repository from a user secret endpoints.

" } ], - "descriptionHTML": "

Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\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.

", + "descriptionHTML": "

Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\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.

", "codeExamples": [ { "request": { @@ -32895,7 +32895,7 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Add a selected repository to a user secret, and Remove a selected repository from a user secret endpoints.

", + "description": "

An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the List selected repositories for a user secret, Add a selected repository to a user secret, and Remove a selected repository from a user secret endpoints.

", "isRequired": true } ], diff --git a/src/rest/data/ghec-2026-03-10/collaborators.json b/src/rest/data/ghec-2026-03-10/collaborators.json index efd12b892f1b..4c9467245742 100644 --- a/src/rest/data/ghec-2026-03-10/collaborators.json +++ b/src/rest/data/ghec-2026-03-10/collaborators.json @@ -59,7 +59,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -68,7 +68,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -408,7 +408,7 @@ "default": "push" } ], - "descriptionHTML": "

Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an \"outside collaborator\" (if they are not an Enterprise Managed User) or a \"repository collaborator\" if they are an Enterprise Managed User. These users are exempt from some organization policies - see \"Adding outside collaborators to repositories\" to learn more about these collaborator types.

\n

This endpoint triggers notifications.

\n

Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see \"Enforcing repository management policies in your enterprise\" and \"Setting permissions for adding outside collaborators\" for organization settings.

\n

For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

\n
Cannot assign {member} permission of {role name}\n
\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.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the API.

\n

For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise.

\n

Updating an existing collaborator's permission level

\n

The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.

\n

Rate limits

\n

You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", + "descriptionHTML": "

Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an \"outside collaborator\" (if they are not an Enterprise Managed User) or a \"repository collaborator\" if they are an Enterprise Managed User. These users are exempt from some organization policies - see \"Adding outside collaborators to repositories\" to learn more about these collaborator types.

\n

This endpoint triggers notifications.

\n

Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see \"Enforcing repository management policies in your enterprise\" and \"Setting permissions for adding outside collaborators\" for organization settings.

\n

For more information on permission levels, see \"Repository permission levels for an organization\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:

\n
Cannot assign {member} permission of {role name}\n
\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.\"

\n

The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the API.

\n

For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise.

\n

Updating an existing collaborator's permission level

\n

The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different permission parameter. The response will be a 204, with no other indication that the permission level changed.

\n

Rate limits

\n

You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.

", "codeExamples": [ { "request": { @@ -1621,7 +1621,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n
    \n
  • Cancels any outstanding invitations sent by the collaborator
  • \n
  • Unassigns the user from any issues
  • \n
  • Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.
  • \n
  • Unstars the repository
  • \n
  • Updates access permissions to packages
  • \n
\n

Removing a user as a collaborator has the following effects on forks:

\n
    \n
  • If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.
  • \n
  • If the user had their own fork of the repository, the fork will be deleted.
  • \n
  • If the user still has read access to the repository, open pull requests by this user from a fork will be denied.
  • \n
\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", + "descriptionHTML": "

Removes a collaborator from a repository.

\n

To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.

\n

This endpoint also:

\n
    \n
  • Cancels any outstanding invitations sent by the collaborator
  • \n
  • Unassigns the user from any issues
  • \n
  • Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.
  • \n
  • Unstars the repository
  • \n
  • Updates access permissions to packages
  • \n
\n

Removing a user as a collaborator has the following effects on forks:

\n
    \n
  • If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.
  • \n
  • If the user had their own fork of the repository, the fork will be deleted.
  • \n
  • If the user still has read access to the repository, open pull requests by this user from a fork will be denied.
  • \n
\n

Note

\n

\nA user can still have access to the repository through organization permissions like base repository permissions.

\n
\n

Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.

\n

For more information on fork permissions, see \"About permissions and visibility of forks\".

", "codeExamples": [ { "request": { @@ -1959,7 +1959,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1968,7 +1968,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4442,7 +4442,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4451,7 +4451,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/commits.json b/src/rest/data/ghec-2026-03-10/commits.json index 9be925a2202d..66410da3657e 100644 --- a/src/rest/data/ghec-2026-03-10/commits.json +++ b/src/rest/data/ghec-2026-03-10/commits.json @@ -84,7 +84,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -93,7 +93,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -794,7 +794,7 @@ } ], "bodyParameters": [], - "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

Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.

", + "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

Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.

", "codeExamples": [ { "request": { @@ -923,7 +923,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -932,7 +932,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4356,7 +4356,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4365,7 +4365,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4383,7 +4383,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note

\n

\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
  • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.
  • \n
  • application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
  • \n
\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Returns the contents of a single commit reference. You must have read access for the repository to use this endpoint.

\n

Note

\n

\nIf there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.

\n
\n

This endpoint supports the following custom media types. For more information, see \"Media types.\" Pagination query parameters are not supported for these media types.

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code.
  • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property. Larger diffs may time out and return a 5xx status code.
  • \n
  • application/vnd.github.sha: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
  • \n
\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "codeExamples": [ { "request": { @@ -5143,7 +5143,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5152,7 +5152,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5170,7 +5170,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
  • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
  • \n
\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.
  • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
  • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see \"Understanding connections between repositories.\"

\n

This endpoint is equivalent to running the git log BASE..HEAD command, but it returns commits in a different order. The git log BASE..HEAD command returns commits in reverse chronological order, whereas the API returns commits in chronological order.

\n

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

\n
    \n
  • application/vnd.github.diff: Returns the diff of the commit.
  • \n
  • application/vnd.github.patch: Returns the patch of the commit. Diffs with binary data will have no patch property.
  • \n
\n

The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a renamed status have a previous_filename field showing the previous filename of the file, and files with a modified status have a patch field showing the changes made to the file.

\n

When calling this endpoint without any paging parameter (per_page or page), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison.

\n

Working with large comparisons

\n

To process a response with a large number of commits, use a query parameter (per_page or page) to paginate the results. When using pagination:

\n
    \n
  • The list of changed files is only shown on the first page of results, and it includes up to 300 changed files for the entire comparison.
  • \n
  • The results are returned in chronological order, but the last commit in the returned list may not be the most recent one in the entire set if there are more pages of results.
  • \n
\n

For more information on working with pagination, see \"Using pagination in the REST API.\"

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The verification object includes the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "codeExamples": [ { "request": { @@ -7239,7 +7239,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7248,7 +7248,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7257,7 +7257,7 @@ } ], "bodyParameters": [], - "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
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "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
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -7621,7 +7621,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified commit comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Gets a specified commit comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -7992,7 +7992,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates the contents of a specified commit comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Updates the contents of a specified commit comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -8436,7 +8436,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8445,7 +8445,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8454,7 +8454,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments for a specified commit.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists the comments for a specified commit.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -8840,7 +8840,7 @@ "description": "

Closing down notice. Use position parameter instead. Line number in the file to comment on.

" } ], - "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Create a comment for a commit using its :commit_sha.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -9215,7 +9215,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9224,7 +9224,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10236,7 +10236,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10245,7 +10245,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/copilot.json b/src/rest/data/ghec-2026-03-10/copilot.json index 6a636453c724..c9e1f507ac02 100644 --- a/src/rest/data/ghec-2026-03-10/copilot.json +++ b/src/rest/data/ghec-2026-03-10/copilot.json @@ -279,7 +279,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -288,7 +288,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1615,7 +1615,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about an enterprise's Copilot content exclusion path rules.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Enterprise owners can view details about Copilot content exclusion rules for the enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the read:enterprise or copilot scopes to use this endpoint.

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.
  • \n
  • At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.
  • \n
\n
", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about an enterprise's Copilot content exclusion path rules.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Enterprise owners can view details about Copilot content exclusion rules for the enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the read:enterprise or copilot scopes to use this endpoint.

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.
  • \n
  • At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.
  • \n
\n
", "codeExamples": [ { "request": { @@ -1706,7 +1706,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets Copilot content exclusion path rules for an enterprise.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Enterprise owners can set Copilot content exclusion rules for the enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the admin:enterprise or copilot scopes to use this endpoint.

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.
  • \n
  • At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.
  • \n
\n
", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets Copilot content exclusion path rules for an enterprise.\nTo configure these settings, go to the enterprise's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Enterprise owners can set Copilot content exclusion rules for the enterprise.

\n

OAuth app tokens and personal access tokens (classic) need either the admin:enterprise or copilot scopes to use this endpoint.

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.
  • \n
  • At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.
  • \n
\n
", "codeExamples": [ { "request": { @@ -1805,7 +1805,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Organization owners can view details about Copilot content exclusion rules for the organization.

\n

OAuth app tokens and personal access tokens (classic) need either the copilot or read:org scopes to use this endpoint.

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.
  • \n
  • At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.
  • \n
\n
", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about an organization's Copilot content exclusion path rules.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Organization owners can view details about Copilot content exclusion rules for the organization.

\n

OAuth app tokens and personal access tokens (classic) need either the copilot or read:org scopes to use this endpoint.

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. This endpoint will not return any comments in the existing rules.
  • \n
  • At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response.
  • \n
\n
", "codeExamples": [ { "request": { @@ -1892,7 +1892,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Organization owners can set Copilot content exclusion rules for the organization.

\n

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

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.
  • \n
  • At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.
  • \n
\n
", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets Copilot content exclusion path rules for an organization.\nTo configure these settings, go to the organization's settings on GitHub.\nFor more information, see \"Excluding content from GitHub Copilot.\"

\n

Organization owners can set Copilot content exclusion rules for the organization.

\n

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

\n

Caution

\n

\n
    \n
  • At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted.
  • \n
  • At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten.
  • \n
\n
", "codeExamples": [ { "request": { @@ -1989,7 +1989,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1998,7 +1998,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2539,7 +2539,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2548,7 +2548,7 @@ }, { "name": "per_page", - "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3122,7 +3122,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3131,7 +3131,7 @@ }, { "name": "per_page", - "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3140,7 +3140,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"About enterprise accounts for Copilot Business.\"

\n
\n

Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.

\n

Note

\n

\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.

\n
\n

To access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"About enterprise accounts for Copilot Business.\"

\n
\n

Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.

\n

The response contains metrics for up to 100 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.

\n

Note

\n

\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses on that day, as evaluated at the end of that day.

\n
\n

To access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -3697,7 +3697,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3706,7 +3706,7 @@ }, { "name": "per_page", - "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4287,7 +4287,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4296,7 +4296,7 @@ }, { "name": "per_page", - "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of days of metrics to display per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5298,7 +5298,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.

\n

The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

\n

The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", + "descriptionHTML": "

Use this endpoint to retrieve download links for the Copilot organization usage metrics report for a specific day. The report provides comprehensive usage data for Copilot features across the organization.

\n

The report contains aggregated metrics for the specified day, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

\n

The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", "codeExamples": [ { "request": { @@ -5399,7 +5399,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.

\n

The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

\n

The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", + "descriptionHTML": "

Use this endpoint to retrieve download links for the latest 28-day organization Copilot usage metrics report. The report provides comprehensive usage data for Copilot features across the organization.

\n

The report contains aggregated metrics for the previous 28 days, including usage statistics for various Copilot features, user engagement data, and feature adoption metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.

\n

The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", "codeExamples": [ { "request": { @@ -5516,7 +5516,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

\n

The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

\n

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", + "descriptionHTML": "

Use this endpoint to retrieve download links for the Copilot organization user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

\n

The report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

\n

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", "codeExamples": [ { "request": { @@ -5617,7 +5617,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

\n

The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

\n

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", + "descriptionHTML": "

Use this endpoint to retrieve download links for the latest 28-day organization users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the organization.

\n

The report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.

\n

Reports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.

\n

Organization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint.

\n

For more information about organization metrics attribution, see How are metrics attributed across organizations.

", "codeExamples": [ { "request": { @@ -5723,7 +5723,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5732,7 +5732,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5741,7 +5741,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.

\n

Users with access through multiple organizations or enterprise teams will only be counted toward total_seats once.

\n

For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the seats array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at. For more information about activity data,\nsee Metrics data properties for GitHub Copilot.

\n

Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.

\n

Personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.

\n

Users with access through multiple organizations or enterprise teams will only be counted toward total_seats once.

\n

For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the seats array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at. For more information about activity data,\nsee Metrics data properties for GitHub Copilot.

\n

Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.

\n

Personal access tokens (classic) need either the manage_billing:copilot or read:enterprise scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -7564,7 +7564,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"Managing policies for Copilot in your organization.\"

\n

Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets information about an organization's Copilot subscription, including seat breakdown\nand feature policies. To configure these settings, go to your organization's settings on GitHub.com.\nFor more information, see \"Managing policies for Copilot in your organization.\"

\n

Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -7755,7 +7755,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7764,7 +7764,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7773,7 +7773,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.

\n

Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see Metrics data properties for GitHub Copilot.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.\nOnly organization owners can view assigned seats.

\n

Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see Metrics data properties for GitHub Copilot.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -8473,7 +8473,7 @@ "isRequired": true } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response contains the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for all users within each specified team.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response contains the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -8580,7 +8580,7 @@ "isRequired": true } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response contains the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all members of each team specified to \"pending cancellation\".\nThis will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response contains the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -8687,7 +8687,7 @@ "isRequired": true } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response contains the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Purchases a GitHub Copilot seat for each user specified.\nThe organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see \"About billing for GitHub Copilot in your organization.\"

\n

Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.\nFor more information about setting up a Copilot subscription, see \"Subscribing to Copilot for your organization.\"\nFor more information about setting a suggestion matching policy, see \"Managing policies for Copilot in your organization.\"

\n

The response contains the total number of new seats that were created and existing seats that were refreshed.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -8794,7 +8794,7 @@ "isRequired": true } ], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response contains the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Sets seats for all users specified to \"pending cancellation\".\nThis will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.\nFor more information about disabling access to Copilot, see \"Revoking access to Copilot for members of your organization.\"

\n

Only organization owners can cancel Copilot seats for their organization members.

\n

The response contains the total number of seats set to \"pending cancellation\".

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:org scopes to use this endpoint.

", "codeExamples": [ { "request": { @@ -8903,7 +8903,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.

\n

The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see Metrics data properties for GitHub Copilot.

\n

Only organization owners can view Copilot seat assignment details for members of their organization.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", + "descriptionHTML": "

Note

\n

\nThis endpoint is in public preview and is subject to change.

\n
\n

Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.

\n

The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in last_activity_at.\nFor more information about activity data, see Metrics data properties for GitHub Copilot.

\n

Only organization owners can view Copilot seat assignment details for members of their organization.

\n

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or read:org scopes to use this endpoint.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/dependabot.json b/src/rest/data/ghec-2026-03-10/dependabot.json index e13e7812eca6..d260ed13bf74 100644 --- a/src/rest/data/ghec-2026-03-10/dependabot.json +++ b/src/rest/data/ghec-2026-03-10/dependabot.json @@ -80,7 +80,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -89,7 +89,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -504,7 +504,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -513,7 +513,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1842,7 +1842,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1851,7 +1851,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1860,7 +1860,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1869,7 +1869,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists Dependabot alerts for repositories that are owned by the specified enterprise.

\n

The authenticated user must be a member of the enterprise to use this endpoint.

\n

Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"Managing security managers in your organization.\"

\n

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

", + "descriptionHTML": "

Lists Dependabot alerts for repositories that are owned by the specified enterprise.

\n

The authenticated user must be a member of the enterprise to use this endpoint.

\n

Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see \"Managing security managers in your organization.\"

\n

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

", "codeExamples": [ { "request": { @@ -3716,7 +3716,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3725,7 +3725,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3734,7 +3734,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5590,7 +5590,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -5599,7 +5599,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -5608,7 +5608,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7972,7 +7972,7 @@ "description": "

Usernames to assign to this Dependabot Alert.\nPass one or more user logins to replace the set of assignees on this alert.\nSend an empty array ([]) to clear all assignees from the alert.

" } ], - "descriptionHTML": "

The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"Granting access to security alerts.\"

\n

OAuth app tokens and personal access tokens (classic) need the 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.

", + "descriptionHTML": "

The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see \"Granting access to security alerts.\"

\n

OAuth app tokens and personal access tokens (classic) need the 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.

", "codeExamples": [ { "request": { @@ -9753,7 +9753,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9762,7 +9762,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10100,7 +10100,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

" }, { "type": "string", @@ -10121,10 +10121,10 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

" } ], - "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

", + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

", "codeExamples": [ { "request": { @@ -10297,7 +10297,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10306,7 +10306,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11189,11 +11189,11 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", "isRequired": true } ], - "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", "codeExamples": [ { "request": { @@ -11271,7 +11271,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.

\n

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

", + "descriptionHTML": "

Adds a repository to an organization secret when the visibility for\nrepository access is set to selected. The visibility is set when you Create or\nupdate an organization secret.

\n

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

", "codeExamples": [ { "request": { @@ -11349,7 +11349,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", + "descriptionHTML": "

Removes a repository from an organization secret when the visibility\nfor repository access is set to selected. The visibility is set when you Create\nor update an organization secret.

\n

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

", "codeExamples": [ { "request": { @@ -11418,7 +11418,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11427,7 +11427,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11756,7 +11756,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

" }, { "type": "string", @@ -11764,7 +11764,7 @@ "description": "

ID of the key you used to encrypt the secret.

" } ], - "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

", + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"

\n

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/deploy-keys.json b/src/rest/data/ghec-2026-03-10/deploy-keys.json index 9c4f1b6ce244..3a69259a954a 100644 --- a/src/rest/data/ghec-2026-03-10/deploy-keys.json +++ b/src/rest/data/ghec-2026-03-10/deploy-keys.json @@ -28,7 +28,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -37,7 +37,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -194,7 +194,7 @@ { "type": "boolean", "name": "read_only", - "description": "

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

\n

Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

" + "description": "

If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

\n

Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"Repository permission levels for an organization\" and \"Permission levels for a user account repository.\"

" } ], "descriptionHTML": "

You can create a read-only deploy key.

", diff --git a/src/rest/data/ghec-2026-03-10/deployments.json b/src/rest/data/ghec-2026-03-10/deployments.json index bef9ebbc2131..d1af0ffefc38 100644 --- a/src/rest/data/ghec-2026-03-10/deployments.json +++ b/src/rest/data/ghec-2026-03-10/deployments.json @@ -71,7 +71,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -80,7 +80,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -719,7 +719,7 @@ { "type": "array of strings", "name": "required_contexts", - "description": "

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

" + "description": "

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

" }, { "type": "object or string", @@ -750,7 +750,7 @@ "description": "

Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

" } ], - "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Merged branch response:

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n
    \n
  • Auto-merge option is enabled in the repository
  • \n
  • Topic branch does not include the latest changes on the base branch, which is master in the response example
  • \n
  • There are no merge conflicts
  • \n
\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response:

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks:

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

\n

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

", + "descriptionHTML": "

Deployments offer a few configurable parameters with certain defaults.

\n

The ref parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them\nbefore we merge a pull request.

\n

The environment parameter allows deployments to be issued to different runtime environments. Teams often have\nmultiple environments for verifying their applications, such as production, staging, and qa. This parameter\nmakes it easier to track which environments have requested deployments. The default environment is production.

\n

The auto_merge parameter is used to ensure that the requested ref is not behind the repository's default branch. If\nthe ref is behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds,\nthe API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will\nreturn a failure response.

\n

By default, commit statuses for every submitted context must be in a success\nstate. The required_contexts parameter allows you to specify a subset of contexts that must be success, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.

\n

The payload parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.

\n

The task parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.

\n

Merged branch response:

\n

You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:

\n
    \n
  • Auto-merge option is enabled in the repository
  • \n
  • Topic branch does not include the latest changes on the base branch, which is master in the response example
  • \n
  • There are no merge conflicts
  • \n
\n

If there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.

\n

Merge conflict response:

\n

This error happens when the auto_merge option is enabled and when the default branch (in this case master), can't\nbe merged into the branch that's being deployed (in this case topic-branch), due to merge conflicts.

\n

Failed commit status checks:

\n

This error happens when the required_contexts parameter indicates that one or more contexts need to have a success\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of success.

\n

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

", "codeExamples": [ { "request": { @@ -1998,7 +1998,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.

\n

To set a deployment as inactive, you must:

\n
    \n
  • Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
  • \n
  • Mark the active deployment as inactive by adding any non-successful deployment status.
  • \n
\n

For more information, see \"Create a deployment\" and \"Create a deployment status.\"

\n

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

", + "descriptionHTML": "

If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment.

\n

To set a deployment as inactive, you must:

\n
    \n
  • Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.
  • \n
  • Mark the active deployment as inactive by adding any non-successful deployment status.
  • \n
\n

For more information, see \"Create a deployment\" and \"Create a deployment status.\"

\n

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

", "codeExamples": [ { "request": { @@ -2081,7 +2081,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2090,7 +2090,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2787,7 +2787,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2796,7 +2796,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4835,7 +4835,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

\n

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

", + "descriptionHTML": "

Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -5009,7 +5009,7 @@ "description": "

The ID of the custom app that will be enabled on the environment.

" } ], - "descriptionHTML": "

Enable a custom deployment protection rule for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.

\n

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

", + "descriptionHTML": "

Enable a custom deployment protection rule for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about the app that is providing this custom deployment rule, see the documentation for the GET /apps/{app_slug} endpoint, as well as the guide to creating custom deployment protection rules.

\n

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

", "codeExamples": [ { "request": { @@ -5152,7 +5152,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5161,7 +5161,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5170,7 +5170,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets all custom deployment protection rule integrations that are available for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see \"GET an app\".

\n

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

", + "descriptionHTML": "

Gets all custom deployment protection rule integrations that are available for an environment.

\n

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

\n

For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see \"GET an app\".

\n

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

", "codeExamples": [ { "request": { @@ -5315,7 +5315,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.

\n

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

", + "descriptionHTML": "

Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see \"Using environments for deployment.\"

\n

For more information about the app that is providing this custom deployment rule, see GET /apps/{app_slug}.

\n

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

", "codeExamples": [ { "request": { @@ -5541,7 +5541,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5550,7 +5550,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/enterprise-admin.json b/src/rest/data/ghec-2026-03-10/enterprise-admin.json index 0fb465ee444f..1ba1eec431cd 100644 --- a/src/rest/data/ghec-2026-03-10/enterprise-admin.json +++ b/src/rest/data/ghec-2026-03-10/enterprise-admin.json @@ -19,7 +19,7 @@ }, { "name": "date_start", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", "in": "query", "required": false, "schema": { @@ -28,7 +28,7 @@ }, { "name": "date_end", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", "in": "query", "required": false, "schema": { @@ -484,7 +484,7 @@ }, { "name": "phrase", - "description": "

A search phrase. For more information, see Searching the audit log.

", + "description": "

A search phrase. For more information, see Searching the audit log.

", "in": "query", "required": false, "schema": { @@ -507,7 +507,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", "in": "query", "required": false, "schema": { @@ -516,7 +516,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", "in": "query", "required": false, "schema": { @@ -538,7 +538,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -547,7 +547,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -556,7 +556,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the audit log for an enterprise.

\n

This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"Rate limits for the REST API\" and \"Best practices for integrators.\"

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

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

", + "descriptionHTML": "

Gets the audit log for an enterprise.

\n

This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"Rate limits for the REST API\" and \"Best practices for integrators.\"

\n

The authenticated user must be an enterprise admin to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -2068,7 +2068,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2077,7 +2077,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2437,7 +2437,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to fetch code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Gets code security and analysis settings for the specified enterprise.

\n

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

\n

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

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to fetch code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Gets code security and analysis settings for the specified enterprise.

\n

The authenticated user must be an administrator of the enterprise in order to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -2550,32 +2550,32 @@ { "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", - "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"About GitHub Advanced Security.\"

" + "description": "

Whether GitHub Advanced Security is automatically enabled for new repositories. For more information, see \"About GitHub Advanced Security.\"

" }, { "type": "boolean", "name": "advanced_security_enabled_new_user_namespace_repos", - "description": "

Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"About GitHub Advanced Security.\"

" + "description": "

Whether GitHub Advanced Security is automatically enabled for new user namespace repositories. For more information, see \"About GitHub Advanced Security.\"

" }, { "type": "boolean", "name": "dependabot_alerts_enabled_for_new_repositories", - "description": "

Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"About Dependabot alerts.\"

" + "description": "

Whether Dependabot alerts are automatically enabled for new repositories. For more information, see \"About Dependabot alerts.\"

" }, { "type": "boolean", "name": "secret_scanning_enabled_for_new_repositories", - "description": "

Whether secret scanning is automatically enabled for new repositories. For more information, see \"About secret scanning.\"

" + "description": "

Whether secret scanning is automatically enabled for new repositories. For more information, see \"About secret scanning.\"

" }, { "type": "boolean", "name": "secret_scanning_push_protection_enabled_for_new_repositories", - "description": "

Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"Protecting pushes with secret scanning.\"

" + "description": "

Whether secret scanning push protection is automatically enabled for new repositories. For more information, see \"Protecting pushes with secret scanning.\"

" }, { "type": "string or null", "name": "secret_scanning_push_protection_custom_link", - "description": "

The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"Protecting pushes with secret scanning.\"\nTo disable this functionality, set this field to null.

" + "description": "

The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see \"Protecting pushes with secret scanning.\"\nTo disable this functionality, set this field to null.

" }, { "type": "boolean or null", @@ -2583,7 +2583,7 @@ "description": "

Whether secret scanning of non-provider patterns is enabled for new repositories under this enterprise.

" } ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to update code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.

\n

The authenticated user must be an administrator of the enterprise to use this endpoint.

\n

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

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to update code security and analysis settings for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise.

\n

The authenticated user must be an administrator of the enterprise to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -2680,7 +2680,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all repositories in an enterprise.

\n

The authenticated user must be an administrator of the enterprise to use this endpoint.

\n

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

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to enable or disable a security feature for an enterprise is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all repositories in an enterprise.

\n

The authenticated user must be an administrator of the enterprise to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -4917,7 +4917,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4926,7 +4926,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6196,7 +6196,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6205,7 +6205,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6374,7 +6374,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6383,7 +6383,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6917,7 +6917,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6926,7 +6926,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7294,7 +7294,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7303,7 +7303,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7467,7 +7467,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7476,7 +7476,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8234,7 +8234,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8243,7 +8243,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8350,7 +8350,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8359,7 +8359,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8475,7 +8475,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8484,7 +8484,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10194,7 +10194,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10203,7 +10203,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -12985,7 +12985,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -12997,7 +12997,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -14377,7 +14377,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -14387,7 +14387,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -15809,7 +15809,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -15819,7 +15819,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -17330,7 +17330,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -17342,7 +17342,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -18723,7 +18723,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -18733,7 +18733,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -18924,7 +18924,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18933,7 +18933,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/enterprise-teams.json b/src/rest/data/ghec-2026-03-10/enterprise-teams.json index c63119e73259..74552928deaa 100644 --- a/src/rest/data/ghec-2026-03-10/enterprise-teams.json +++ b/src/rest/data/ghec-2026-03-10/enterprise-teams.json @@ -19,7 +19,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -207,7 +207,7 @@ { "type": "string", "name": "organization_selection_type", - "description": "

Specifies which organizations in the enterprise should have access to this team. Can be one of disabled, selected, or all.\ndisabled: The team is not assigned to any organizations. This is the default when you create a new team.\nselected: The team is assigned to specific organizations. You can then use the add organization assignments API endpoint.\nall: The team is assigned to all current and future organizations in the enterprise.

", + "description": "

Specifies which organizations in the enterprise should have access to this team. Can be one of disabled, selected, or all.\ndisabled: The team is not assigned to any organizations. This is the default when you create a new team.\nselected: The team is assigned to specific organizations. You can then use the add organization assignments API endpoint.\nall: The team is assigned to all current and future organizations in the enterprise.

", "enum": [ "disabled", "selected", @@ -218,7 +218,7 @@ { "type": "string or null", "name": "group_id", - "description": "

The ID of the IdP group to assign team membership with. You can get this value from the REST API endpoints for SCIM.

" + "description": "

The ID of the IdP group to assign team membership with. You can get this value from the REST API endpoints for SCIM.

" } ], "descriptionHTML": "

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

", @@ -547,7 +547,7 @@ { "type": "string", "name": "organization_selection_type", - "description": "

Specifies which organizations in the enterprise should have access to this team. Can be one of disabled, selected, or all.\ndisabled: The team is not assigned to any organizations. This is the default when you create a new team.\nselected: The team is assigned to specific organizations. You can then use the add organization assignments API.\nall: The team is assigned to all current and future organizations in the enterprise.

", + "description": "

Specifies which organizations in the enterprise should have access to this team. Can be one of disabled, selected, or all.\ndisabled: The team is not assigned to any organizations. This is the default when you create a new team.\nselected: The team is assigned to specific organizations. You can then use the add organization assignments API.\nall: The team is assigned to all current and future organizations in the enterprise.

", "enum": [ "disabled", "selected", @@ -788,7 +788,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -797,7 +797,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1929,7 +1929,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1938,7 +1938,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/gists.json b/src/rest/data/ghec-2026-03-10/gists.json index a977f44907cd..b9295aff809d 100644 --- a/src/rest/data/ghec-2026-03-10/gists.json +++ b/src/rest/data/ghec-2026-03-10/gists.json @@ -20,7 +20,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -29,7 +29,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1120,7 +1120,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1129,7 +1129,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1138,7 +1138,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List public gists sorted by most recently updated to least recently updated.

\n

Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

", + "descriptionHTML": "

List public gists sorted by most recently updated to least recently updated.

\n

Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

", "codeExamples": [ { "request": { @@ -1474,7 +1474,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1483,7 +1483,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1827,7 +1827,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Gets a specified gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { @@ -2571,7 +2571,7 @@ ] } ], - "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.

\n

At least one of description or files is required.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { @@ -4688,7 +4688,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4697,7 +4697,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4961,7 +4961,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4970,7 +4970,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6062,7 +6062,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "codeExamples": [ { "request": { @@ -6201,7 +6201,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specified gist revision.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Gets a specified gist revision.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { @@ -6926,7 +6926,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6935,7 +6935,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7276,7 +7276,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7285,7 +7285,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7294,7 +7294,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the comments on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Lists the comments on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { @@ -7571,7 +7571,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Creates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { @@ -7853,7 +7853,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Gets a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { @@ -8136,7 +8136,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", + "descriptionHTML": "

Updates a comment on a gist.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown. This is the default if you do not pass any specific media type.
  • \n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/git.json b/src/rest/data/ghec-2026-03-10/git.json index bd7d9e17f801..bc329d54af99 100644 --- a/src/rest/data/ghec-2026-03-10/git.json +++ b/src/rest/data/ghec-2026-03-10/git.json @@ -156,7 +156,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw blob data.
  • \n
  • application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.
  • \n
\n

Note This endpoint supports blobs up to 100 megabytes in size.

", + "descriptionHTML": "

The content in the response will always be Base64 encoded.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw blob data.
  • \n
  • application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.
  • \n
\n

Note This endpoint supports blobs up to 100 megabytes in size.

", "codeExamples": [ { "request": { @@ -939,7 +939,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note

\n

\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n
\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

", + "descriptionHTML": "

Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't exist in the repository, but existing refs start with :ref, they will be returned as an array.

\n

When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags.

\n

Note

\n

\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n
\n

If you request matching references for a branch named feature but the branch feature doesn't exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.

", "codeExamples": [ { "request": { @@ -1089,7 +1089,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note

\n

\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n
", + "descriptionHTML": "

Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn't match an existing ref, a 404 is returned.

\n

Note

\n

\nYou need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"Checking mergeability of pull requests\".

\n
", "codeExamples": [ { "request": { @@ -1666,7 +1666,7 @@ ] } ], - "descriptionHTML": "

Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", + "descriptionHTML": "

Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.

\n

Signature verification object

\n

The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
verifiedbooleanIndicates whether GitHub considers the signature in this commit to be verified.
reasonstringThe reason for verified value. Possible values and their meanings are enumerated in table below.
signaturestringThe signature that was extracted from the commit.
payloadstringThe value that was signed.
verified_atstringThe date the signature was verified by GitHub.
\n

These are the possible values for reason in the verification object:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ValueDescription
expired_keyThe key that made the signature is expired.
not_signing_keyThe \"signing\" flag is not among the usage flags in the GPG key that made the signature.
gpgverify_errorThere was an error communicating with the signature verification service.
gpgverify_unavailableThe signature verification service is currently unavailable.
unsignedThe object does not include a signature.
unknown_signature_typeA non-PGP signature was found in the commit.
no_userNo user was associated with the committer email address in the commit.
unverified_emailThe committer email address in the commit was associated with a user, but the email address is not verified on their account.
bad_emailThe committer email address in the commit is not included in the identities of the PGP key that made the signature.
unknown_keyThe key that made the signature has not been registered with any user's account.
malformed_signatureThere was an error parsing the signature.
invalidThe signature could not be cryptographically verified using the key whose key-id was found in the signature.
validNone of the above errors applied, so the signature is considered to be verified.
", "codeExamples": [ { "request": { @@ -2156,7 +2156,7 @@ "description": "

The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by base_tree and entries defined in the tree parameter. Entries defined in the tree parameter will overwrite items from base_tree with the same path. If you're creating new changes on a branch, then normally you'd set base_tree to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the tree parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the tree parameter will be listed as deleted by the new commit.

" } ], - "descriptionHTML": "

The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

\n

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"

\n

Returns an error if you try to delete a file that does not exist.

", + "descriptionHTML": "

The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.

\n

If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"Create a commit\" and \"Update a reference.\"

\n

Returns an error if you try to delete a file that does not exist.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/gitignore.json b/src/rest/data/ghec-2026-03-10/gitignore.json index 22f18c22914d..4c44a07d8577 100644 --- a/src/rest/data/ghec-2026-03-10/gitignore.json +++ b/src/rest/data/ghec-2026-03-10/gitignore.json @@ -9,7 +9,7 @@ "subcategory": "gitignore", "parameters": [], "bodyParameters": [], - "descriptionHTML": "

List all templates available to pass as an option when creating a repository.

", + "descriptionHTML": "

List all templates available to pass as an option when creating a repository.

", "codeExamples": [ { "request": { @@ -77,7 +77,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
  • \n
", + "descriptionHTML": "

Get the content of a gitignore template.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw .gitignore contents.
  • \n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/issues.json b/src/rest/data/ghec-2026-03-10/issues.json index 7bdcce605486..e574a095b74b 100644 --- a/src/rest/data/ghec-2026-03-10/issues.json +++ b/src/rest/data/ghec-2026-03-10/issues.json @@ -127,7 +127,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -136,7 +136,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -145,7 +145,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -3245,7 +3245,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3254,7 +3254,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3263,7 +3263,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -6385,7 +6385,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6394,7 +6394,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6403,7 +6403,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

List issues in a repository. Only open issues will be listed.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -9361,7 +9361,7 @@ "description": "

The name of the issue type to associate with this issue. NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise.

" } ], - "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -12314,7 +12314,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

The API returns a 301 Moved Permanently status if the issue was\ntransferred to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe\nto the issues webhook.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -18237,7 +18237,7 @@ "description": "

The name of the issue type to associate with this issue or use null to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.

" } ], - "descriptionHTML": "

Issue owners and users with push access or Triage role can edit an issue.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Issue owners and users with push access or Triage role can edit an issue.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -21207,7 +21207,7 @@ ] } ], - "descriptionHTML": "

Users with push access can lock an issue or pull request's conversation.

\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.\"

", + "descriptionHTML": "

Users with push access can lock an issue or pull request's conversation.

\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.\"

", "codeExamples": [ { "request": { @@ -21441,7 +21441,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21450,7 +21450,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21459,7 +21459,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

List issues across owned and member repositories assigned to the authenticated user.

\n

Note

\n

\nGitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -24476,7 +24476,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24485,7 +24485,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24494,7 +24494,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the available assignees for issues in a repository.

", + "descriptionHTML": "

Lists the available assignees for issues in a repository.

", "codeExamples": [ { "request": { @@ -30781,7 +30781,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -30790,7 +30790,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -30799,7 +30799,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.

\n

By default, issue comments are ordered by ascending ID.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request.

\n

By default, issue comments are ordered by ascending ID.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -31588,7 +31588,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -32377,7 +32377,7 @@ "isRequired": true } ], - "descriptionHTML": "

You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -33239,7 +33239,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to pin comments on issues.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to pin comments on issues.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -34158,7 +34158,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -34167,7 +34167,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -34176,7 +34176,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

Issue comments are ordered by ascending ID.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

Issue comments are ordered by ascending ID.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -34972,7 +34972,7 @@ "isRequired": true } ], - "descriptionHTML": "

You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.

\n

This endpoint triggers notifications.\nCreating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -35761,7 +35761,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35770,7 +35770,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -44241,7 +44241,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -44250,7 +44250,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -52580,7 +52580,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -52589,7 +52589,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -52598,7 +52598,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to list the dependencies an issue is blocked by.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to list the dependencies an issue is blocked by.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -55541,7 +55541,7 @@ "isRequired": true } ], - "descriptionHTML": "

You can use the REST API to add a 'blocked by' relationship to an issue.

\n

Creating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see Rate limits for the API\nand Best practices for using the REST API.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to add a 'blocked by' relationship to an issue.

\n

Creating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see Rate limits for the API\nand Best practices for using the REST API.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -58493,7 +58493,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to remove a dependency that an issue is blocked by.

\n

Removing content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see Rate limits for the API\nand Best practices for using the REST API.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass a specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to remove a dependency that an issue is blocked by.

\n

Removing content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see Rate limits for the API\nand Best practices for using the REST API.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass a specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -61437,7 +61437,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -61446,7 +61446,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -61455,7 +61455,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to list the dependencies an issue is blocking.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to list the dependencies an issue is blocking.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -64393,7 +64393,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -64402,7 +64402,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -64621,7 +64621,7 @@ ] } ], - "descriptionHTML": "

Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.

\n

This endpoint supports the following field data types:

\n
    \n
  • text: String values for text fields
  • \n
  • single_select: Option names for single-select fields (must match an existing option name)
  • \n
  • number: Numeric values for number fields
  • \n
  • date: ISO 8601 date strings for date fields
  • \n
\n

Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Add custom field values to an issue. You can set values for organization-level issue fields that have been defined for the repository's organization.\nAdding an empty array will clear all existing field values for the issue.

\n

This endpoint supports the following field data types:

\n
    \n
  • text: String values for text fields
  • \n
  • single_select: Option names for single-select fields (must match an existing option name)
  • \n
  • number: Numeric values for number fields
  • \n
  • date: ISO 8601 date strings for date fields
  • \n
\n

Only users with push access to the repository can add issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", "codeExamples": [ { "request": { @@ -64858,7 +64858,7 @@ ] } ], - "descriptionHTML": "

Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.

\n

This endpoint supports the following field data types:

\n
    \n
  • text: String values for text fields
  • \n
  • single_select: Option names for single-select fields (must match an existing option name)
  • \n
  • number: Numeric values for number fields
  • \n
  • date: ISO 8601 date strings for date fields
  • \n
\n

This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.

\n

Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Set custom field values for an issue, replacing any existing values. You can set values for organization-level issue fields that have been defined for the repository's organization.

\n

This endpoint supports the following field data types:

\n
    \n
  • text: String values for text fields
  • \n
  • single_select: Option names for single-select fields (must match an existing option name)
  • \n
  • number: Numeric values for number fields
  • \n
  • date: ISO 8601 date strings for date fields
  • \n
\n

This operation will replace all existing field values with the provided ones. If you want to add field values without replacing existing ones, use the POST endpoint instead.

\n

Only users with push access to the repository can set issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", "codeExamples": [ { "request": { @@ -65084,7 +65084,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Remove a specific custom field value from an issue.

\n

Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

\n

If the specified field does not have a value set on the issue, this operation will return a 404 error.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Remove a specific custom field value from an issue.

\n

Only users with push access to the repository can delete issue field values. If you don't have the proper permissions, you'll receive a 403 Forbidden response.

\n

If the specified field does not have a value set on the issue, this operation will return a 404 error.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

", "codeExamples": [ { "request": { @@ -65178,7 +65178,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -65187,7 +65187,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -65360,7 +65360,7 @@ { "type": "array of strings", "name": "labels", - "description": "

The names of the labels to add to the issue's existing labels. You can also pass an array of labels directly, but GitHub recommends passing an object with the labels key. To replace all of the labels for an issue, use \"Set labels for an issue.\"

" + "description": "

The names of the labels to add to the issue's existing labels. You can also pass an array of labels directly, but GitHub recommends passing an object with the labels key. To replace all of the labels for an issue, use \"Set labels for an issue.\"

" } ], "descriptionHTML": "

Adds labels to an issue.

", @@ -65537,7 +65537,7 @@ { "type": "array of strings", "name": "labels", - "description": "

The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

" + "description": "

The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see \"Add labels to an issue.\"

" } ], "descriptionHTML": "

Removes any previous labels and sets the new labels for an issue.

", @@ -65951,7 +65951,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -65960,7 +65960,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -66647,7 +66647,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -66656,7 +66656,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -66850,7 +66850,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -66859,7 +66859,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -68333,7 +68333,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to get the parent issue of a sub-issue.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to get the parent issue of a sub-issue.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -71271,7 +71271,7 @@ "isRequired": true } ], - "descriptionHTML": "

You can use the REST API to remove a sub-issue from an issue.\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass a specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to remove a sub-issue from an issue.\nRemoving content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"\nThis endpoint supports the following custom media types. For more information, see \"Media types.\"

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass a specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -74201,7 +74201,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -74210,7 +74210,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -74219,7 +74219,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

You can use the REST API to list the sub-issues on an issue.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to list the sub-issues on an issue.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw Markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the Markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's Markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -77163,7 +77163,7 @@ "description": "

Option that, when true, instructs the operation to replace the sub-issues current parent issue

" } ], - "descriptionHTML": "

You can use the REST API to add sub-issues to issues.

\n

Creating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

You can use the REST API to add sub-issues to issues.

\n

Creating content too quickly using this endpoint may result in secondary rate limiting.\nFor more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -83059,7 +83059,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -83068,7 +83068,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/licenses.json b/src/rest/data/ghec-2026-03-10/licenses.json index 82943c2f3916..2aa7f8366b41 100644 --- a/src/rest/data/ghec-2026-03-10/licenses.json +++ b/src/rest/data/ghec-2026-03-10/licenses.json @@ -19,7 +19,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -37,7 +37,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the most commonly used licenses on GitHub. For more information, see \"Licensing a repository .\"

", + "descriptionHTML": "

Lists the most commonly used licenses on GitHub. For more information, see \"Licensing a repository .\"

", "codeExamples": [ { "request": { @@ -184,7 +184,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets information about a specific license. For more information, see \"Licensing a repository .\"

", + "descriptionHTML": "

Gets information about a specific license. For more information, see \"Licensing a repository .\"

", "codeExamples": [ { "request": { @@ -370,7 +370,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

This method returns the contents of the repository's license file, if one is detected.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw contents of the license.
  • \n
  • application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
", + "descriptionHTML": "

This method returns the contents of the repository's license file, if one is detected.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw contents of the license.
  • \n
  • application/vnd.github.html+json: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/meta.json b/src/rest/data/ghec-2026-03-10/meta.json index dd0e7c398269..597fc30d608d 100644 --- a/src/rest/data/ghec-2026-03-10/meta.json +++ b/src/rest/data/ghec-2026-03-10/meta.json @@ -242,7 +242,7 @@ "subcategory": "meta", "parameters": [], "bodyParameters": [], - "descriptionHTML": "

Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"

\n

The API's response also includes a list of GitHub's domain names.

\n

The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.

\n

Note

\n

\nThis endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.

\n
", + "descriptionHTML": "

Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"

\n

The API's response also includes a list of GitHub's domain names.

\n

The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.

\n

Note

\n

\nThis endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.

\n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/metrics.json b/src/rest/data/ghec-2026-03-10/metrics.json index e13000d72de1..225305dcedf2 100644 --- a/src/rest/data/ghec-2026-03-10/metrics.json +++ b/src/rest/data/ghec-2026-03-10/metrics.json @@ -28,7 +28,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns all community profile metrics for a repository. The repository cannot be a fork.

\n

The returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.

\n

The health_percentage score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"About community profiles for public repositories.\"

\n

content_reports_enabled is only returned for organization-owned repositories.

", + "descriptionHTML": "

Returns all community profile metrics for a repository. The repository cannot be a fork.

\n

The returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE_TEMPLATE, PULL_REQUEST_TEMPLATE,\nREADME, and CONTRIBUTING files.

\n

The health_percentage score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"About community profiles for public repositories.\"

\n

content_reports_enabled is only returned for organization-owned repositories.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/migrations.json b/src/rest/data/ghec-2026-03-10/migrations.json index 2f31ff3a9223..7865cffc771f 100644 --- a/src/rest/data/ghec-2026-03-10/migrations.json +++ b/src/rest/data/ghec-2026-03-10/migrations.json @@ -19,7 +19,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2639,7 +2639,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

", + "descriptionHTML": "

Unlocks a repository that was locked for migration. You should unlock each migrated repository and delete them when the migration is complete and you no longer need the source data.

", "codeExamples": [ { "request": { @@ -2703,7 +2703,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2712,7 +2712,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2786,7 +2786,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

View the progress of an import.

\n

Warning

\n

\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.

\n
\n

Import status

\n

This section includes details about the possible values of the status field of the Import Progress response.

\n

An import that does not have errors will progress through these steps:

\n
    \n
  • detecting - the \"detection\" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.
  • \n
  • importing - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).
  • \n
  • mapping - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
  • \n
  • pushing - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include push_percent, which is the percent value reported by git push when it is \"Writing objects\".
  • \n
  • complete - the import is complete, and the repository is ready on GitHub Enterprise Cloud.
  • \n
\n

If there are problems, you will see one of these in the status field:

\n
    \n
  • auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.
  • \n
  • error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Enterprise Cloud Support for more information.
  • \n
  • detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.
  • \n
  • detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.
  • \n
  • detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.
  • \n
\n

The project_choices field

\n

When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

\n

Git LFS related fields

\n

This section includes details about Git LFS related fields that may be present in the Import Progress response.

\n
    \n
  • use_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.
  • \n
  • has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.
  • \n
  • large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.
  • \n
  • large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.
  • \n
", + "descriptionHTML": "

View the progress of an import.

\n

Warning

\n

\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.

\n
\n

Import status

\n

This section includes details about the possible values of the status field of the Import Progress response.

\n

An import that does not have errors will progress through these steps:

\n
    \n
  • detecting - the \"detection\" step of the import is in progress because the request did not include a vcs parameter. The import is identifying the type of source control present at the URL.
  • \n
  • importing - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include commit_count (the total number of raw commits that will be imported) and percent (0 - 100, the current progress through the import).
  • \n
  • mapping - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.
  • \n
  • pushing - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include push_percent, which is the percent value reported by git push when it is \"Writing objects\".
  • \n
  • complete - the import is complete, and the repository is ready on GitHub Enterprise Cloud.
  • \n
\n

If there are problems, you will see one of these in the status field:

\n
    \n
  • auth_failed - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the Update an import section.
  • \n
  • error - the import encountered an error. The import progress response will include the failed_step and an error message. Contact GitHub Enterprise Cloud Support for more information.
  • \n
  • detection_needs_auth - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the Update an import section.
  • \n
  • detection_found_nothing - the importer didn't recognize any source control at the URL. To resolve, Cancel the import and retry with the correct URL.
  • \n
  • detection_found_multiple - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a project_choices field with the possible project choices as values. To update project choice, please see the Update an import section.
  • \n
\n

The project_choices field

\n

When multiple projects are found at the provided URL, the response hash will include a project_choices field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.

\n

Git LFS related fields

\n

This section includes details about Git LFS related fields that may be present in the Import Progress response.

\n
    \n
  • use_lfs - describes whether the import has been opted in or out of using Git LFS. The value can be opt_in, opt_out, or undecided if no action has been taken.
  • \n
  • has_large_files - the boolean value describing whether files larger than 100MB were found during the importing step.
  • \n
  • large_files_size - the total size in gigabytes of files larger than 100MB found in the originating repository.
  • \n
  • large_files_count - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.
  • \n
", "codeExamples": [ { "request": { @@ -3991,7 +3991,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

\n

This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.

\n

Warning

\n

\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.

\n
", + "descriptionHTML": "

Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username hubot into something like hubot <hubot@12341234-abab-fefe-8787-fedcba987654>.

\n

This endpoint and the Map a commit author endpoint allow you to provide correct Git author information.

\n

Warning

\n

\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.

\n
", "codeExamples": [ { "request": { @@ -4411,7 +4411,7 @@ ] } ], - "descriptionHTML": "

You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.

\n

You can learn more about our LFS feature and working with large files on our help\nsite.

\n

Warning

\n

\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.

\n
", + "descriptionHTML": "

You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by Git LFS.

\n

You can learn more about our LFS feature and working with large files on our help\nsite.

\n

Warning

\n

\nEndpoint closing down notice: Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the changelog.

\n
", "codeExamples": [ { "request": { @@ -4632,7 +4632,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4641,7 +4641,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6290,7 +6290,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Fetches a single user migration. The response includes the state of the migration, which can be one of the following values:

\n
    \n
  • pending - the migration hasn't started yet.
  • \n
  • exporting - the migration is in progress.
  • \n
  • exported - the migration finished successfully.
  • \n
  • failed - the migration failed.
  • \n
\n

Once the migration has been exported you can download the migration archive.

", + "descriptionHTML": "

Fetches a single user migration. The response includes the state of the migration, which can be one of the following values:

\n
    \n
  • pending - the migration hasn't started yet.
  • \n
  • exporting - the migration is in progress.
  • \n
  • exported - the migration finished successfully.
  • \n
  • failed - the migration failed.
  • \n
\n

Once the migration has been exported you can download the migration archive.

", "codeExamples": [ { "request": { @@ -7132,7 +7132,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the List user migrations and Get a user migration status endpoints, will continue to be available even after an archive is deleted.

", + "descriptionHTML": "

Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the List user migrations and Get a user migration status endpoints, will continue to be available even after an archive is deleted.

", "codeExamples": [ { "request": { @@ -7206,7 +7206,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -7272,7 +7272,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7281,7 +7281,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/orgs.json b/src/rest/data/ghec-2026-03-10/orgs.json index 1503091b849f..7b7364dd548c 100644 --- a/src/rest/data/ghec-2026-03-10/orgs.json +++ b/src/rest/data/ghec-2026-03-10/orgs.json @@ -19,7 +19,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all organizations, in the order that they were created.

\n

Note

\n

\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.

\n
", + "descriptionHTML": "

Lists all organizations, in the order that they were created.

\n

Note

\n

\nPagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.

\n
", "codeExamples": [ { "request": { @@ -163,7 +163,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the Organization plan permission.

", + "descriptionHTML": "

Gets information about an organization.

\n

When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable two-factor authentication.

\n

To see the full details about an organization, the authenticated user must be an organization owner.

\n

OAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.

\n

To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the Organization plan permission.

", "codeExamples": [ { "request": { @@ -488,32 +488,32 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_custom_link": { @@ -525,7 +525,7 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true }, "created_at": { @@ -682,17 +682,17 @@ { "type": "boolean", "name": "members_can_create_internal_repositories", - "description": "

Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" + "description": "

Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" }, { "type": "boolean", "name": "members_can_create_private_repositories", - "description": "

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" + "description": "

Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" }, { "type": "boolean", "name": "members_can_create_public_repositories", - "description": "

Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" + "description": "

Whether organization members can create public repositories, which are visible to anyone. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

" }, { "type": "string", @@ -742,32 +742,32 @@ { "type": "boolean", "name": "advanced_security_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_alerts_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependabot_security_updates_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "dependency_graph_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "boolean", "name": "secret_scanning_push_protection_enabled_for_new_repositories", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

You can check which security and analysis features are currently enabled by using a GET /orgs/{org} request.

" }, { "type": "string", @@ -777,7 +777,7 @@ { "type": "boolean", "name": "secret_scanning_validity_checks_enabled", - "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.

" + "description": "

Endpoint closing down notice. Please use code security configurations instead.

\n

Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.

" }, { "type": "boolean", @@ -785,7 +785,7 @@ "description": "

Controls whether or not deploy keys may be added and used for repositories in the organization.

" } ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Cloud will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n
\n

Warning

\n

\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down. Please use code security configurations to set defaults instead. For more information on setting a default security configuration, see the changelog.

\n
\n

Updates the organization's profile and member privileges.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: GitHub Enterprise Cloud will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n
\n

Warning

\n

\nClosing down notice: Code security product enablement for new repositories through the organization API is closing down. Please use code security configurations to set defaults instead. For more information on setting a default security configuration, see the changelog.

\n
\n

Updates the organization's profile and member privileges.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -1123,32 +1123,32 @@ }, "advanced_security_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_alerts_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependabot_security_updates_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "dependency_graph_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether dependency graph is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_enabled_for_new_repositories": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this organization.\n\nThis field is only visible to organization owners or members of a team with the security manager role.", "deprecated": true }, "secret_scanning_push_protection_custom_link": { @@ -1160,7 +1160,7 @@ }, "secret_scanning_validity_checks_enabled": { "type": "boolean", - "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", + "description": "**Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-cloud@latest/rest/code-security/configurations) instead.\n\nWhether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization.", "deprecated": true }, "created_at": { @@ -1257,7 +1257,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes an organization and all its repositories.

\n

The organization login will be unavailable for 90 days after deletion.

\n

Please review the Terms of Service regarding account deletion before using this endpoint:

\n

https://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service

", + "descriptionHTML": "

Deletes an organization and all its repositories.

\n

The organization login will be unavailable for 90 days after deletion.

\n

Please review the Terms of Service regarding account deletion before using this endpoint:

\n

https://docs.github.com/enterprise-cloud@latest/site-policy/github-terms/github-terms-of-service

", "codeExamples": [ { "request": { @@ -1327,7 +1327,7 @@ }, { "name": "phrase", - "description": "

A search phrase. For more information, see Searching the audit log.

", + "description": "

A search phrase. For more information, see Searching the audit log.

", "in": "query", "required": false, "schema": { @@ -1350,7 +1350,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

", "in": "query", "required": false, "schema": { @@ -1359,7 +1359,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

", "in": "query", "required": false, "schema": { @@ -1381,7 +1381,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1390,7 +1390,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"

\n

By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"

\n

Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"

\n

This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"Rate limits for the REST API\" and \"Best practices for integrators.\"

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", + "descriptionHTML": "

Gets the audit log for an organization. For more information, see \"Reviewing the audit log for your organization.\"

\n

By default, the response includes up to 30 events from the past three months. Use the phrase parameter to filter results and retrieve older events. For example, use the phrase parameter with the created qualifier to filter events based on when the events occurred. For more information, see \"Reviewing the audit log for your organization.\"

\n

Use pagination to retrieve fewer or more than 30 events. For more information, see \"Using pagination in the REST API.\"

\n

This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see \"Rate limits for the REST API\" and \"Best practices for integrators.\"

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -1642,7 +1642,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1667,7 +1667,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see About authentication with SAML single sign-on.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", + "descriptionHTML": "

Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see About authentication with SAML single sign-on.

\n

The authenticated user must be an organization owner to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -1902,7 +1902,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1911,7 +1911,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3007,7 +3007,7 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the enforced_repositories is set to selected. You can add and remove individual repositories using the Enable a selected repository for immutable releases in an organization and Disable a selected repository for immutable releases in an organization endpoints.

" + "description": "

An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the enforced_repositories is set to selected. You can add and remove individual repositories using the Enable a selected repository for immutable releases in an organization and Disable a selected repository for immutable releases in an organization endpoints.

" } ], "descriptionHTML": "

Sets the immutable releases policy for repositories in an organization.

\n

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

", @@ -3067,7 +3067,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3076,7 +3076,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3949,7 +3949,7 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the enforced_repositories is set to selected. You can add and remove individual repositories using the Enable a selected repository for immutable releases in an organization and Disable a selected repository for immutable releases in an organization endpoints.

", + "description": "

An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the enforced_repositories is set to selected. You can add and remove individual repositories using the Enable a selected repository for immutable releases in an organization and Disable a selected repository for immutable releases in an organization endpoints.

", "isRequired": true } ], @@ -4182,7 +4182,7 @@ ] } ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

\n

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

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.

\n
\n

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see \"Managing security managers in your organization.\"

\n

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -4234,7 +4234,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4243,7 +4243,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4393,7 +4393,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4402,7 +4402,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4411,7 +4411,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List public organization memberships for the specified user.

\n

This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.

", + "descriptionHTML": "

List public organization memberships for the specified user.

\n

This method only lists public memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the List organizations for the authenticated user API instead.

", "codeExamples": [ { "request": { @@ -4590,7 +4590,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4599,7 +4599,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4773,7 +4773,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4782,7 +4782,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5716,7 +5716,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5725,7 +5725,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6883,7 +6883,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6892,7 +6892,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -6901,7 +6901,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -6931,7 +6931,7 @@ "description": "

Optional filter for fetching attestations with a given predicate type.\nThis option accepts provenance, sbom, release, or freeform text\nfor custom predicate types.

" } ], - "descriptionHTML": "

List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", + "descriptionHTML": "

List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", "codeExamples": [ { "request": { @@ -7294,7 +7294,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7303,7 +7303,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7312,7 +7312,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7497,7 +7497,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7506,7 +7506,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7515,7 +7515,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7551,7 +7551,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", + "descriptionHTML": "

List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", "codeExamples": [ { "request": { @@ -7754,7 +7754,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7763,7 +7763,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8223,7 +8223,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8232,7 +8232,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9570,7 +9570,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9579,7 +9579,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9588,7 +9588,7 @@ }, { "name": "repository_query", - "description": "

Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.

", + "description": "

Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.

", "in": "query", "required": false, "schema": { @@ -10076,7 +10076,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [], "statusCodes": [ { @@ -10118,7 +10118,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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 an 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.

", + "descriptionHTML": "

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 an 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.

", "codeExamples": [ { "request": { @@ -10456,7 +10456,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a custom repository role that can be used by all repositories owned by the organization. For more information on 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.

", + "descriptionHTML": "

Creates a custom repository role that can be used by all repositories owned by the organization. For more information on 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.

", "codeExamples": [ { "request": { @@ -10728,7 +10728,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an 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.

", + "descriptionHTML": "

Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an 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.

", "codeExamples": [ { "request": { @@ -11018,7 +11018,7 @@ "description": "

A list of additional permissions included in this role.

" } ], - "descriptionHTML": "

Updates a custom repository role that can be used by all repositories owned by the organization. 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.

", + "descriptionHTML": "

Updates a custom repository role that can be used by all repositories owned by the organization. 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.

", "codeExamples": [ { "request": { @@ -11292,7 +11292,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -11376,7 +11376,7 @@ "isRequired": true } ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Create a custom repository role\" endpoint instead.

\n
\n

Creates a custom repository role that can be used by all repositories owned by the organization. For more information on 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.

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Create a custom repository role\" endpoint instead.

\n
\n

Creates a custom repository role that can be used by all repositories owned by the organization. For more information on 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.

", "codeExamples": [ { "request": { @@ -11648,7 +11648,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Get a custom repository role\" endpoint instead.

\n
\n

Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an 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.

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Get a custom repository role\" endpoint instead.

\n
\n

Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see \"About custom repository roles.\"

\n

The authenticated user must be an 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.

", "codeExamples": [ { "request": { @@ -11938,7 +11938,7 @@ "description": "

A list of additional permissions included in this role.

" } ], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Update a custom repository role\" endpoint instead.

\n
\n

Updates a custom repository role that can be used by all repositories owned by the organization. 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.

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Update a custom repository role\" endpoint instead.

\n
\n

Updates a custom repository role that can be used by all repositories owned by the organization. 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.

", "codeExamples": [ { "request": { @@ -12212,7 +12212,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Delete a custom repository role\" endpoint instead.

\n
\n

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.

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"Delete a custom repository role\" endpoint instead.

\n
\n

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.

", "codeExamples": [ { "request": { @@ -12266,7 +12266,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"List fine-grained repository permissions\" endpoint instead.

\n
\n

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.

\n

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

", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed after September 6, 2023. Use the \"List fine-grained repository permissions\" endpoint instead.

\n
\n

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization.

\n

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

", "codeExamples": [ { "request": { @@ -12357,7 +12357,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

The authenticated user must be an 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.

", + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see \"About custom repository roles.\"

\n

The authenticated user must be an 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.

", "codeExamples": [ { "request": { @@ -12750,7 +12750,7 @@ ] } ], - "descriptionHTML": "

Creates a new issue field for an organization.

\n

You can find out more about issue fields in Managing issue fields in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Creates a new issue field for an organization.

\n

You can find out more about issue fields in Managing issue fields in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -13071,7 +13071,7 @@ ] } ], - "descriptionHTML": "

Updates an issue field for an organization.

\n

You can find out more about issue fields in Managing issue fields in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Updates an issue field for an organization.

\n

You can find out more about issue fields in Managing issue fields in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -13315,7 +13315,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes an issue field for an organization.

\n

You can find out more about issue fields in Managing issue fields in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Deletes an issue field for an organization.

\n

You can find out more about issue fields in Managing issue fields in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -13559,7 +13559,7 @@ ] } ], - "descriptionHTML": "

Create a new issue type for an organization.

\n

You can find out more about issue types in Managing issue types in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Create a new issue type for an organization.

\n

You can find out more about issue types in Managing issue types in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -13746,7 +13746,7 @@ ] } ], - "descriptionHTML": "

Updates an issue type for an organization.

\n

You can find out more about issue types in Managing issue types in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Updates an issue type for an organization.

\n

You can find out more about issue types in Managing issue types in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -13900,7 +13900,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes an issue type for an organization.

\n

You can find out more about issue types in Managing issue types in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", + "descriptionHTML": "

Deletes an issue type for an organization.

\n

You can find out more about issue types in Managing issue types in an organization.

\n

To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the admin:org scope to use this endpoint.

", "codeExamples": [ { "request": { @@ -13964,7 +13964,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13973,7 +13973,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13982,7 +13982,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The return hash contains failed_at and failed_reason fields which\nrepresent the time at which the invitation failed and the reason for the failure.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

", + "descriptionHTML": "

The return hash contains failed_at and failed_reason fields which\nrepresent the time at which the invitation failed and the reason for the failure.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

", "codeExamples": [ { "request": { @@ -14253,7 +14253,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14262,7 +14262,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14303,7 +14303,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The return hash contains a role field which refers to the Organization\nInvitation role and will be one of the following values: direct_member, admin,\nbilling_manager, or hiring_manager. If the invitee is not a GitHub Enterprise Cloud\nmember, the login field in the return hash will be null.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

", + "descriptionHTML": "

The return hash contains a role field which refers to the Organization\nInvitation role and will be one of the following values: direct_member, admin,\nbilling_manager, or hiring_manager. If the invitee is not a GitHub Enterprise Cloud\nmember, the login field in the return hash will be null.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

", "codeExamples": [ { "request": { @@ -14602,7 +14602,7 @@ "description": "

Specify IDs for the teams you want to invite new members to.

" } ], - "descriptionHTML": "

Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

", + "descriptionHTML": "

Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"Secondary rate limits\" and \"Dealing with secondary rate limits\" for details.

", "codeExamples": [ { "request": { @@ -14888,7 +14888,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

\n

This endpoint triggers notifications.

", + "descriptionHTML": "

Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

\n

This endpoint triggers notifications.

", "codeExamples": [ { "request": { @@ -14959,7 +14959,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14968,7 +14968,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14977,7 +14977,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List all teams associated with an invitation. In order to see invitations\nin an organization, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

", + "descriptionHTML": "

List all teams associated with an invitation. In order to see invitations\nin an organization, the authenticated user must be an organization owner.

\n

This endpoint is not available for Enterprise Managed User (EMU) organizations.

", "codeExamples": [ { "request": { @@ -15258,7 +15258,7 @@ }, { "name": "filter", - "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. 2fa_insecure means that only members with insecure 2FA methods will be returned. These options are only available for organization owners.

", + "description": "

Filter members returned in the list. 2fa_disabled means that only members without two-factor authentication enabled will be returned. 2fa_insecure means that only members with insecure 2FA methods will be returned. These options are only available for organization owners.

", "in": "query", "required": false, "schema": { @@ -15288,7 +15288,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15297,7 +15297,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16025,7 +16025,7 @@ "default": "member" } ], - "descriptionHTML": "

Only authenticated organization owners can add a member to the organization or update the member's role.

\n
    \n
  • \n

    If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending until they accept the invitation.

    \n
  • \n
  • \n

    Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.

    \n
  • \n
\n

Rate limits

\n

To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.

", + "descriptionHTML": "

Only authenticated organization owners can add a member to the organization or update the member's role.

\n
    \n
  • \n

    If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending until they accept the invitation.

    \n
  • \n
  • \n

    Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.

    \n
  • \n
\n

Rate limits

\n

To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.

", "codeExamples": [ { "request": { @@ -16456,7 +16456,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16465,7 +16465,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16742,7 +16742,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The user can publicize their own membership. (A user cannot publicize the membership for another user.)

\n

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

", + "descriptionHTML": "

The user can publicize their own membership. (A user cannot publicize the membership for another user.)

\n

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

", "codeExamples": [ { "request": { @@ -16867,7 +16867,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -16876,7 +16876,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18007,7 +18007,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18016,7 +18016,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -18798,7 +18798,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", + "descriptionHTML": "

Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see \"Managing people's access to your organization with roles.\"

\n

To list the fine-grained permissions that can be used in custom repository roles for an organization, see \"List repository fine-grained permissions for an organization.\"

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -18890,7 +18890,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", + "descriptionHTML": "

Lists the organization roles available in this organization. For more information on organization roles, see \"Using organization roles.\"

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -19257,7 +19257,7 @@ ] } ], - "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", + "descriptionHTML": "

Creates a custom organization role that can be assigned to users and teams, granting them specific\npermissions over the organization and optionally across all repositories in the organization. For\nmore information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

To include repository permissions in an organization role, you must also include the base_role\nfield, which is one of read, write, triage, maintain, or admin (or none if no base role is set). This base role provides a set of\nfine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions\nand can only be granted through the base role (like \"reading a repo\"). If you include repository permissions, those\npermissions apply across all of the repositories in the organization. You do not have to include organization permissions\nin order to add repository permissions.

\n

See \"List repository permissions\" for valid repository permissions.

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -19564,7 +19564,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes all assigned organization roles from a team. 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.

", + "descriptionHTML": "

Removes all assigned organization roles from a team. 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.

", "codeExamples": [ { "request": { @@ -19636,7 +19636,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Assigns an organization role to a team in an organization. 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.

", + "descriptionHTML": "

Assigns an organization role to a team in an organization. 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.

", "codeExamples": [ { "request": { @@ -19717,7 +19717,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Removes an organization role from a team. 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.

", + "descriptionHTML": "

Removes an organization role from a team. 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.

", "codeExamples": [ { "request": { @@ -19781,7 +19781,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -19853,7 +19853,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Assigns an organization role to a member of an organization. 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.

", + "descriptionHTML": "

Assigns an organization role to a member of an organization. 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.

", "codeExamples": [ { "request": { @@ -19934,7 +19934,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Remove an organization role 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.

", + "descriptionHTML": "

Remove an organization role 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.

", "codeExamples": [ { "request": { @@ -19998,7 +19998,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", + "descriptionHTML": "

Gets an organization role that is available to this organization. For more information on organization roles, see \"Using organization roles.\"

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the View organization roles (read_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -20320,7 +20320,7 @@ ] } ], - "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", + "descriptionHTML": "

Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see \"Managing people's access to your organization with roles.\"

\n

If the update would add repository permissions, the base_role must also be set to a value besides none, either\npreviously or as part of the update.\nIf the update sets the base_role field to none, you must also remove all of the repository\npermissions as well, otherwise the update will fail.

\n

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

\n
    \n
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -20621,7 +20621,7 @@ } ], "bodyParameters": [], - "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
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", + "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
  • An administrator for the organization.
  • \n
  • An organization member (or a member of a team) assigned a custom organization role that includes the Manage custom organization roles (write_organization_custom_org_role) permission. For more information, see \"Permissions for organization access.\"
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -20684,7 +20684,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20693,7 +20693,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20702,7 +20702,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the teams 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.

", + "descriptionHTML": "

Lists the teams 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.

", "codeExamples": [ { "request": { @@ -21006,7 +21006,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21015,7 +21015,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21024,7 +21024,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -21327,7 +21327,7 @@ }, { "name": "filter", - "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned. 2fa_insecure means that only outside collaborators with insecure 2FA methods will be returned.

", + "description": "

Filter the list of outside collaborators. 2fa_disabled means that only outside collaborators without two-factor authentication enabled will be returned. 2fa_insecure means that only outside collaborators with insecure 2FA methods will be returned.

", "in": "query", "required": false, "schema": { @@ -21342,7 +21342,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21351,7 +21351,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21566,7 +21566,7 @@ "default": false } ], - "descriptionHTML": "

When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"

", + "descriptionHTML": "

When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"Enforcing repository management policies in your enterprise.\"

", "codeExamples": [ { "request": { @@ -21621,7 +21621,7 @@ }, { "httpStatusCode": "403", - "description": "

Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"

" + "description": "

Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"Enforcing repository management policies in your enterprise.\"

" }, { "httpStatusCode": "404", @@ -21728,7 +21728,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -21737,7 +21737,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -22390,7 +22390,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -22399,7 +22399,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -23320,7 +23320,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -23329,7 +23329,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -23960,7 +23960,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -23969,7 +23969,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24947,7 +24947,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24956,7 +24956,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24965,7 +24965,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists suites of rule evaluations at the organization level.\nFor more information, see \"Managing rulesets for repositories in your organization.\"

", + "descriptionHTML": "

Lists suites of rule evaluations at the organization level.\nFor more information, see \"Managing rulesets for repositories in your organization.\"

", "codeExamples": [ { "request": { @@ -25118,7 +25118,7 @@ }, { "name": "rule_suite_id", - "description": "

The unique identifier of the rule suite result.\nTo get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites\nfor repositories and GET /orgs/{org}/rulesets/rule-suites\nfor organizations.

", + "description": "

The unique identifier of the rule suite result.\nTo get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites\nfor repositories and GET /orgs/{org}/rulesets/rule-suites\nfor organizations.

", "in": "path", "required": true, "schema": { @@ -25127,7 +25127,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"Managing rulesets for repositories in your organization.\"

", + "descriptionHTML": "

Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"Managing rulesets for repositories in your organization.\"

", "codeExamples": [ { "request": { @@ -25367,7 +25367,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25376,7 +25376,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -26694,7 +26694,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -26704,7 +26704,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -27822,7 +27822,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -27834,7 +27834,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -29249,7 +29249,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -29259,7 +29259,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -30704,7 +30704,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -30714,7 +30714,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -31837,7 +31837,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -31849,7 +31849,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -33265,7 +33265,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -33275,7 +33275,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -33468,7 +33468,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -33477,7 +33477,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -33804,7 +33804,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.

\n
", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.

\n
", "codeExamples": [ { "request": { @@ -33977,7 +33977,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.

\n
", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.

\n
", "codeExamples": [ { "request": { @@ -34040,7 +34040,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.

\n
", + "descriptionHTML": "

Warning

\n

\nClosing down notice: This operation is closing down and will be removed starting January 1, 2026. Please use the \"Organization Roles\" endpoints instead.

\n
", "codeExamples": [ { "request": { @@ -34096,7 +34096,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -34105,7 +34105,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -34296,7 +34296,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -34318,7 +34318,7 @@ { "type": "array of strings", "name": "events", - "description": "

Determines what events the hook is triggered for. Set to [\"*\"] to receive all possible events.

", + "description": "

Determines what events the hook is triggered for. Set to [\"*\"] to receive all possible events.

", "default": [ "push" ] @@ -34687,7 +34687,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -34699,7 +34699,7 @@ { "type": "array of strings", "name": "events", - "description": "

Determines what events the hook is triggered for.

", + "description": "

Determines what events the hook is triggered for.

", "default": [ "push" ] @@ -34991,7 +34991,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -35068,7 +35068,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -35120,7 +35120,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -35184,7 +35184,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/packages.json b/src/rest/data/ghec-2026-03-10/packages.json index c1579c203573..408f2b8a1c01 100644 --- a/src/rest/data/ghec-2026-03-10/packages.json +++ b/src/rest/data/ghec-2026-03-10/packages.json @@ -1068,7 +1068,7 @@ }, { "name": "visibility", - "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", + "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", "in": "query", "required": false, "schema": { @@ -1082,7 +1082,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1091,7 +1091,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1100,7 +1100,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists packages in an organization readable by the 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.\"

", + "descriptionHTML": "

Lists packages in an organization readable by the 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.\"

", "codeExamples": [ { "request": { @@ -2162,7 +2162,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specific package in an organization.

\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.\"

", + "descriptionHTML": "

Gets a specific package in an organization.

\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.\"

", "codeExamples": [ { "request": { @@ -3178,7 +3178,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -3278,7 +3278,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Restores an entire package in an organization.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Restores an entire package in an organization.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -3369,7 +3369,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3378,7 +3378,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3401,7 +3401,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists package versions for a package owned by an organization.

\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.\"

", + "descriptionHTML": "

Lists package versions for a package owned by an organization.

\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.\"

", "codeExamples": [ { "request": { @@ -3631,7 +3631,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specific package version in an organization.

\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.\"

", + "descriptionHTML": "

Gets a specific package version in an organization.

\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.\"

", "codeExamples": [ { "request": { @@ -3838,7 +3838,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -3939,7 +3939,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Restores a specific package version in an organization.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Restores a specific package version in an organization.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

The authenticated user must have admin permissions in the organization to use this endpoint. If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -5023,7 +5023,7 @@ }, { "name": "visibility", - "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", + "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", "in": "query", "required": false, "schema": { @@ -5037,7 +5037,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5046,7 +5046,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5055,7 +5055,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists packages owned by the authenticated user within the user's namespace.

\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.\"

", + "descriptionHTML": "

Lists packages owned by the authenticated user within the user's namespace.

\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.\"

", "codeExamples": [ { "request": { @@ -6097,7 +6097,7 @@ } ], "bodyParameters": [], - "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.\"

", + "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.\"

", "codeExamples": [ { "request": { @@ -7170,7 +7170,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

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

", + "descriptionHTML": "

Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

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

", "codeExamples": [ { "request": { @@ -7260,7 +7260,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Restores a package owned by the authenticated user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

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

", + "descriptionHTML": "

Restores a package owned by the authenticated user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -7341,7 +7341,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7350,7 +7350,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7373,7 +7373,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists package versions 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.\"

", + "descriptionHTML": "

Lists package versions 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.\"

", "codeExamples": [ { "request": { @@ -7601,7 +7601,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specific package version 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.\"

", + "descriptionHTML": "

Gets a specific package version 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.\"

", "codeExamples": [ { "request": { @@ -7798,7 +7798,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint.

\n

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

", + "descriptionHTML": "

Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

The authenticated user must have admin permissions in the organization to use this endpoint.

\n

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

", "codeExamples": [ { "request": { @@ -7889,7 +7889,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Restores a package version owned by the authenticated user.

\n

You can restore a deleted package version under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

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

", + "descriptionHTML": "

Restores a package version owned by the authenticated user.

\n

You can restore a deleted package version under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

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

", "codeExamples": [ { "request": { @@ -8994,7 +8994,7 @@ }, { "name": "visibility", - "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", + "description": "

The selected visibility of the packages. This parameter is optional and only filters an existing result set.

\n

The internal visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems internal is synonymous with private.\nFor the list of GitHub Packages registries that support granular permissions, see \"About permissions for GitHub Packages.\"

", "in": "query", "required": false, "schema": { @@ -9017,7 +9017,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9026,7 +9026,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9035,7 +9035,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all packages in a user's namespace for which the requesting user has access.

\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.\"

", + "descriptionHTML": "

Lists all packages in a user's namespace for which the requesting user has access.

\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.\"

", "codeExamples": [ { "request": { @@ -10097,7 +10097,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a specific package metadata for a public package owned by a 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.\"

", + "descriptionHTML": "

Gets a specific package metadata for a public package owned by a 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.\"

", "codeExamples": [ { "request": { @@ -11180,7 +11180,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance.

\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -11280,7 +11280,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Restores an entire package for a user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Restores an entire package for a user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -11371,7 +11371,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists package versions 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.\"

", + "descriptionHTML": "

Lists package versions 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.\"

", "codeExamples": [ { "request": { @@ -11618,7 +11618,7 @@ } ], "bodyParameters": [], - "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.\"

", + "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.\"

", "codeExamples": [ { "request": { @@ -11822,7 +11822,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance.

\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { @@ -11923,7 +11923,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Restores a specific package version for a user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", + "descriptionHTML": "

Restores a specific package version for a user.

\n

You can restore a deleted package under the following conditions:

\n
    \n
  • The package was deleted within the last 30 days.
  • \n
  • The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.
  • \n
\n

If the package_type belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see \"About permissions for GitHub Packages.\"

\n

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/pages.json b/src/rest/data/ghec-2026-03-10/pages.json index 03129f2a429b..879b2a198b41 100644 --- a/src/rest/data/ghec-2026-03-10/pages.json +++ b/src/rest/data/ghec-2026-03-10/pages.json @@ -555,7 +555,7 @@ { "type": "string or null", "name": "cname", - "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

" + "description": "

Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see \"Using a custom domain with GitHub Pages.\"

" }, { "type": "boolean", @@ -760,7 +760,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -769,7 +769,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/private-registries.json b/src/rest/data/ghec-2026-03-10/private-registries.json index ff05e1da0606..1e9e87b57174 100644 --- a/src/rest/data/ghec-2026-03-10/private-registries.json +++ b/src/rest/data/ghec-2026-03-10/private-registries.json @@ -19,7 +19,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -294,7 +294,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint. Required when auth_type is token or username_password. Should be omitted for OIDC auth types.

" + "description": "

The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint. Required when auth_type is token or username_password. Should be omitted for OIDC auth types.

" }, { "type": "string", @@ -315,7 +315,7 @@ { "type": "array of integers", "name": "selected_repository_ids", - "description": "

An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when visibility is set to selected. You can manage the list of selected repositories using the Update a private registry for an organization endpoint. This field should be omitted if visibility is set to all or private.

" + "description": "

An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when visibility is set to selected. You can manage the list of selected repositories using the Update a private registry for an organization endpoint. This field should be omitted if visibility is set to all or private.

" }, { "type": "string", @@ -380,7 +380,7 @@ "description": "

The JFrog identity mapping name. Optional for oidc_jfrog auth type.

" } ], - "descriptionHTML": "

Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, or oidc_jfrog), the encrypted_value and key_id fields should be omitted.

\n

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

", + "descriptionHTML": "

Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, or oidc_jfrog), the encrypted_value and key_id fields should be omitted.

\n

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

", "codeExamples": [ { "request": { @@ -1084,7 +1084,7 @@ { "type": "string", "name": "encrypted_value", - "description": "

The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint.

" + "description": "

The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint.

" }, { "type": "string", @@ -1169,7 +1169,7 @@ "description": "

The JFrog identity mapping name. Optional for oidc_jfrog auth type.

" } ], - "descriptionHTML": "

Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, or oidc_jfrog), the encrypted_value and key_id fields should be omitted.

\n

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

", + "descriptionHTML": "

Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, or oidc_jfrog), the encrypted_value and key_id fields should be omitted.

\n

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

", "codeExamples": [], "statusCodes": [ { diff --git a/src/rest/data/ghec-2026-03-10/projects.json b/src/rest/data/ghec-2026-03-10/projects.json index bfb647413433..380273d4de16 100644 --- a/src/rest/data/ghec-2026-03-10/projects.json +++ b/src/rest/data/ghec-2026-03-10/projects.json @@ -28,7 +28,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -37,7 +37,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -46,7 +46,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1623,7 +1623,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1632,7 +1632,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1641,7 +1641,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3353,7 +3353,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3362,7 +3362,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3371,7 +3371,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -5483,7 +5483,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5492,7 +5492,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -5501,7 +5501,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7594,7 +7594,7 @@ }, { "name": "q", - "description": "

Search query to filter items, see Filtering projects for more information.

", + "description": "

Search query to filter items, see Filtering projects for more information.

", "in": "query", "required": false, "schema": { @@ -7623,7 +7623,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7632,7 +7632,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7641,7 +7641,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -38516,7 +38516,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -38525,7 +38525,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -38534,7 +38534,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -39569,7 +39569,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -39578,7 +39578,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -39587,7 +39587,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -39596,7 +39596,7 @@ }, { "name": "q", - "description": "

Search query to filter items, see Filtering projects for more information.

", + "description": "

Search query to filter items, see Filtering projects for more information.

", "in": "query", "required": false, "schema": { @@ -70468,7 +70468,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -70477,7 +70477,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -70486,7 +70486,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -71538,7 +71538,7 @@ { "type": "string", "name": "filter", - "description": "

The filter query for the view. See Filtering projects for more information.

" + "description": "

The filter query for the view. See Filtering projects for more information.

" }, { "type": "array of integers", @@ -72563,7 +72563,7 @@ { "type": "string", "name": "filter", - "description": "

The filter query for the view. See Filtering projects for more information.

" + "description": "

The filter query for the view. See Filtering projects for more information.

" }, { "type": "array of integers", diff --git a/src/rest/data/ghec-2026-03-10/pulls.json b/src/rest/data/ghec-2026-03-10/pulls.json index d191e7264509..ee58ccdcbeca 100644 --- a/src/rest/data/ghec-2026-03-10/pulls.json +++ b/src/rest/data/ghec-2026-03-10/pulls.json @@ -90,7 +90,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -99,7 +99,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -108,7 +108,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists pull requests in a specified repository.

\n

Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists pull requests in a specified repository.

\n

Draft pull requests are available in public repositories with GitHub\nFree and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing\nplans, and in public and private repositories with GitHub Team and GitHub Enterprise\nCloud. For more information, see GitHub's products\nin the GitHub Help documentation.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -3556,12 +3556,12 @@ { "type": "boolean", "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" + "description": "

Indicates whether maintainers can modify the pull request.

" }, { "type": "boolean", "name": "draft", - "description": "

Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

" + "description": "

Indicates whether the pull request is a draft. See \"Draft Pull Requests\" in the GitHub Help documentation to learn more.

" }, { "type": "integer", @@ -3569,7 +3569,7 @@ "description": "

An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless title is specified.

" } ], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -7059,7 +7059,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
  • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
  • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
  • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
  • \n
", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Lists details of a pull request by providing its number.

\n

When you get, create, or edit a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see \"Checking mergeability of pull requests\".

\n

The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit.

\n

The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request:

\n
    \n
  • If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit.
  • \n
  • If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch.
  • \n
  • If rebased, merge_commit_sha represents the commit that the base branch was updated to.
  • \n
\n

Pass the appropriate media type to fetch diff and patch formats.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
  • application/vnd.github.diff: For more information, see \"git-diff\" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
  • \n
", "codeExamples": [ { "request": { @@ -7074,7 +7074,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Pass the appropriate media type to fetch diff and patch formats.

", + "description": "

Pass the appropriate media type to fetch diff and patch formats.

", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", "id": 1, @@ -10483,7 +10483,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Pass the appropriate media type to fetch diff and patch formats.

" + "description": "

Pass the appropriate media type to fetch diff and patch formats.

" }, { "httpStatusCode": "304", @@ -10586,10 +10586,10 @@ { "type": "boolean", "name": "maintainer_can_modify", - "description": "

Indicates whether maintainers can modify the pull request.

" + "description": "

Indicates whether maintainers can modify the pull request.

" } ], - "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -14080,7 +14080,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14089,7 +14089,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14098,7 +14098,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists a maximum of 250 commits for a pull request. To receive a complete\ncommit list for pull requests with more than 250 commits, use the List commits\nendpoint.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -14775,7 +14775,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14784,7 +14784,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14793,7 +14793,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the files in a specified pull request.

\n

Note

\n

\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists the files in a specified pull request.

\n

Note

\n

\nResponses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

\n
\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -15067,7 +15067,7 @@ ] } ], - "descriptionHTML": "

Merges a pull request into the base branch.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Merges a pull request into the base branch.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", "codeExamples": [ { "request": { @@ -15195,7 +15195,7 @@ { "type": "string", "name": "expected_head_sha", - "description": "

The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

" + "description": "

The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a 422 Unprocessable Entity status. You can use the \"List commits\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.

" } ], "descriptionHTML": "

Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.\nNote: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository.

", @@ -15329,7 +15329,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15338,7 +15338,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -15347,7 +15347,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -15865,7 +15865,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Provides details for a specified review comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Provides details for a specified review comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -16390,7 +16390,7 @@ "isRequired": true } ], - "descriptionHTML": "

Edits the content of a specified review comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Edits the content of a specified review comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -17021,7 +17021,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -17030,7 +17030,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -17039,7 +17039,7 @@ } ], "bodyParameters": [], - "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
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "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
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -17583,7 +17583,7 @@ { "type": "string", "name": "side", - "description": "

In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", + "description": "

In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"Diff view options\" in the GitHub Help documentation.

", "enum": [ "LEFT", "RIGHT" @@ -17597,12 +17597,12 @@ { "type": "integer", "name": "start_line", - "description": "

Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

" + "description": "

Required when using multi-line comments unless using in_reply_to. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation.

" }, { "type": "string", "name": "start_side", - "description": "

Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", + "description": "

Required when using multi-line comments unless using in_reply_to. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see \"Commenting on a pull request\" in the GitHub Help documentation. See side in this table for additional context.

", "enum": [ "LEFT", "RIGHT", @@ -17624,7 +17624,7 @@ ] } ], - "descriptionHTML": "

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\n

If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request.

\n

The position parameter is closing down. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see \"Create an issue comment.\"

\n

If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request.

\n

The position parameter is closing down. If you use position, the line, side, start_line, and start_side parameters are not required.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -18171,7 +18171,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\"\nand \"Best practices for using the REST API.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -18694,7 +18694,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

", + "descriptionHTML": "

Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.

", "codeExamples": [ { "request": { @@ -19151,7 +19151,7 @@ "description": "

An array of team slugs that will be requested.

" } ], - "descriptionHTML": "

Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Requests reviews for a pull request from a given set of users and/or teams.\nThis endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", "codeExamples": [ { "request": { @@ -26067,7 +26067,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -26076,7 +26076,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -26085,7 +26085,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists all reviews for a specified pull request. The list of reviews returns in chronological order.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -26440,7 +26440,7 @@ { "type": "string", "name": "event", - "description": "

The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

", + "description": "

The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

", "enum": [ "APPROVE", "REQUEST_CHANGES", @@ -26492,7 +26492,7 @@ ] } ], - "descriptionHTML": "

Creates a review on a specified pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note

\n

\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.

\n
\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Creates a review on a specified pull request.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

\n

Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see \"Submit a review for a pull request.\"

\n

Note

\n

\nTo comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint.

\n
\n

The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -26858,7 +26858,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Retrieves a pull request review by its ID.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Retrieves a pull request review by its ID.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -27216,7 +27216,7 @@ "isRequired": true } ], - "descriptionHTML": "

Updates the contents of a specified review summary comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Updates the contents of a specified review summary comment.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -27570,7 +27570,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -27924,7 +27924,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -27933,7 +27933,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -27942,7 +27942,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists comments for a specific pull request review.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Lists comments for a specific pull request review.

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -28478,7 +28478,7 @@ ] } ], - "descriptionHTML": "

Dismisses a specified review on a pull request.

\n

Note

\n

\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

\n
\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Dismisses a specified review on a pull request.

\n

Note

\n

\nTo dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.

\n
\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { @@ -28854,7 +28854,7 @@ ] } ], - "descriptionHTML": "

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", + "descriptionHTML": "

Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"Create a review for a pull request.\"

\n

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

\n
    \n
  • application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
  • \n
  • application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text.
  • \n
  • application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body's markdown. Response will include body_html.
  • \n
  • application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
  • \n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/rate-limit.json b/src/rest/data/ghec-2026-03-10/rate-limit.json index 020ed471ae39..c8e57280c65a 100644 --- a/src/rest/data/ghec-2026-03-10/rate-limit.json +++ b/src/rest/data/ghec-2026-03-10/rate-limit.json @@ -9,7 +9,7 @@ "subcategory": "rate-limit", "parameters": [], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nAccessing this endpoint does not count against your REST API rate limit.

\n
\n

Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:

\n
    \n
  • The core object provides your rate limit status for all non-search-related resources in the REST API.
  • \n
  • The search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"
  • \n
  • The code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"
  • \n
  • The graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"
  • \n
  • The integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"
  • \n
  • The dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"
  • \n
  • The dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"
  • \n
  • The code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"
  • \n
  • The actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"
  • \n
  • The source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"
  • \n
\n

Note

\n

\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.

\n
", + "descriptionHTML": "

Note

\n

\nAccessing this endpoint does not count against your REST API rate limit.

\n
\n

Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under resources, you'll see objects relating to different categories:

\n
    \n
  • The core object provides your rate limit status for all non-search-related resources in the REST API.
  • \n
  • The search object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"Search.\"
  • \n
  • The code_search object provides your rate limit status for the REST API for searching code. For more information, see \"Search code.\"
  • \n
  • The graphql object provides your rate limit status for the GraphQL API. For more information, see \"Resource limitations.\"
  • \n
  • The integration_manifest object provides your rate limit status for the POST /app-manifests/{code}/conversions operation. For more information, see \"Creating a GitHub App from a manifest.\"
  • \n
  • The dependency_snapshots object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"Dependency graph.\"
  • \n
  • The dependency_sbom object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"Dependency graph.\"
  • \n
  • The code_scanning_upload object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"Uploading a SARIF file to GitHub.\"
  • \n
  • The actions_runner_registration object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"Self-hosted runners.\"
  • \n
  • The source_import object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"API Versions.\"
  • \n
\n

Note

\n

\nThe rate object is closing down. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.

\n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/reactions.json b/src/rest/data/ghec-2026-03-10/reactions.json index 47b08b8c4e4e..3b3c4123005f 100644 --- a/src/rest/data/ghec-2026-03-10/reactions.json +++ b/src/rest/data/ghec-2026-03-10/reactions.json @@ -38,7 +38,7 @@ }, { "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.

", + "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.

", "in": "query", "required": false, "schema": { @@ -57,7 +57,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -66,7 +66,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -75,7 +75,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List the reactions to a commit comment.

", + "descriptionHTML": "

List the reactions to a commit comment.

", "codeExamples": [ { "request": { @@ -345,7 +345,7 @@ { "type": "string", "name": "content", - "description": "

The reaction type to add to the commit comment.

", + "description": "

The reaction type to add to the commit comment.

", "isRequired": true, "enum": [ "+1", @@ -359,7 +359,7 @@ ] } ], - "descriptionHTML": "

Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.

", + "descriptionHTML": "

Create a reaction to a commit comment. A response with an HTTP 200 status means that you already added the reaction type to this commit comment.

", "codeExamples": [ { "request": { @@ -839,7 +839,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a commit comment.

", + "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a commit comment.

", "codeExamples": [ { "request": { @@ -914,7 +914,7 @@ }, { "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.

", + "description": "

Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.

", "in": "query", "required": false, "schema": { @@ -933,7 +933,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -942,7 +942,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -951,7 +951,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List the reactions to an issue comment.

", + "descriptionHTML": "

List the reactions to an issue comment.

", "codeExamples": [ { "request": { @@ -1221,7 +1221,7 @@ { "type": "string", "name": "content", - "description": "

The reaction type to add to the issue comment.

", + "description": "

The reaction type to add to the issue comment.

", "isRequired": true, "enum": [ "+1", @@ -1235,7 +1235,7 @@ ] } ], - "descriptionHTML": "

Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.

", + "descriptionHTML": "

Create a reaction to an issue comment. A response with an HTTP 200 status means that you already added the reaction type to this issue comment.

", "codeExamples": [ { "request": { @@ -1715,7 +1715,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

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

\n
\n

Delete a reaction to an issue comment.

", + "descriptionHTML": "

Note

\n

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

\n
\n

Delete a reaction to an issue comment.

", "codeExamples": [ { "request": { @@ -1789,7 +1789,7 @@ }, { "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to an issue.

", + "description": "

Returns a single reaction type. Omit this parameter to list all reactions to an issue.

", "in": "query", "required": false, "schema": { @@ -1808,7 +1808,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1817,7 +1817,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1826,7 +1826,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List the reactions to an issue.

", + "descriptionHTML": "

List the reactions to an issue.

", "codeExamples": [ { "request": { @@ -2099,7 +2099,7 @@ { "type": "string", "name": "content", - "description": "

The reaction type to add to the issue.

", + "description": "

The reaction type to add to the issue.

", "isRequired": true, "enum": [ "+1", @@ -2113,7 +2113,7 @@ ] } ], - "descriptionHTML": "

Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.

", + "descriptionHTML": "

Create a reaction to an issue. A response with an HTTP 200 status means that you already added the reaction type to this issue.

", "codeExamples": [ { "request": { @@ -2592,7 +2592,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.

\n
\n

Delete a reaction to an issue.

", + "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id.

\n
\n

Delete a reaction to an issue.

", "codeExamples": [ { "request": { @@ -2667,7 +2667,7 @@ }, { "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.

", + "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.

", "in": "query", "required": false, "schema": { @@ -2686,7 +2686,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2695,7 +2695,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2704,7 +2704,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List the reactions to a pull request review comment.

", + "descriptionHTML": "

List the reactions to a pull request review comment.

", "codeExamples": [ { "request": { @@ -2974,7 +2974,7 @@ { "type": "string", "name": "content", - "description": "

The reaction type to add to the pull request review comment.

", + "description": "

The reaction type to add to the pull request review comment.

", "isRequired": true, "enum": [ "+1", @@ -2988,7 +2988,7 @@ ] } ], - "descriptionHTML": "

Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.

", + "descriptionHTML": "

Create a reaction to a pull request review comment. A response with an HTTP 200 status means that you already added the reaction type to this pull request review comment.

", "codeExamples": [ { "request": { @@ -3468,7 +3468,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a pull request review comment.

", + "descriptionHTML": "

Note

\n

\nYou can also specify a repository by repository_id using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.

\n
\n

Delete a reaction to a pull request review comment.

", "codeExamples": [ { "request": { @@ -3542,7 +3542,7 @@ }, { "name": "content", - "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a release.

", + "description": "

Returns a single reaction type. Omit this parameter to list all reactions to a release.

", "in": "query", "required": false, "schema": { @@ -3559,7 +3559,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3568,7 +3568,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3577,7 +3577,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List the reactions to a release.

", + "descriptionHTML": "

List the reactions to a release.

", "codeExamples": [ { "request": { @@ -3842,7 +3842,7 @@ { "type": "string", "name": "content", - "description": "

The reaction type to add to the release.

", + "description": "

The reaction type to add to the release.

", "isRequired": true, "enum": [ "+1", @@ -3854,7 +3854,7 @@ ] } ], - "descriptionHTML": "

Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.

", + "descriptionHTML": "

Create a reaction to a release. A response with a Status: 200 OK means that you already added the reaction type to this release.

", "codeExamples": [ { "request": { @@ -4330,7 +4330,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/releases.json b/src/rest/data/ghec-2026-03-10/releases.json index 7a288b88cb21..ba5404e608c7 100644 --- a/src/rest/data/ghec-2026-03-10/releases.json +++ b/src/rest/data/ghec-2026-03-10/releases.json @@ -28,7 +28,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -37,7 +37,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -46,7 +46,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.

\n

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.

", + "descriptionHTML": "

This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API.

\n

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.

", "codeExamples": [ { "request": { @@ -716,7 +716,7 @@ { "type": "string", "name": "discussion_category_name", - "description": "

If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"Managing categories for discussions in your repository.\"

" + "description": "

If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"Managing categories for discussions in your repository.\"

" }, { "type": "boolean", @@ -736,7 +736,7 @@ "default": "true" } ], - "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", + "descriptionHTML": "

Users with push access to the repository can create a release.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"Rate limits for the API\" and \"Best practices for using the REST API.\"

", "codeExamples": [ { "request": { @@ -1405,7 +1405,7 @@ "description": "

Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.

" } ], - "descriptionHTML": "

Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.

", + "descriptionHTML": "

Generate a name and body describing a release. The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.

", "codeExamples": [ { "request": { @@ -2782,7 +2782,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets a public release with the specified release ID.

\n

Note

\n

\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

\n
", + "descriptionHTML": "

Gets a public release with the specified release ID.

\n

Note

\n

\nThis returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

\n
", "codeExamples": [ { "request": { @@ -2797,7 +2797,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

", + "description": "

Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/1", "html_url": "https://github.com/octocat/Hello-World/releases/v1.0.0", @@ -3365,7 +3365,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

" + "description": "

Note: This returns an upload_url key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see \"Getting started with the REST API.\"

" }, { "httpStatusCode": "401", @@ -3466,7 +3466,7 @@ { "type": "string", "name": "discussion_category_name", - "description": "

If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"Managing categories for discussions in your repository.\"

" + "description": "

If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see \"Managing categories for discussions in your repository.\"

" } ], "descriptionHTML": "

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

", @@ -4196,7 +4196,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

To download the asset's binary content:

\n
    \n
  • If within a browser, fetch the location specified in the browser_download_url key provided in the response.
  • \n
  • Alternatively, set the Accept header of the request to\napplication/octet-stream.\nThe API will either redirect the client to the location, or stream it directly if possible.\nAPI clients should handle both a 200 or 302 response.
  • \n
", + "descriptionHTML": "

To download the asset's binary content:

\n
    \n
  • If within a browser, fetch the location specified in the browser_download_url key provided in the response.
  • \n
  • Alternatively, set the Accept header of the request to\napplication/octet-stream.\nThe API will either redirect the client to the location, or stream it directly if possible.\nAPI clients should handle both a 200 or 302 response.
  • \n
", "codeExamples": [ { "request": { @@ -4913,7 +4913,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4922,7 +4922,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5259,7 +5259,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.

\n

You need to use an HTTP client which supports SNI to make calls to this endpoint.

\n

Most libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:

\n

application/zip

\n

GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.

\n

When an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.

\n

Notes:

\n
    \n
  • GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"List release assets\"\nendpoint lists the renamed filenames. For more information and help, contact GitHub Enterprise Cloud Support.
  • \n
  • To find the release_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.
  • \n
  • If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
  • \n
", + "descriptionHTML": "

This endpoint makes use of a Hypermedia relation to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the upload_url returned in\nthe response of the Create a release endpoint to upload a release asset.

\n

You need to use an HTTP client which supports SNI to make calls to this endpoint.

\n

Most libraries will set the required Content-Length header automatically. Use the required Content-Type header to provide the media type of the asset. For a list of media types, see Media Types. For example:

\n

application/zip

\n

GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example,\nyou'll still need to pass your authentication to be able to upload an asset.

\n

When an upstream failure occurs, you will receive a 502 Bad Gateway status. This may leave an empty asset with a state of starter. It can be safely deleted.

\n

Notes:

\n
    \n
  • GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"List release assets\"\nendpoint lists the renamed filenames. For more information and help, contact GitHub Enterprise Cloud Support.
  • \n
  • To find the release_id query the GET /repos/{owner}/{repo}/releases/latest endpoint.
  • \n
  • If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.
  • \n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/repos.json b/src/rest/data/ghec-2026-03-10/repos.json index 2dc02f4162bc..83f9095bef1c 100644 --- a/src/rest/data/ghec-2026-03-10/repos.json +++ b/src/rest/data/ghec-2026-03-10/repos.json @@ -65,7 +65,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -74,7 +74,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -83,7 +83,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists repositories for the specified organization.

\n

Note

\n

\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n
", + "descriptionHTML": "

Lists repositories for the specified organization.

\n

Note

\n

\nIn order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n
", "codeExamples": [ { "request": { @@ -1063,7 +1063,7 @@ { "type": "string", "name": "license_template", - "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

" + "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

" }, { "type": "boolean", @@ -4671,7 +4671,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.

\n

Note

\n

\n
    \n
  • In order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
  • \n
  • To view merge-related settings, you must have the contents:read and contents:write permissions.
  • \n
\n
", + "descriptionHTML": "

The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.

\n

Note

\n

\n
    \n
  • In order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"
  • \n
  • To view merge-related settings, you must have the contents:read and contents:write permissions.
  • \n
\n
", "codeExamples": [ { "request": { @@ -8229,7 +8229,7 @@ { "type": "boolean", "name": "private", - "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", + "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", "default": false }, { @@ -8245,7 +8245,7 @@ { "type": "object or null", "name": "security_and_analysis", - "description": "

Specify which security and analysis features to enable or disable for the repository.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

\n

You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

", + "description": "

Specify which security and analysis features to enable or disable for the repository.

\n

To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"Managing security managers in your organization.\"

\n

For example, to enable GitHub Advanced Security, use this data in the body of the PATCH request:\n{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }.

\n

You can check which security and analysis features are currently enabled by using a GET /repos/{owner}/{repo} request.

", "childParamsGroups": [ { "type": "object", @@ -8298,7 +8298,7 @@ { "type": "object", "name": "secret_scanning_ai_detection", - "description": "

Use the status property to enable or disable secret scanning AI detection for this repository. For more information, see \"Responsible detection of generic secrets with AI.\"

", + "description": "

Use the status property to enable or disable secret scanning AI detection for this repository. For more information, see \"Responsible detection of generic secrets with AI.\"

", "childParamsGroups": [ { "type": "string", @@ -8525,7 +8525,7 @@ "default": false } ], - "descriptionHTML": "

Note: To edit a repository's topics, use the Replace all repository topics endpoint.

", + "descriptionHTML": "

Note: To edit a repository's topics, use the Replace all repository topics endpoint.

", "codeExamples": [ { "request": { @@ -12149,7 +12149,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -12158,7 +12158,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -12167,7 +12167,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -12227,7 +12227,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.

\n

For more information about viewing repository activity,\nsee \"Viewing activity and data for your repository.\"

", + "descriptionHTML": "

Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.

\n

For more information about viewing repository activity,\nsee \"Viewing activity and data for your repository.\"

", "codeExamples": [ { "request": { @@ -12500,7 +12500,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"Configuring Dependabot security updates\".

", + "descriptionHTML": "

Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see \"Configuring Dependabot security updates\".

", "codeExamples": [ { "request": { @@ -12591,7 +12591,7 @@ } ], "bodyParameters": [], - "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\".

", + "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\".

", "codeExamples": [ { "request": { @@ -12654,7 +12654,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "codeExamples": [ { "request": { @@ -12726,7 +12726,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List any syntax errors that are detected in the CODEOWNERS\nfile.

\n

For more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"

", + "descriptionHTML": "

List any syntax errors that are detected in the CODEOWNERS\nfile.

\n

For more information about the correct CODEOWNERS syntax,\nsee \"About code owners.\"

", "codeExamples": [ { "request": { @@ -12882,7 +12882,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -12891,7 +12891,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13103,7 +13103,7 @@ "description": "

JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB.

" } ], - "descriptionHTML": "

You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub Enterprise Cloud to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see \"RepositoryDispatchEvent.\"

\n

The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow.

\n

This input example shows how you can use the client_payload as a test to debug your workflow.

\n

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

", + "descriptionHTML": "

You can use this endpoint to trigger a webhook event called repository_dispatch when you want activity that happens outside of GitHub Enterprise Cloud to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the repository_dispatch event occurs. For an example repository_dispatch webhook payload, see \"RepositoryDispatchEvent.\"

\n

The client_payload parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the client_payload can include a message that a user would like to send using a GitHub Actions workflow. Or the client_payload can be used as a test to debug your workflow.

\n

This input example shows how you can use the client_payload as a test to debug your workflow.

\n

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

", "codeExamples": [ { "request": { @@ -13484,7 +13484,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"Evaluating the security settings of a repository\".

", + "descriptionHTML": "

Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see \"Evaluating the security settings of a repository\".

", "codeExamples": [ { "request": { @@ -13568,7 +13568,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability.\"

", + "descriptionHTML": "

Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability.\"

", "codeExamples": [ { "request": { @@ -13635,7 +13635,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability\".

", + "descriptionHTML": "

Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see \"Privately reporting a security vulnerability\".

", "codeExamples": [ { "request": { @@ -13702,7 +13702,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13711,7 +13711,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13844,7 +13844,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -13853,7 +13853,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14152,7 +14152,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14161,7 +14161,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -14392,7 +14392,7 @@ "description": "

ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

" } ], - "descriptionHTML": "

A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

", + "descriptionHTML": "

A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original owner, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see about repository transfers.

", "codeExamples": [ { "request": { @@ -15410,7 +15410,7 @@ } ], "bodyParameters": [], - "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\".

", + "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\".

", "codeExamples": [ { "request": { @@ -15477,7 +15477,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".

", + "descriptionHTML": "

Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"About security alerts for vulnerable dependencies\".

", "codeExamples": [ { "request": { @@ -15540,7 +15540,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".

", + "descriptionHTML": "

Disables dependency alerts and the dependency graph for a repository.\nThe authenticated user must have admin access to the repository. For more information,\nsee \"About security alerts for vulnerable dependencies\".

", "codeExamples": [ { "request": { @@ -15632,7 +15632,7 @@ "default": false } ], - "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\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.

", + "descriptionHTML": "

Creates a new repository using a repository template. Use the template_owner and template_repo route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the Get a repository endpoint and check that the is_template key is true.

\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.

", "codeExamples": [ { "request": { @@ -19137,7 +19137,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all public repositories in the order that they were created.

\n

Note:

\n
    \n
  • For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
  • \n
  • Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
  • \n
", + "descriptionHTML": "

Lists all public repositories in the order that they were created.

\n

Note:

\n
    \n
  • For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.
  • \n
  • Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of repositories.
  • \n
", "codeExamples": [ { "request": { @@ -20051,7 +20051,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -20060,7 +20060,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24656,7 +24656,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -24665,7 +24665,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25608,7 +25608,7 @@ ] } ], - "descriptionHTML": "

Store an artifact attestation and associate it with a repository.

\n

The authenticated user must have write permission to the repository and, if using a fine-grained access token, the attestations:write permission is required.

\n

Artifact attestations are meant to be created using the attest action. For more information, see our guide on using artifact attestations to establish a build's provenance.

", + "descriptionHTML": "

Store an artifact attestation and associate it with a repository.

\n

The authenticated user must have write permission to the repository and, if using a fine-grained access token, the attestations:write permission is required.

\n

Artifact attestations are meant to be created using the attest action. For more information, see our guide on using artifact attestations to establish a build's provenance.

", "codeExamples": [ { "request": { @@ -25753,7 +25753,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -25762,7 +25762,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -25771,7 +25771,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -25798,7 +25798,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List a collection of artifact attestations with a given subject digest that are associated with a repository.

\n

The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", + "descriptionHTML": "

List a collection of artifact attestations with a given subject digest that are associated with a repository.

\n

The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", "codeExamples": [ { "request": { @@ -26510,7 +26510,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -26519,7 +26519,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -27235,7 +27235,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory with the path parameter. If you omit the path parameter, you will receive the contents of the repository's root directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents for files and symlinks.
  • \n
  • application/vnd.github.html+json: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
  • application/vnd.github.object+json: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an entries attribute containing the array of objects.
  • \n
\n

If the content is a directory: The response will be an array of objects, one object for each item in the directory.

\n

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

\n

If the content is a submodule, the submodule_git_url field identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the github.com URLs (html_url and _links[\"html\"]) will have null values.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
  • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the Git Trees API.
  • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
  • \n
  • If the requested file's size is:\n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
    • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty\nstring and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
    • \n
    • Greater than 100 MB: This endpoint is not supported.
    • \n
    \n
  • \n
", + "descriptionHTML": "

Gets the contents of a file or directory in a repository. Specify the file path or directory with the path parameter. If you omit the path parameter, you will receive the contents of the repository's root directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents for files and symlinks.
  • \n
  • application/vnd.github.html+json: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
  • application/vnd.github.object+json: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an entries attribute containing the array of objects.
  • \n
\n

If the content is a directory: The response will be an array of objects, one object for each item in the directory.

\n

If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself.

\n

If the content is a submodule, the submodule_git_url field identifies the location of the submodule repository, and the sha identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links[\"git\"]) and the github.com URLs (html_url and _links[\"html\"]) will have null values.

\n

Notes:

\n
    \n
  • To get a repository's contents recursively, you can recursively get the tree.
  • \n
  • This API has an upper limit of 1,000 files for a directory. If you need to retrieve\nmore files, use the Git Trees API.
  • \n
  • Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download.
  • \n
  • If the requested file's size is:\n
      \n
    • 1 MB or smaller: All features of this endpoint are supported.
    • \n
    • Between 1-100 MB: Only the raw or object custom media types are supported. Both will work as normal, except that when using the object media type, the content field will be an empty\nstring and the encoding field will be \"none\". To get the contents of these larger files, use the raw media type.
    • \n
    • Greater than 100 MB: This endpoint is not supported.
    • \n
    \n
  • \n
", "codeExamples": [ { "response": { @@ -29583,7 +29583,7 @@ ] } ], - "descriptionHTML": "

Creates a new file or replaces an existing file in a repository.

\n

Note

\n

\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

\n
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.

", + "descriptionHTML": "

Creates a new file or replaces an existing file in a repository.

\n

Note

\n

\nIf you use this endpoint and the \"Delete a file\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

\n
\n

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The workflow scope is also required in order to modify files in the .github/workflows directory.

", "codeExamples": [ { "request": { @@ -30200,7 +30200,7 @@ ] } ], - "descriptionHTML": "

Deletes a file in a repository.

\n

You can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.

\n

The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.

\n

You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.

\n

Note

\n

\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

\n
", + "descriptionHTML": "

Deletes a file in a repository.

\n

You can provide an additional committer parameter, which is an object containing information about the committer. Or, you can provide an author parameter, which is an object containing information about the author.

\n

The author section is optional and is filled in with the committer information if omitted. If the committer information is omitted, the authenticated user's information is used.

\n

You must provide values for both name and email, whether you choose to use author or committer. Otherwise, you'll receive a 422 status code.

\n

Note

\n

\nIf you use this endpoint and the \"Create or update file contents\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.

\n
", "codeExamples": [ { "request": { @@ -30506,7 +30506,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the preferred README for a repository.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
  • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
", + "descriptionHTML": "

Gets the preferred README for a repository.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
  • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
", "codeExamples": [ { "request": { @@ -30723,7 +30723,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets the README from a repository directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
  • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
", + "descriptionHTML": "

Gets the README from a repository directory.

\n

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

\n
    \n
  • application/vnd.github.raw+json: Returns the raw file contents. This is the default if you do not specify a media type.
  • \n
  • application/vnd.github.html+json: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source Markup library.
  • \n
", "codeExamples": [ { "request": { @@ -31324,7 +31324,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -31333,7 +31333,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35970,7 +35970,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35979,7 +35979,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -35988,7 +35988,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists suites of rule evaluations at the repository level.\nFor more information, see \"Managing rulesets for a repository.\"

", + "descriptionHTML": "

Lists suites of rule evaluations at the repository level.\nFor more information, see \"Managing rulesets for a repository.\"

", "codeExamples": [ { "request": { @@ -36151,7 +36151,7 @@ }, { "name": "rule_suite_id", - "description": "

The unique identifier of the rule suite result.\nTo get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites\nfor repositories and GET /orgs/{org}/rulesets/rule-suites\nfor organizations.

", + "description": "

The unique identifier of the rule suite result.\nTo get this ID, you can use GET /repos/{owner}/{repo}/rulesets/rule-suites\nfor repositories and GET /orgs/{org}/rulesets/rule-suites\nfor organizations.

", "in": "path", "required": true, "schema": { @@ -36160,7 +36160,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"Managing rulesets for a repository.\"

", + "descriptionHTML": "

Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"Managing rulesets for a repository.\"

", "codeExamples": [ { "request": { @@ -36410,7 +36410,7 @@ }, { "name": "branch", - "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", + "description": "

The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.

", "in": "path", "required": true, "schema": { @@ -36419,7 +36419,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -36428,7 +36428,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -37829,7 +37829,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -37839,7 +37839,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -37999,7 +37999,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -38008,7 +38008,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -39337,7 +39337,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -39347,7 +39347,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -40392,7 +40392,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -40404,7 +40404,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -41800,7 +41800,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -41810,7 +41810,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -43265,7 +43265,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -43275,7 +43275,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -44325,7 +44325,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -44337,7 +44337,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -45734,7 +45734,7 @@ "properties": { "alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "errors", @@ -45744,7 +45744,7 @@ }, "security_alerts_threshold": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", @@ -45956,7 +45956,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -45965,7 +45965,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -46302,7 +46302,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -46311,7 +46311,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -46408,7 +46408,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -46569,7 +46569,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -46581,7 +46581,7 @@ { "type": "array of strings", "name": "events", - "description": "

Determines what events the hook is triggered for.

", + "description": "

Determines what events the hook is triggered for.

", "default": [ "push" ] @@ -46691,7 +46691,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -46930,7 +46930,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47094,7 +47094,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -47106,7 +47106,7 @@ { "type": "array of strings", "name": "events", - "description": "

Determines what events the hook is triggered for. This replaces the entire array of events.

", + "description": "

Determines what events the hook is triggered for. This replaces the entire array of events.

", "default": [ "push" ] @@ -47220,7 +47220,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47485,7 +47485,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47571,7 +47571,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string or number", @@ -47622,7 +47622,7 @@ }, "secret": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers)." + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest/webhooks/event-payloads/#delivery-headers)." }, "insecure_ssl": { "oneOf": [ @@ -47695,7 +47695,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -48296,7 +48296,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

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

", + "descriptionHTML": "

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/scim.json b/src/rest/data/ghec-2026-03-10/scim.json index a46572506290..7401c7e12103 100644 --- a/src/rest/data/ghec-2026-03-10/scim.json +++ b/src/rest/data/ghec-2026-03-10/scim.json @@ -768,7 +768,7 @@ "description": "" } ], - "descriptionHTML": "

Provisions organization membership for a user, and sends an activation email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see \"Reinstating a former member of your organization.\"

", + "descriptionHTML": "

Provisions organization membership for a user, and sends an activation email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see \"Reinstating a former member of your organization.\"

", "codeExamples": [ { "request": { @@ -1475,7 +1475,7 @@ ] } ], - "descriptionHTML": "

Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.

\n

You must at least provide the required values for the user: userName, name, and emails.

\n

Warning

\n

\nSetting active: false removes the user from the organization, deletes the external identity, and deletes the associated {scim_user_id}.

\n
", + "descriptionHTML": "

Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.

\n

You must at least provide the required values for the user: userName, name, and emails.

\n

Warning

\n

\nSetting active: false removes the user from the organization, deletes the external identity, and deletes the associated {scim_user_id}.

\n
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/search.json b/src/rest/data/ghec-2026-03-10/search.json index 86af5ff22beb..20f1f80025f9 100644 --- a/src/rest/data/ghec-2026-03-10/search.json +++ b/src/rest/data/ghec-2026-03-10/search.json @@ -10,7 +10,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching code\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { @@ -19,7 +19,7 @@ }, { "name": "sort", - "description": "

This field is closing down. Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: best match

", + "description": "

This field is closing down. Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: best match

", "in": "query", "required": false, "schema": { @@ -45,7 +45,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -54,7 +54,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -63,7 +63,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search:

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n
    \n
  • Only the default branch is considered. In most cases, this will be the master branch.
  • \n
  • Only files smaller than 384 KB are searchable.
  • \n
  • You must always include at least one search term when searching source code. For example, searching for language:go is not valid, while amazing language:go is.
  • \n
\n

Note

\n

\nrepository.description, repository.owner.type, and repository.owner.node_id are closing down on this endpoint and will return null in a future API version. Use the Get a repository endpoint (GET /repos/{owner}/{repo}) to retrieve full repository metadata.

\n
\n

This endpoint requires you to authenticate and limits you to 10 requests per minute.

", + "descriptionHTML": "

Searches for query terms inside of a file. This method returns up to 100 results per page.

\n

When searching for code, you can get text match metadata for the file content and file path fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find the definition of the addClass function inside jQuery repository, your query would look something like this:

\n

q=addClass+in:file+language:js+repo:jquery/jquery

\n

This query searches for the keyword addClass within a file's contents. The query limits the search to files where the language is JavaScript in the jquery/jquery repository.

\n

Considerations for code search:

\n

Due to the complexity of searching code, there are a few restrictions on how searches are performed:

\n
    \n
  • Only the default branch is considered. In most cases, this will be the master branch.
  • \n
  • Only files smaller than 384 KB are searchable.
  • \n
  • You must always include at least one search term when searching source code. For example, searching for language:go is not valid, while amazing language:go is.
  • \n
\n

Note

\n

\nrepository.description, repository.owner.type, and repository.owner.node_id are closing down on this endpoint and will return null in a future API version. Use the Get a repository endpoint (GET /repos/{owner}/{repo}) to retrieve full repository metadata.

\n
\n

This endpoint requires you to authenticate and limits you to 10 requests per minute.

", "codeExamples": [ { "request": { @@ -1039,7 +1039,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching commits\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching commits\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { @@ -1048,7 +1048,7 @@ }, { "name": "sort", - "description": "

Sorts the results of your query by author-date or committer-date. Default: best match

", + "description": "

Sorts the results of your query by author-date or committer-date. Default: best match

", "in": "query", "required": false, "schema": { @@ -1075,7 +1075,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1084,7 +1084,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1093,7 +1093,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.

\n

When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.

\n

For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:

\n

q=repo:octocat/Spoon-Knife+css

", + "descriptionHTML": "

Find commits via various criteria on the default branch (usually main). This method returns up to 100 results per page.

\n

When searching for commits, you can get text match metadata for the message field when you provide the text-match media type. For more details about how to receive highlighted search results, see Text match\nmetadata.

\n

For example, if you want to find commits related to CSS in the octocat/Spoon-Knife repository. Your query would look something like this:

\n

q=repo:octocat/Spoon-Knife+css

", "codeExamples": [ { "request": { @@ -2363,7 +2363,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching issues and pull requests\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching issues and pull requests\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { @@ -2372,7 +2372,7 @@ }, { "name": "sort", - "description": "

Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

", + "description": "

Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

", "in": "query", "required": false, "schema": { @@ -2408,7 +2408,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2417,7 +2417,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2448,7 +2448,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note

\n

\nFor requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

\n
", + "descriptionHTML": "

Find issues by state and keyword. This method returns up to 100 results per page.

\n

When searching for issues, you can get text match metadata for the issue title, issue body, and issue comment body fields when you pass the text-match media type. For more details about how to receive highlighted\nsearch results, see Text match metadata.

\n

For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.

\n

q=windows+label:bug+language:python+state:open&sort=created&order=asc

\n

This query searches for the keyword windows, within any open issue that is labeled as bug. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.

\n

Note

\n

\nFor requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the is:issue or is:pull-request qualifier will receive an HTTP 422 Unprocessable Entity response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the is qualifier, see \"Searching only issues or pull requests.\"

\n
", "codeExamples": [ { "request": { @@ -7881,7 +7881,7 @@ }, { "name": "q", - "description": "

The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.

", + "description": "

The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.

", "in": "query", "required": true, "schema": { @@ -7890,7 +7890,7 @@ }, { "name": "sort", - "description": "

Sorts the results of your query by when the label was created or updated. Default: best match

", + "description": "

Sorts the results of your query by when the label was created or updated. Default: best match

", "in": "query", "required": false, "schema": { @@ -7917,7 +7917,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7926,7 +7926,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7935,7 +7935,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.

\n

When searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:

\n

q=bug+defect+enhancement&repository_id=64778136

\n

The labels that best match the query appear first in the search results.

", + "descriptionHTML": "

Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results per page.

\n

When searching for labels, you can get text match metadata for the label name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to find labels in the linguist repository that match bug, defect, or enhancement. Your query might look like this:

\n

q=bug+defect+enhancement&repository_id=64778136

\n

The labels that best match the query appear first in the search results.

", "codeExamples": [ { "request": { @@ -8125,7 +8125,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching for repositories\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { @@ -8134,7 +8134,7 @@ }, { "name": "sort", - "description": "

Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match

", + "description": "

Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match

", "in": "query", "required": false, "schema": { @@ -8163,7 +8163,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8172,7 +8172,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8181,7 +8181,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Find repositories via various criteria. This method returns up to 100 results per page.

\n

When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

\n

q=tetris+language:assembly&sort=stars&order=desc

\n

This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.

", + "descriptionHTML": "

Find repositories via various criteria. This method returns up to 100 results per page.

\n

When searching for repositories, you can get text match metadata for the name and description fields when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:

\n

q=tetris+language:assembly&sort=stars&order=desc

\n

This query searches for repositories with the word tetris in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.

", "codeExamples": [ { "request": { @@ -8980,7 +8980,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query.

", "in": "query", "required": true, "schema": { @@ -8989,7 +8989,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8998,7 +8998,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9007,7 +9007,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.

\n

When searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

\n

q=ruby+is:featured

\n

This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.

", + "descriptionHTML": "

Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results per page. See \"Searching topics\" for a detailed list of qualifiers.

\n

When searching for topics, you can get text match metadata for the topic's short_description, description, name, or display_name field when you pass the text-match media type. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:

\n

q=ruby+is:featured

\n

This query searches for topics with the keyword ruby and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.

", "codeExamples": [ { "request": { @@ -9334,7 +9334,7 @@ "parameters": [ { "name": "q", - "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching users\" for a detailed list of qualifiers.

", + "description": "

The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see Constructing a search query. See \"Searching users\" for a detailed list of qualifiers.

", "in": "query", "required": true, "schema": { @@ -9343,7 +9343,7 @@ }, { "name": "sort", - "description": "

Sorts the results of your query by number of followers or repositories, or when the person joined GitHub Enterprise Cloud. Default: best match

", + "description": "

Sorts the results of your query by number of followers or repositories, or when the person joined GitHub Enterprise Cloud. Default: best match

", "in": "query", "required": false, "schema": { @@ -9371,7 +9371,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9380,7 +9380,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9389,7 +9389,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Find users via various criteria. This method returns up to 100 results per page.

\n

When searching for users, you can get text match metadata for the issue login, public email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you're looking for a list of popular users, you might try this query:

\n

q=tom+repos:%3E42+followers:%3E1000

\n

This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.

\n

This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"GraphQL Queries.\"

", + "descriptionHTML": "

Find users via various criteria. This method returns up to 100 results per page.

\n

When searching for users, you can get text match metadata for the issue login, public email, and name fields when you pass the text-match media type. For more details about highlighting search results, see Text match metadata. For more details about how to receive highlighted search results, see Text match metadata.

\n

For example, if you're looking for a list of popular users, you might try this query:

\n

q=tom+repos:%3E42+followers:%3E1000

\n

This query searches for users with the name tom. The results are restricted to users with more than 42 repositories and over 1,000 followers.

\n

This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see \"GraphQL Queries.\"

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/secret-scanning.json b/src/rest/data/ghec-2026-03-10/secret-scanning.json index e11b8bebdba9..c94cda1cde58 100644 --- a/src/rest/data/ghec-2026-03-10/secret-scanning.json +++ b/src/rest/data/ghec-2026-03-10/secret-scanning.json @@ -33,7 +33,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "description": "

A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -114,7 +114,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -123,7 +123,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -132,7 +132,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -180,7 +180,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the repo scope or security_events scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager, or for repositories owned by enterprise managed users.

", + "descriptionHTML": "

Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.\nTo use this endpoint, you must be a member of the enterprise, and you must use an access token with the repo scope or security_events scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager, or for repositories owned by enterprise managed users.

", "codeExamples": [ { "request": { @@ -578,7 +578,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -1905,7 +1905,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "description": "

A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -1914,7 +1914,7 @@ { "name": "exclude_secret_types", "in": "query", - "description": "

A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "description": "

A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -1986,7 +1986,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -1995,7 +1995,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2004,7 +2004,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.

", "in": "query", "required": false, "schema": { @@ -2013,7 +2013,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.

", "in": "query", "required": false, "schema": { @@ -2459,7 +2459,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -3799,7 +3799,7 @@ { "name": "secret_type", "in": "query", - "description": "

A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "description": "

A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -3808,7 +3808,7 @@ { "name": "exclude_secret_types", "in": "query", - "description": "

A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", + "description": "

A comma-separated list of secret types to exclude from the results. All default secret patterns are returned except those matching the specified types. Cannot be combined with the secret_type parameter. See \"Supported secret scanning patterns\" for a complete list of secret types.

", "required": false, "schema": { "type": "string" @@ -3880,7 +3880,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3889,7 +3889,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3898,7 +3898,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.

", "in": "query", "required": false, "schema": { @@ -3907,7 +3907,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty \"after\" query string.

", "in": "query", "required": false, "schema": { @@ -4294,7 +4294,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -5515,7 +5515,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -6805,7 +6805,7 @@ }, "secret_type_display_name": { "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": [ @@ -7777,7 +7777,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7786,7 +7786,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8435,7 +8435,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.

\n

Note

\n

\nThis endpoint requires GitHub Advanced Security.\"

\n
\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.

", + "descriptionHTML": "

Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.

\n

Note

\n

\nThis endpoint requires GitHub Advanced Security.\"

\n
\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.

", "codeExamples": [ { "request": { @@ -9183,7 +9183,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9192,7 +9192,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9602,7 +9602,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9611,7 +9611,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10473,7 +10473,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10482,7 +10482,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10891,7 +10891,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10900,7 +10900,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11315,7 +11315,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11324,7 +11324,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/data/ghec-2026-03-10/security-advisories.json b/src/rest/data/ghec-2026-03-10/security-advisories.json index d1d5cee21a71..d89ba2f3ccd4 100644 --- a/src/rest/data/ghec-2026-03-10/security-advisories.json +++ b/src/rest/data/ghec-2026-03-10/security-advisories.json @@ -125,7 +125,7 @@ { "name": "published", "in": "query", - "description": "

If specified, only return advisories that were published on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", + "description": "

If specified, only return advisories that were published on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", "schema": { "type": "string" } @@ -133,14 +133,14 @@ { "name": "updated", "in": "query", - "description": "

If specified, only return advisories that were updated on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", + "description": "

If specified, only return advisories that were updated on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", "schema": { "type": "string" } }, { "name": "modified", - "description": "

If specified, only show advisories that were updated or published on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", + "description": "

If specified, only show advisories that were updated or published on a date or date range.

\n

For more information on the syntax of the date range, see \"Understanding the search syntax.\"

", "in": "query", "schema": { "type": "string" @@ -164,7 +164,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -173,7 +173,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -196,7 +196,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -223,7 +223,7 @@ } ], "bodyParameters": [], - "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.\"

", + "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.\"

", "codeExamples": [ { "request": { @@ -1589,7 +1589,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1598,7 +1598,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -1607,7 +1607,7 @@ }, { "name": "per_page", - "description": "

The number of advisories to return per page. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of advisories to return per page. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3670,7 +3670,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3679,7 +3679,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3688,7 +3688,7 @@ }, { "name": "per_page", - "description": "

The number of advisories to return per page. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of advisories to return per page. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -7809,7 +7809,7 @@ "default": false } ], - "descriptionHTML": "

Report a security vulnerability to the maintainers of the repository.\nSee \"Privately reporting a security vulnerability\" for more information about private vulnerability reporting.

", + "descriptionHTML": "

Report a security vulnerability to the maintainers of the repository.\nSee \"Privately reporting a security vulnerability\" for more information about private vulnerability reporting.

", "codeExamples": [ { "request": { @@ -15132,7 +15132,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"Requesting a CVE identification number.\"

\n

You may request a CVE for public repositories, but cannot do so for private repositories.

\n

In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.

\n

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

", + "descriptionHTML": "

If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see \"Requesting a CVE identification number.\"

\n

You may request a CVE for public repositories, but cannot do so for private repositories.

\n

In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository.

\n

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

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/teams.json b/src/rest/data/ghec-2026-03-10/teams.json index 3994f6139643..1fb94c47fd5f 100644 --- a/src/rest/data/ghec-2026-03-10/teams.json +++ b/src/rest/data/ghec-2026-03-10/teams.json @@ -19,7 +19,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -28,7 +28,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -37,7 +37,7 @@ }, { "name": "team_type", - "description": "

Filter team results by their type. For more information, see \"What kind of team should I use?\"

", + "description": "

Filter team results by their type. For more information, see \"What kind of team should I use?\"

", "in": "query", "required": false, "schema": { @@ -377,7 +377,7 @@ "description": "

The ID of a team to set as the parent team.

" } ], - "descriptionHTML": "

To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"

\n

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".

", + "descriptionHTML": "

To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"

\n

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".

", "codeExamples": [ { "request": { @@ -2761,7 +2761,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2770,7 +2770,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3705,7 +3705,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.

\n

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.

\n

If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.

\n

If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.

\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/{owner}/{repo}.

\n
", + "descriptionHTML": "

Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.

\n

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.

\n

If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.

\n

If the repository is private, you must have at least read permission for that repository, and your token must have the repo or admin:org scope. Otherwise, you will receive a 404 Not Found response status.

\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/{owner}/{repo}.

\n
", "codeExamples": [ { "request": { @@ -4532,7 +4532,7 @@ "description": "

The permission to grant the team on this repository. We accept the following permissions to be set: pull, triage, push, maintain, admin and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

" } ], - "descriptionHTML": "

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. 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.\"

\n

Note

\n

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

\n
\n

For more information about the permission levels, see \"Repository permission levels for an organization\".

", + "descriptionHTML": "

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. 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.\"

\n

Note

\n

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

\n
\n

For more information about the permission levels, see \"Repository permission levels for an organization\".

", "codeExamples": [ { "request": { @@ -4688,7 +4688,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4697,7 +4697,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4996,7 +4996,7 @@ } ], "bodyParameters": [], - "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 Get a team by name endpoint.

\n
", + "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 Get a team by name endpoint.

\n
", "codeExamples": [ { "request": { @@ -5604,7 +5604,7 @@ "description": "

The ID of a team to set as the parent 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 Update a team endpoint.

\n
\n

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

\n

Note

\n

\nWith nested teams, the privacy for parent teams cannot be secret.

\n
", + "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 Update a team endpoint.

\n
\n

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

\n

Note

\n

\nWith nested teams, the privacy for parent teams cannot be secret.

\n
", "codeExamples": [ { "request": { @@ -6710,7 +6710,7 @@ } ], "bodyParameters": [], - "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 team endpoint.

\n
\n

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.

", + "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 team endpoint.

\n
\n

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.

", "codeExamples": [ { "request": { @@ -6771,7 +6771,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6780,7 +6780,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6789,7 +6789,7 @@ } ], "bodyParameters": [], - "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 List team repositories endpoint.

\n
", + "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 List team repositories endpoint.

\n
", "codeExamples": [ { "request": { @@ -7709,7 +7709,7 @@ } ], "bodyParameters": [], - "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 Check team permissions for a repository endpoint.

\n
\n

Note

\n

\nRepositories inherited through a parent team will also be checked.

\n
\n

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:

", + "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 Check team permissions for a repository endpoint.

\n
\n

Note

\n

\nRepositories inherited through a parent team will also be checked.

\n
\n

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the Accept header:

", "codeExamples": [ { "request": { @@ -8531,7 +8531,7 @@ ] } ], - "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 repository permissions\" endpoint.

\n
\n

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.

\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.\"

", + "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 repository permissions\" endpoint.

\n
\n

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization.

\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.\"

", "codeExamples": [ { "request": { @@ -8618,7 +8618,7 @@ } ], "bodyParameters": [], - "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 Remove a repository from a team endpoint.

\n
\n

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the 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 Remove a repository from a team endpoint.

\n
\n

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.

", "codeExamples": [ { "request": { @@ -8675,7 +8675,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8684,7 +8684,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8693,7 +8693,7 @@ } ], "bodyParameters": [], - "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 List child teams endpoint.

\n
", + "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 List child teams endpoint.

\n
", "codeExamples": [ { "request": { @@ -8985,7 +8985,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8994,7 +8994,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9583,7 +9583,7 @@ }, { "name": "per_page", - "description": "

The number of results per page for the \"members\" array (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page for the \"members\" array (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9592,7 +9592,7 @@ }, { "name": "page", - "description": "

The page number of the \"members\" array results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the \"members\" array results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9601,7 +9601,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.

\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.

", + "descriptionHTML": "

Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to.

\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.

", "codeExamples": [ { "request": { @@ -9762,7 +9762,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9787,7 +9787,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Cloud generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\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.

", + "descriptionHTML": "

Lists external groups provisioned on the enterprise that are available to an organization. You can query the groups using the display_name parameter, only groups with a group_name containing the text provided in the display_name parameter will be returned. You can also limit your page results using the per_page parameter. GitHub Enterprise Cloud generates a url-encoded page token using a cursor value for where the next page begins. For more information on cursor pagination, see \"Offset and Cursor Pagination explained.\"

\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.

", "codeExamples": [ { "request": { @@ -9897,7 +9897,7 @@ } ], "bodyParameters": [], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -10019,7 +10019,7 @@ "isRequired": true } ], - "descriptionHTML": "

Creates a connection between a team and an external group. Only one external group can be linked to a team.

\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.

", + "descriptionHTML": "

Creates a connection between a team and an external group. Only one external group can be linked to a team.

\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.

", "codeExamples": [ { "request": { @@ -10197,7 +10197,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a connection between a team and an external group.

\n

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

", + "descriptionHTML": "

Deletes a connection between a team and an external group.

\n

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

", "codeExamples": [ { "request": { @@ -10266,7 +10266,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10275,7 +10275,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10580,7 +10580,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10589,7 +10589,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -10807,7 +10807,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Team members will include the members of child teams.

\n

To get a user's membership with a team, the team must be 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}/memberships/{username}.

\n
\n

Note

\n

\nThe response contains the state of the membership and the member's role.

\n
\n

The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

", + "descriptionHTML": "

Team members will include the members of child teams.

\n

To get a user's membership with a team, the team must be 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}/memberships/{username}.

\n
\n

Note

\n

\nThe response contains the state of the membership and the member's role.

\n
\n

The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

", "codeExamples": [ { "request": { @@ -10934,7 +10934,7 @@ "default": "member" } ], - "descriptionHTML": "

Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a 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

An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person 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.

\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.

\n

Note

\n

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

\n
", + "descriptionHTML": "

Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a 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

An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person 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.

\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.

\n

Note

\n

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

\n
", "codeExamples": [ { "request": { @@ -11058,7 +11058,7 @@ } ], "bodyParameters": [], - "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
", + "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
", "codeExamples": [ { "request": { @@ -11117,7 +11117,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11126,7 +11126,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11135,7 +11135,7 @@ } ], "bodyParameters": [], - "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 List pending team invitations endpoint.

\n
\n

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.

", + "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 List pending team invitations endpoint.

\n
\n

The return hash contains a role field which refers to the Organization Invitation role and will be one of the following values: direct_member, admin, billing_manager, hiring_manager, or reinstate. If the invitee is not a GitHub Enterprise Cloud member, the login field in the return hash will be null.

", "codeExamples": [ { "request": { @@ -11417,7 +11417,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11426,7 +11426,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -11435,7 +11435,7 @@ } ], "bodyParameters": [], - "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 List team members endpoint.

\n
\n

Team members will include the members of child teams.

", + "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 List team members endpoint.

\n
\n

Team members will include the members of child teams.

", "codeExamples": [ { "request": { @@ -11638,7 +11638,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The \"Get team member\" endpoint (described below) is closing down.

\n

We recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.

\n

To list members in a team, the team must be visible to the authenticated user.

", + "descriptionHTML": "

The \"Get team member\" endpoint (described below) is closing down.

\n

We recommend using the Get team membership for a user endpoint instead. It allows you to get both active and pending memberships.

\n

To list members in a team, the team must be visible to the authenticated user.

", "codeExamples": [ { "request": { @@ -11705,7 +11705,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The \"Add team member\" endpoint (described below) is closing down.

\n

We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

\n

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

\n

To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

\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 that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

", + "descriptionHTML": "

The \"Add team member\" endpoint (described below) is closing down.

\n

We recommend using the Add or update team membership for a user endpoint instead. It allows you to invite new organization members to your teams.

\n

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

\n

To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.

\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 that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP method.\"

", "codeExamples": [ { "request": { @@ -11780,7 +11780,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

The \"Remove team member\" endpoint (described below) is closing down.

\n

We recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.

\n

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

\n

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

\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
", + "descriptionHTML": "

The \"Remove team member\" endpoint (described below) is closing down.

\n

We recommend using the Remove team membership for a user endpoint instead. It allows you to remove both active and pending memberships.

\n

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

\n

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

\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
", "codeExamples": [ { "request": { @@ -11847,7 +11847,7 @@ } ], "bodyParameters": [], - "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 Get team membership for a user endpoint.

\n
\n

Team members will include the members of child teams.

\n

To get a user's membership with a team, the team must be visible to the authenticated user.

\n

Note:\nThe response contains the state of the membership and the member's role.

\n

The role for organization owners is set to maintainer. For more information about maintainer roles, see Create 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 Get team membership for a user endpoint.

\n
\n

Team members will include the members of child teams.

\n

To get a user's membership with a team, the team must be visible to the authenticated user.

\n

Note:\nThe response contains the state of the membership and the member's role.

\n

The role for organization owners is set to maintainer. For more information about maintainer roles, see Create a team.

", "codeExamples": [ { "request": { @@ -11964,7 +11964,7 @@ "default": "member" } ], - "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.

", + "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.

", "codeExamples": [ { "request": { @@ -12082,7 +12082,7 @@ } ], "bodyParameters": [], - "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 Remove 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

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

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
", + "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 Remove 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

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

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
", "codeExamples": [ { "request": { @@ -12142,7 +12142,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -12288,7 +12288,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List IdP groups connected to a team on GitHub Enterprise Cloud.

\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

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

\n
", + "descriptionHTML": "

List IdP groups connected to a team on GitHub Enterprise Cloud.

\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

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

\n
", "codeExamples": [ { "request": { @@ -12440,7 +12440,7 @@ ] } ], - "descriptionHTML": "

Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a 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

\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.

\n
", + "descriptionHTML": "

Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a 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

\nYou can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings.

\n
", "codeExamples": [ { "request": { @@ -12567,7 +12567,7 @@ } ], "bodyParameters": [], - "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 List IdP groups for a team 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

List IdP groups connected to a team on GitHub Enterprise Cloud.

", + "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 List IdP groups for a team 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

List IdP groups connected to a team on GitHub Enterprise Cloud.

", "codeExamples": [ { "request": { @@ -12734,7 +12734,7 @@ "description": "" } ], - "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 Create or update IdP group connections 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

Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for 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 Create or update IdP group connections 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

Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty groups array will remove all connections for a team.

", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/users.json b/src/rest/data/ghec-2026-03-10/users.json index 7d017f70274b..59f35f17000d 100644 --- a/src/rest/data/ghec-2026-03-10/users.json +++ b/src/rest/data/ghec-2026-03-10/users.json @@ -1483,7 +1483,7 @@ } ], "bodyParameters": [], - "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

If you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Cloud 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 Cloud. 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.

", + "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

If you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Cloud 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 Cloud. 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.

", "codeExamples": [ { "request": { @@ -2559,7 +2559,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -2568,7 +2568,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists all users, in the order that they signed up on GitHub Enterprise Cloud. 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.

", + "descriptionHTML": "

Lists all users, in the order that they signed up on GitHub Enterprise Cloud. 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.

", "codeExamples": [ { "request": { @@ -2757,7 +2757,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

If you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Cloud 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 Cloud. 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.

", + "descriptionHTML": "

Provides publicly available information about someone with a GitHub account.

\n

If you are requesting information about an Enterprise Managed User, or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a 404 Not Found status.

\n

The email key in the following response is the publicly visible email address from your GitHub Enterprise Cloud 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 Cloud. 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.

", "codeExamples": [ { "request": { @@ -3944,7 +3944,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -3953,7 +3953,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3962,7 +3962,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -3992,7 +3992,7 @@ "description": "

Optional filter for fetching attestations with a given predicate type.\nThis option accepts provenance, sbom, release, or freeform text\nfor custom predicate types.

" } ], - "descriptionHTML": "

List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", + "descriptionHTML": "

List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", "codeExamples": [ { "request": { @@ -4444,7 +4444,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4453,7 +4453,7 @@ }, { "name": "before", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -4462,7 +4462,7 @@ }, { "name": "after", - "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", + "description": "

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "required": false, "schema": { @@ -4498,7 +4498,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", + "descriptionHTML": "

List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user.

\n

The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the attestations:read permission is required.

\n

Please note: in order to offer meaningful security benefits, an attestation's signature and timestamps must be cryptographically verified, and the identity of the attestation signer must be validated. Attestations can be verified using the GitHub CLI attestation verify command. For more information, see our guide on how to use artifact attestations to establish a build's provenance.

", "codeExamples": [ { "request": { @@ -4704,7 +4704,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -4713,7 +4713,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5245,7 +5245,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5254,7 +5254,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5563,7 +5563,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5572,7 +5572,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5581,7 +5581,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Lists your publicly visible email address, which you can set with the\nSet primary email visibility for the authenticated user\nendpoint.

\n

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

", + "descriptionHTML": "

Lists your publicly visible email address, which you can set with the\nSet primary email visibility for the authenticated user\nendpoint.

\n

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

", "codeExamples": [ { "request": { @@ -5682,7 +5682,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5691,7 +5691,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5890,7 +5890,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -5899,7 +5899,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6176,7 +6176,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

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

", + "descriptionHTML": "

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

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

", "codeExamples": [ { "request": { @@ -6318,7 +6318,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6327,7 +6327,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6524,7 +6524,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6533,7 +6533,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6788,7 +6788,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -6797,7 +6797,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7690,7 +7690,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7699,7 +7699,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7954,7 +7954,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -7963,7 +7963,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8435,7 +8435,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8444,7 +8444,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8539,7 +8539,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8548,7 +8548,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8822,7 +8822,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8831,7 +8831,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8911,7 +8911,7 @@ "parameters": [ { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -8920,7 +8920,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9037,7 +9037,7 @@ { "type": "string", "name": "key", - "description": "

The public SSH key to add to your GitHub account. For more information, see \"Checking for existing SSH keys.\"

", + "description": "

The public SSH key to add to your GitHub account. For more information, see \"Checking for existing SSH keys.\"

", "isRequired": true } ], @@ -9320,7 +9320,7 @@ }, { "name": "per_page", - "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", + "description": "

The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", @@ -9329,7 +9329,7 @@ }, { "name": "page", - "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", + "description": "

The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"

", "in": "query", "schema": { "type": "integer", diff --git a/src/rest/fixtures/openapi-check-fixture.json b/src/rest/fixtures/openapi-check-fixture.json new file mode 100644 index 000000000000..0ea8df1c58dd --- /dev/null +++ b/src/rest/fixtures/openapi-check-fixture.json @@ -0,0 +1,55 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "OpenAPI Check Fixture", + "version": "1.0.0" + }, + "servers": [ + { + "url": "https://api.github.com" + } + ], + "paths": { + "/fixture/test": { + "get": { + "summary": "Test endpoint for openapi-check validation", + "operationId": "fixture/test", + "tags": ["fixture"], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest" + }, + "parameters": [], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, + "examples": { + "default": { + "value": { + "message": "success" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "fixture", + "subcategory": "test" + } + } + } + } +} diff --git a/src/rest/scripts/utils/normalize-docs-urls.ts b/src/rest/scripts/utils/normalize-docs-urls.ts new file mode 100644 index 000000000000..703a30fab153 --- /dev/null +++ b/src/rest/scripts/utils/normalize-docs-urls.ts @@ -0,0 +1,9 @@ +// Normalize double slashes that appear in GHEC docs URLs. +// The upstream OpenAPI spec in github/github contains URLs like +// "enterprise-cloud@latest//rest/..." — the extra slash is harmless +// in browsers but triggers CCR lint errors. +const DOUBLE_SLASH_RE = /(docs\.github\.com\/[^/]+@[^/]+)\/\//g + +export function normalizeDocsUrls(html: string): string { + return html.replace(DOUBLE_SLASH_RE, '$1/') +} diff --git a/src/rest/scripts/utils/render-content.ts b/src/rest/scripts/utils/render-content.ts index bad9ab30a4ed..0fa74d19aab6 100644 --- a/src/rest/scripts/utils/render-content.ts +++ b/src/rest/scripts/utils/render-content.ts @@ -1,5 +1,6 @@ import { renderContent as _renderContent } from '@/content-render/index' import { getAlertTitles } from '@/languages/lib/get-alert-titles' +import { normalizeDocsUrls } from './normalize-docs-urls' // Wrap the renderContent function and provide the alertTitles // so they aren't blank @@ -7,5 +8,6 @@ export async function renderContent(template: string) { const context = { alertTitles: await getAlertTitles({ languageCode: 'en' }), } - return await _renderContent(template, context) + const rendered = await _renderContent(template, context) + return normalizeDocsUrls(rendered) } diff --git a/src/rest/scripts/utils/tests/normalize-docs-urls.test.ts b/src/rest/scripts/utils/tests/normalize-docs-urls.test.ts new file mode 100644 index 000000000000..6f0aca552371 --- /dev/null +++ b/src/rest/scripts/utils/tests/normalize-docs-urls.test.ts @@ -0,0 +1,37 @@ +import { describe, expect, test } from 'vitest' + +import { normalizeDocsUrls } from '../normalize-docs-urls' + +describe('normalizeDocsUrls', () => { + test('collapses double slash after versioned docs.github.com URLs', () => { + const input = + 'See docs' + const expected = + 'See docs' + expect(normalizeDocsUrls(input)).toBe(expected) + }) + + test('handles multiple double-slash occurrences in one string', () => { + const input = + 'See https://docs.github.com/enterprise-cloud@latest//rest and https://docs.github.com/enterprise-cloud@latest//graphql' + const expected = + 'See https://docs.github.com/enterprise-cloud@latest/rest and https://docs.github.com/enterprise-cloud@latest/graphql' + expect(normalizeDocsUrls(input)).toBe(expected) + }) + + test('does not modify URLs without a double slash', () => { + const input = + 'See docs' + expect(normalizeDocsUrls(input)).toBe(input) + }) + + test('does not modify double slashes in non-docs URLs', () => { + const input = 'See https://example.com//path' + expect(normalizeDocsUrls(input)).toBe(input) + }) + + test('does not modify protocol double slashes', () => { + const input = 'See https://docs.github.com/enterprise-cloud@latest/rest' + expect(normalizeDocsUrls(input)).toBe(input) + }) +}) diff --git a/src/search/components/input/SearchBarButton.tsx b/src/search/components/input/SearchBarButton.tsx index 0560fbfb8c6a..528b5a0f1e11 100644 --- a/src/search/components/input/SearchBarButton.tsx +++ b/src/search/components/input/SearchBarButton.tsx @@ -52,55 +52,56 @@ export function SearchBarButton({ return ( <> - {/* We don't want to show the input when overlay is open */} - {!isSearchOpen ? ( - <> - {/* On mobile only the IconButton is shown */} - - {/* On large and up the SearchBarButton is shown */} - - - ) : null} + + + + + + ) } diff --git a/src/search/tests/apache-arrow-stub.ts b/src/search/tests/apache-arrow-stub.ts new file mode 100644 index 000000000000..93f012dda12f --- /dev/null +++ b/src/search/tests/apache-arrow-stub.ts @@ -0,0 +1,37 @@ +import { describe, expect, it } from 'vitest' +import { execFileSync } from 'child_process' + +describe('apache-arrow stub', () => { + it('loading @elastic/elasticsearch does not trigger prototype chain deoptimizations', () => { + // The real apache-arrow creates ~40 TypedArray subclasses via + // Object.setPrototypeOf, which triggers V8 "dependent prototype + // chain changed" deoptimizations. The stub avoids this entirely. + // + // V8's --trace-deopt outputs to stderr. + let stderr = '' + try { + execFileSync(process.execPath, ['--trace-deopt', '-e', "require('@elastic/elasticsearch')"], { + encoding: 'utf-8', + timeout: 15_000, + }) + } catch (error) { + // execFileSync may throw if the process exits non-zero; + // we only care about the stderr output + stderr = (error as { stderr?: string }).stderr || '' + } + + const deoptLines = stderr + .split('\n') + .filter((line) => line.toLowerCase().includes('prototype chain')) + + expect(deoptLines).toHaveLength(0) + }) + + it('stub exports throw clear errors if Arrow methods are called', async () => { + // Verify the stub satisfies the require but throws on use + const { Client } = await import('@elastic/elasticsearch') + const client = new Client({ node: 'http://localhost:9200' }) + expect(client).toBeDefined() + expect(typeof client.search).toBe('function') + }) +}) diff --git a/src/search/vendor/apache-arrow-stub/index.js b/src/search/vendor/apache-arrow-stub/index.js new file mode 100644 index 000000000000..4cc8433611f3 --- /dev/null +++ b/src/search/vendor/apache-arrow-stub/index.js @@ -0,0 +1,16 @@ +// Stub for apache-arrow. The @elastic/elasticsearch helpers.js top-level +// requires "apache-arrow/Arrow.node", but we never call toArrowTable() or +// toArrowReader(). Loading the real package causes ~40 V8 "dependent +// prototype chain changed" deoptimizations. This stub satisfies the +// require without side effects. +'use strict' + +module.exports.tableFromIPC = function tableFromIPC() { + throw new Error('apache-arrow is stubbed out — toArrowTable() is not supported') +} + +module.exports.AsyncRecordBatchStreamReader = { + from() { + throw new Error('apache-arrow is stubbed out — toArrowReader() is not supported') + }, +} diff --git a/src/search/vendor/apache-arrow-stub/package.json b/src/search/vendor/apache-arrow-stub/package.json new file mode 100644 index 000000000000..9a34667a9c81 --- /dev/null +++ b/src/search/vendor/apache-arrow-stub/package.json @@ -0,0 +1,11 @@ +{ + "name": "apache-arrow-stub", + "version": "0.0.0", + "private": true, + "description": "Lightweight stub for apache-arrow. The real package causes ~40 V8 prototype chain deoptimizations at import time via Object.setPrototypeOf on TypedArray subclasses. We never use elasticsearch's Arrow features (toArrowTable/toArrowReader).", + "main": "index.js", + "exports": { + ".": "./index.js", + "./Arrow.node": "./index.js" + } +} diff --git a/src/versions/scripts/use-short-versions.ts b/src/versions/scripts/use-short-versions.ts index 2ab266c75b2f..2f5e1f2a8ee8 100755 --- a/src/versions/scripts/use-short-versions.ts +++ b/src/versions/scripts/use-short-versions.ts @@ -2,7 +2,7 @@ import fs from 'fs' import walk from 'walk-sync' import path from 'path' import { escapeRegExp } from 'lodash-es' -import { Tokenizer } from 'liquidjs' +import { Tokenizer, TypeGuards, type TopLevelToken, type TagToken } from 'liquidjs' import frontmatter from '@/frame/lib/read-frontmatter' import { allVersions } from '@/versions/lib/all-versions' import { deprecated, oldestSupported } from '@/versions/lib/enterprise-server-releases' @@ -26,7 +26,7 @@ interface ReplacementsMap { interface VersionData { versions?: Record | string - [key: string]: any + [key: string]: unknown } interface OperatorsMap { @@ -94,8 +94,15 @@ async function main() { if (dryRun) { console.log(contentReplacements) } else { - // Using any for frontmatter.stringify options as gray-matter types don't include lineWidth - fs.writeFileSync(file, frontmatter.stringify(newContent, data, { lineWidth: 10000 } as any)) + fs.writeFileSync( + file, + frontmatter.stringify( + newContent, + data, + // lineWidth is a js-yaml option passed through gray-matter, not in gray-matter's type definitions + { lineWidth: 10000 } as unknown as Parameters[2], + ), + ) } } @@ -125,12 +132,14 @@ try { process.exit(1) } -// Convenience function to help with readability by removing this large but unneded property. -// Using any for token objects as liquidjs doesn't provide TypeScript types -function removeInputProps(arrayOfObjects: any[]): any[] { - return arrayOfObjects.map((obj: any) => { - delete obj.input - delete obj.token.input +// Remove verbose input properties for readability in debugging output +function removeInputProps(arrayOfObjects: TopLevelToken[]): TopLevelToken[] { + return arrayOfObjects.map((obj) => { + const record = obj as unknown as Record + delete record.input + if ('token' in record && record.token && typeof record.token === 'object') { + delete (record.token as Record).input + } return obj }) } @@ -166,14 +175,17 @@ function getLiquidReplacements(content: string, file: string): ReplacementsMap { tokens .filter( - (token) => - (token.name === 'if' || token.name === 'elsif') && token.content.includes('currentVersion'), + (token): token is TagToken => + TypeGuards.isTagToken(token) && + (token.name === 'if' || token.name === 'elsif') && + token.content.includes('currentVersion'), ) .map((token) => token.content) const conditionalTokens = tokens .filter( - (xtoken) => + (xtoken): xtoken is TagToken => + TypeGuards.isTagToken(xtoken) && (xtoken.name === 'if' || xtoken.name === 'elsif') && xtoken.content.includes('currentVersion'), ) diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index 8479c5bd7d97..433c89a81b53 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -2,7 +2,7 @@ "branch_protection_configuration": { "disabled": { "descriptionHtml": "

All branch protections were disabled for a repository.

", - "summaryHtml": "

This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"About protected branches.\"\nFor information about using the APIs to manage branch protection rules, see \"Branch protection rule\" in the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"About protected branches.\"\nFor information about using the APIs to manage branch protection rules, see \"Branch protection rule\" in the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -17,13 +17,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -57,7 +57,7 @@ }, "enabled": { "descriptionHtml": "

All branch protections were enabled for a repository.

", - "summaryHtml": "

This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"About protected branches.\"\nFor information about using the APIs to manage branch protection rules, see \"Branch protection rule\" in the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"About protected branches.\"\nFor information about using the APIs to manage branch protection rules, see \"Branch protection rule\" in the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -72,13 +72,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -114,7 +114,7 @@ "branch_protection_rule": { "created": { "descriptionHtml": "

A branch protection rule was created.

", - "summaryHtml": "

This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -129,13 +129,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -154,7 +154,7 @@ { "type": "object", "name": "rule", - "description": "

The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.

", + "description": "

The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.

", "isRequired": true, "childParamsGroups": [ { @@ -392,7 +392,7 @@ }, "deleted": { "descriptionHtml": "

A branch protection rule was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -407,13 +407,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -432,7 +432,7 @@ { "type": "object", "name": "rule", - "description": "

The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.

", + "description": "

The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.

", "isRequired": true, "childParamsGroups": [ { @@ -670,7 +670,7 @@ }, "edited": { "descriptionHtml": "

A branch protection rule was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to branch protection rules. For more information, see \"About protected branches.\" For information about the APIs to manage branch protection rules, see the GraphQL documentation or \"Branch protection\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -855,13 +855,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -880,7 +880,7 @@ { "type": "object", "name": "rule", - "description": "

The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.

", + "description": "

The branch protection rule. Includes a name and all the branch protection settings applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of off, non_admins, or everyone. Actor and build lists are arrays of strings.

", "isRequired": true, "childParamsGroups": [ { @@ -1120,7 +1120,7 @@ "bypass_request_secret_scanning": { "cancelled": { "descriptionHtml": "

A secret scanning push protection bypass request was cancelled.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", "bodyParameters": [ { "type": "string", @@ -1135,13 +1135,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -1526,7 +1526,7 @@ }, "completed": { "descriptionHtml": "

A secret scanning bypass request was completed.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", "bodyParameters": [ { "type": "string", @@ -1541,13 +1541,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -1932,7 +1932,7 @@ }, "created": { "descriptionHtml": "

A secret scanning push protection bypass request was created.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", "bodyParameters": [ { "type": "string", @@ -1947,13 +1947,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -2338,7 +2338,7 @@ }, "response_dismissed": { "descriptionHtml": "

A secret scanning push protection bypass response was dismissed.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", "bodyParameters": [ { "type": "string", @@ -2353,13 +2353,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -2787,7 +2787,7 @@ }, "response_submitted": { "descriptionHtml": "

A response either approving or rejecting the secret scanning push protection bypass request was submitted.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass secret scanning push protection.

\n

For more information, see \"Enabling delegated bypass for push protection.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

\n

Note: Delegated bypass for push protection is currently in public preview and subject to change.

", "bodyParameters": [ { "type": "string", @@ -2802,13 +2802,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -3238,7 +3238,7 @@ "check_run": { "completed": { "descriptionHtml": "

A check run was completed, and a conclusion is available.

", - "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", "bodyParameters": [ { "type": "string", @@ -5355,13 +5355,13 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -5395,7 +5395,7 @@ }, "created": { "descriptionHtml": "

A new check run was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", "bodyParameters": [ { "type": "string", @@ -7512,13 +7512,13 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -7551,8 +7551,8 @@ "category": "check_run" }, "requested_action": { - "descriptionHtml": "

A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"

", - "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", + "descriptionHtml": "

A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the requested_action payload. For more information, see \"Creating CI tests with the Checks API.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", "bodyParameters": [ { "type": "string", @@ -9670,13 +9670,13 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -9722,7 +9722,7 @@ }, "rerequested": { "descriptionHtml": "

Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the rerequested payload.

", - "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a check run. For information about check runs, see \"Getting started with the Checks API.\" For information about the APIs to manage check runs, see the GraphQL API documentation or \"Check Runs\" in the REST API documentation.

\n

For activity relating to check suites, use the check-suite event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" repository permission. To receive the rerequested and requested_action event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the created and completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", "bodyParameters": [ { "type": "string", @@ -11839,13 +11839,13 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -11881,7 +11881,7 @@ "check_suite": { "completed": { "descriptionHtml": "

All check runs in a check suite have completed, and a conclusion is available.

", - "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", "bodyParameters": [ { "type": "string", @@ -11896,7 +11896,7 @@ { "type": "object", "name": "check_suite", - "description": "

The check_suite.

", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ { @@ -12733,13 +12733,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -12772,8 +12772,8 @@ "category": "check_suite" }, "requested": { - "descriptionHtml": "

Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.

", - "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", + "descriptionHtml": "

Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see the GraphQL API documentation for creating a check run or \"Create a check run\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", "bodyParameters": [ { "type": "string", @@ -12788,7 +12788,7 @@ { "type": "object", "name": "check_suite", - "description": "

The check_suite.

", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ { @@ -13667,13 +13667,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -13706,8 +13706,8 @@ "category": "check_suite" }, "rerequested": { - "descriptionHtml": "

Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.

", - "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", + "descriptionHtml": "

Someone requested to re-run the check runs in a check suite. For more information, see the GraphQL API documentation for creating a check suite or \"Create a check suite\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a check suite. For information about check suites, see \"Getting started with the Checks API.\" For information about the APIs to manage check suites, see the GraphQL API documentation or \"Check Suites\" in the REST API documentation.

\n

For activity relating to check runs, use the check_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Checks\" permission. To receive the requested and rerequested event types, the app must have at least write-level access for the \"Checks\" permission. GitHub Apps with write-level access for the \"Checks\" permission are automatically subscribed to this webhook event.

\n

Repository and organization webhooks only receive payloads for the completed event types in repositories.

\n

\n

\nThe API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n
", "bodyParameters": [ { "type": "string", @@ -13722,7 +13722,7 @@ { "type": "object", "name": "check_suite", - "description": "

The check_suite.

", + "description": "

The check_suite.

", "isRequired": true, "childParamsGroups": [ { @@ -14600,13 +14600,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -14642,7 +14642,7 @@ "code_scanning_alert": { "appeared_in_branch": { "descriptionHtml": "

A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -15143,13 +15143,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -15189,7 +15189,7 @@ }, "closed_by_user": { "descriptionHtml": "

Someone closed a code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -15842,13 +15842,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -15888,7 +15888,7 @@ }, "created": { "descriptionHtml": "

A code scanning alert was created in a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -16308,13 +16308,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -16354,7 +16354,7 @@ }, "fixed": { "descriptionHtml": "

A code scanning alert was fixed in a branch by a commit.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -16888,13 +16888,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -16934,7 +16934,7 @@ }, "reopened": { "descriptionHtml": "

A previously fixed code scanning alert reappeared in a branch.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -17355,13 +17355,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -17401,7 +17401,7 @@ }, "reopened_by_user": { "descriptionHtml": "

Someone reopened a code scanning alert.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -17776,13 +17776,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -17822,7 +17822,7 @@ }, "updated_assignment": { "descriptionHtml": "

The assignees list of a code scanning alert has been updated.

", - "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -18317,13 +18317,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -18359,7 +18359,7 @@ "commit_comment": { "created": { "descriptionHtml": "

Someone commented on a commit.

", - "summaryHtml": "

This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.

\n

For activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to commit comments. For more information about commit comments, see \"Commenting on a pull request.\" For information about the APIs to manage commit comments, see the GraphQL API documentation or \"Commit comments\" in the REST API documentation.

\n

For activity relating to comments on pull request reviews, use the pull_request_review_comment event. For activity relating to issue comments, use the issue_comment event. For activity relating to discussion comments, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -18381,13 +18381,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -18434,13 +18434,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -18464,7 +18464,7 @@ { "type": "string", "name": "ref", - "description": "

The git ref resource.

", + "description": "

The git ref resource.

", "isRequired": true }, { @@ -18504,7 +18504,7 @@ "custom_property": { "created": { "descriptionHtml": "

A new custom property was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a custom property.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a custom property.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -18595,13 +18595,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -18627,7 +18627,7 @@ }, "deleted": { "descriptionHtml": "

A custom property was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a custom property.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a custom property.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -18656,13 +18656,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -18688,7 +18688,7 @@ }, "promote_to_enterprise": { "descriptionHtml": "

A custom property was promoted to an enterprise.

", - "summaryHtml": "

This event occurs when there is activity relating to a custom property.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a custom property.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -18779,13 +18779,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -18811,7 +18811,7 @@ }, "updated": { "descriptionHtml": "

A custom property was updated.

", - "summaryHtml": "

This event occurs when there is activity relating to a custom property.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a custom property.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -18902,13 +18902,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -18936,7 +18936,7 @@ "custom_property_values": { "updated": { "descriptionHtml": "

The custom property values of a repository were updated.

", - "summaryHtml": "

This event occurs when there is activity relating to custom property values for a repository.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties for a repository, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to custom property values for a repository.

\n

For more information, see \"Managing custom properties for repositories in your organization\". For information about the APIs to manage custom properties for a repository, see \"Custom properties\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -18951,13 +18951,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -19038,13 +19038,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -19062,7 +19062,7 @@ { "type": "string", "name": "ref", - "description": "

The git ref resource.

", + "description": "

The git ref resource.

", "isRequired": true }, { @@ -19102,7 +19102,7 @@ "dependabot_alert": { "assignees_changed": { "descriptionHtml": "

The assignees for a Dependabot alert were updated.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -19910,7 +19910,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -19922,7 +19922,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -19950,7 +19950,7 @@ }, "auto_dismissed": { "descriptionHtml": "

A Dependabot alert was automatically closed by a Dependabot auto-triage rule.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -20758,7 +20758,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -20770,7 +20770,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -20798,7 +20798,7 @@ }, "auto_reopened": { "descriptionHtml": "

A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -21606,7 +21606,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -21618,7 +21618,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -21646,7 +21646,7 @@ }, "created": { "descriptionHtml": "

A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -22454,7 +22454,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -22466,7 +22466,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -22494,7 +22494,7 @@ }, "dismissed": { "descriptionHtml": "

A Dependabot alert was manually closed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -23302,7 +23302,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -23314,7 +23314,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -23342,7 +23342,7 @@ }, "fixed": { "descriptionHtml": "

A manifest file change removed a vulnerability.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -24150,7 +24150,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -24162,7 +24162,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -24190,7 +24190,7 @@ }, "reintroduced": { "descriptionHtml": "

A manifest file change introduced a vulnerable dependency that had previously been fixed.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -24998,7 +24998,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -25010,7 +25010,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -25038,7 +25038,7 @@ }, "reopened": { "descriptionHtml": "

A Dependabot alert was manually reopened.

", - "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to Dependabot alerts.

\n

For more information about Dependabot alerts, see \"About Dependabot alerts.\" For information about the API to manage Dependabot alerts, see \"Dependabot alerts\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -25846,7 +25846,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -25858,7 +25858,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -25888,7 +25888,7 @@ "deploy_key": { "created": { "descriptionHtml": "

A deploy key was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -25903,19 +25903,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "key", - "description": "

The deploy key resource.

", + "description": "

The deploy key resource.

", "isRequired": true, "childParamsGroups": [ { @@ -26008,7 +26008,7 @@ }, "deleted": { "descriptionHtml": "

A deploy key was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to deploy keys. For more information, see \"Managing deploy keys.\" For information about the APIs to manage deploy keys, see the GraphQL API documentation or \"Deploy keys\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -26023,19 +26023,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "key", - "description": "

The deploy key resource.

", + "description": "

The deploy key resource.

", "isRequired": true, "childParamsGroups": [ { @@ -26130,7 +26130,7 @@ "deployment": { "created": { "descriptionHtml": "

A deployment was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment status, use the deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to deployments. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment status, use the deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -26145,7 +26145,7 @@ { "type": "object", "name": "deployment", - "description": "

The deployment.

", + "description": "

The deployment.

", "isRequired": true, "childParamsGroups": [ { @@ -26875,13 +26875,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -28225,7 +28225,7 @@ "deployment_protection_rule": { "requested": { "descriptionHtml": "

A deployment protection rule was requested for an environment.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment protection rules. For more information, see \"Using environments for deployment.\" For information about the API to manage deployment protection rules, see the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to deployment protection rules. For more information, see \"Using environments for deployment.\" For information about the API to manage deployment protection rules, see the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -32071,7 +32071,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -32091,7 +32091,7 @@ "deployment_review": { "approved": { "descriptionHtml": "

A deployment review was approved.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment reviews. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation or deployment status, use the deployment or deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to deployment reviews. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation or deployment status, use the deployment or deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -32214,13 +32214,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -33746,7 +33746,7 @@ }, "rejected": { "descriptionHtml": "

A deployment review was rejected.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment reviews. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation or deployment status, use the deployment or deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to deployment reviews. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation or deployment status, use the deployment or deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -33869,13 +33869,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -35400,7 +35400,7 @@ }, "requested": { "descriptionHtml": "

A deployment review was requested.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment reviews. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation or deployment status, use the deployment or deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to deployment reviews. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation or deployment status, use the deployment or deployment_status event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -35415,7 +35415,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -35427,7 +35427,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -37040,7 +37040,7 @@ "deployment_status": { "created": { "descriptionHtml": "

A new deployment status was created.

", - "summaryHtml": "

This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation, use the deployment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

\n

\n

\nA webhook event is not fired for deployment statuses with an inactive state.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to deployment statuses. For more information, see \"About deployments.\" For information about the APIs to manage deployments, see the GraphQL API documentation or \"Deployments\" in the REST API documentation.

\n

For activity relating to deployment creation, use the deployment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.

\n

\n

\nA webhook event is not fired for deployment statuses with an inactive state.

\n
", "bodyParameters": [ { "type": "string", @@ -37152,7 +37152,7 @@ { "type": "object", "name": "deployment", - "description": "

The deployment.

", + "description": "

The deployment.

", "isRequired": true, "childParamsGroups": [ { @@ -37882,7 +37882,7 @@ { "type": "object", "name": "deployment_status", - "description": "

The deployment status.

", + "description": "

The deployment status.

", "isRequired": true, "childParamsGroups": [ { @@ -38594,13 +38594,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -39944,7 +39944,7 @@ "discussion": { "answered": { "descriptionHtml": "

A comment on the discussion was marked as the answer.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -40806,13 +40806,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -40846,7 +40846,7 @@ }, "category_changed": { "descriptionHtml": "

The category of a discussion was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -41515,13 +41515,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -41555,7 +41555,7 @@ }, "closed": { "descriptionHtml": "

A discussion was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -42141,13 +42141,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -42181,7 +42181,7 @@ }, "created": { "descriptionHtml": "

A discussion was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -42767,13 +42767,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -42807,7 +42807,7 @@ }, "deleted": { "descriptionHtml": "

A discussion was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -43393,13 +43393,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -43433,7 +43433,7 @@ }, "edited": { "descriptionHtml": "

The title or body on a discussion was edited, or the category of the discussion was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -44052,13 +44052,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -44092,7 +44092,7 @@ }, "labeled": { "descriptionHtml": "

A label was added to a discussion.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -44678,13 +44678,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -44768,7 +44768,7 @@ }, "locked": { "descriptionHtml": "

A discussion was locked.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -45354,13 +45354,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -45394,7 +45394,7 @@ }, "pinned": { "descriptionHtml": "

A discussion was pinned.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -45980,13 +45980,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -46020,7 +46020,7 @@ }, "reopened": { "descriptionHtml": "

A discussion was reopened.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -46606,13 +46606,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -46646,7 +46646,7 @@ }, "transferred": { "descriptionHtml": "

A discussion was transferred to another repository.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -49343,13 +49343,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -49383,7 +49383,7 @@ }, "unanswered": { "descriptionHtml": "

A comment on the discussion was unmarked as the answer.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -50272,7 +50272,7 @@ }, "unlabeled": { "descriptionHtml": "

A label was removed from a discussion.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -50858,13 +50858,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -50948,7 +50948,7 @@ }, "unlocked": { "descriptionHtml": "

A discussion was unlocked.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -51534,13 +51534,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -51574,7 +51574,7 @@ }, "unpinned": { "descriptionHtml": "

A discussion was unpinned.

", - "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a comment on a discussion, use the discussion_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -52160,13 +52160,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -52202,7 +52202,7 @@ "discussion_comment": { "created": { "descriptionHtml": "

A comment on a discussion was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -52795,13 +52795,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -52835,7 +52835,7 @@ }, "deleted": { "descriptionHtml": "

A comment on a discussion was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -53428,13 +53428,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -53468,7 +53468,7 @@ }, "edited": { "descriptionHtml": "

A comment on a discussion was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see \"GitHub Discussions.\" For information about the API to manage discussions, see the GraphQL documentation.

\n

For activity relating to a discussion as opposed to comments on a discussion, use the discussion event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.

\n

\n

\nWebhook events for GitHub Discussions are currently in public preview and subject to change.

\n
", "bodyParameters": [ { "type": "string", @@ -54083,13 +54083,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -54140,13 +54140,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -54546,13 +54546,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -54997,13 +54997,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -55403,13 +55403,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -55809,13 +55809,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -56260,13 +56260,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -56666,13 +56666,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -57072,13 +57072,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -57478,13 +57478,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -57927,13 +57927,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -58363,7 +58363,7 @@ "exemption_request_push_ruleset": { "cancelled": { "descriptionHtml": "

A push ruleset bypass request was cancelled.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass a set of push rules.

\n

For more information, see \"Managing requests to bypass push rulesets.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass a set of push rules.

\n

For more information, see \"Managing requests to bypass push rulesets.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -58378,13 +58378,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -58769,7 +58769,7 @@ }, "completed": { "descriptionHtml": "

A push ruleset bypass request was completed.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass a set of push rules.

\n

For more information, see \"Managing requests to bypass push rulesets.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass a set of push rules.

\n

For more information, see \"Managing requests to bypass push rulesets.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -58784,13 +58784,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -59175,7 +59175,7 @@ }, "created": { "descriptionHtml": "

A push ruleset bypass request was created.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass a set of push rules.

\n

For more information, see \"Managing requests to bypass push rulesets.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass a set of push rules.

\n

For more information, see \"Managing requests to bypass push rulesets.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -59190,13 +59190,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -59581,7 +59581,7 @@ }, "response_dismissed": { "descriptionHtml": "

A push ruleset bypass response was dismissed.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass a set of push rules.

\n

For more information, see \"Managing requests to bypass push rulesets.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass a set of push rules.

\n

For more information, see \"Managing requests to bypass push rulesets.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -59596,13 +59596,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -60030,7 +60030,7 @@ }, "response_submitted": { "descriptionHtml": "

A response either approving or rejecting the push ruleset bypass request was submitted.

", - "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass a set of push rules.

\n

For more information, see \"Managing requests to bypass push rulesets.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity related to a user's request to bypass a set of push rules.

\n

For more information, see \"Managing requests to bypass push rulesets.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -60045,13 +60045,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -60481,18 +60481,18 @@ "fork": { "default": { "descriptionHtml": "", - "summaryHtml": "

This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "summaryHtml": "

This event occurs when someone forks a repository. For more information, see \"Fork a repo.\" For information about the API to manage forks, see \"Forks\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", "bodyParameters": [ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "forkee", - "description": "

The created repository resource.

", + "description": "

The created repository resource.

", "isRequired": true, "childParamsGroups": [ { @@ -61220,7 +61220,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -61257,7 +61257,7 @@ "github_app_authorization": { "revoked": { "descriptionHtml": "

Someone revoked their authorization of a GitHub App.

", - "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about requests with a user access token, which require GitHub App authorization, see \"Authenticating with a GitHub App on behalf of a user.\"

", + "summaryHtml": "

This event occurs when a user revokes their authorization of a GitHub App. For more information, see \"About apps.\" For information about the API to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

\n

A GitHub App receives this webhook by default and cannot unsubscribe from this event.

\n

Anyone can revoke their authorization of a GitHub App from their GitHub account settings page. Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the 401 Bad Credentials error. For details about requests with a user access token, which require GitHub App authorization, see \"Authenticating with a GitHub App on behalf of a user.\"

", "bodyParameters": [ { "type": "string", @@ -61287,18 +61287,18 @@ "gollum": { "default": { "descriptionHtml": "", - "summaryHtml": "

This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "summaryHtml": "

This event occurs when someone creates or updates a wiki page. For more information, see \"About wikis.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", "bodyParameters": [ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -61382,7 +61382,7 @@ "installation": { "created": { "descriptionHtml": "

Someone installed a GitHub App on a user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -61397,7 +61397,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -61596,7 +61596,7 @@ }, "deleted": { "descriptionHtml": "

Someone uninstalled a GitHub App from their user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -61611,7 +61611,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -61691,7 +61691,7 @@ }, "new_permissions_accepted": { "descriptionHtml": "

Someone granted new permissions to a GitHub App.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -61706,7 +61706,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -61786,7 +61786,7 @@ }, "suspend": { "descriptionHtml": "

Someone blocked access by a GitHub App to their user or organization account.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -61801,7 +61801,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -61881,7 +61881,7 @@ }, "unsuspend": { "descriptionHtml": "

A GitHub App that was blocked from accessing a user or organization account was given access the account again.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -61896,7 +61896,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -61978,7 +61978,7 @@ "installation_repositories": { "added": { "descriptionHtml": "

A GitHub App installation was granted access to one or more repositories.

", - "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -61993,7 +61993,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -62237,7 +62237,7 @@ }, "removed": { "descriptionHtml": "

Access to one or more repositories was revoked for a GitHub App installation.

", - "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

\n

For more information about GitHub Apps, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -62252,7 +62252,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -62503,7 +62503,7 @@ "installation_target": { "renamed": { "descriptionHtml": "

Somebody renamed the user or organization account that a GitHub App is installed on.

", - "summaryHtml": "

This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see \"About apps.\" For information about the APIs to manage GitHub Apps, see the GraphQL API documentation or \"Apps\" in the REST API documentation.

", "bodyParameters": [ { "type": "object", @@ -62749,13 +62749,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "isRequired": true, "childParamsGroups": [] }, @@ -62794,7 +62794,7 @@ "issue_comment": { "created": { "descriptionHtml": "

A comment on an issue or pull request was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.

\n

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.

\n

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -62809,26 +62809,26 @@ { "type": "object", "name": "comment", - "description": "

The comment itself.

", + "description": "

The comment itself.

", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue the comment belongs to.

", + "description": "

The issue the comment belongs to.

", "isRequired": true, "childParamsGroups": [ { @@ -63773,7 +63773,7 @@ }, "deleted": { "descriptionHtml": "

A comment on an issue or pull request was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.

\n

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.

\n

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -63788,26 +63788,26 @@ { "type": "object", "name": "comment", - "description": "

The comment itself.

", + "description": "

The comment itself.

", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue the comment belongs to.

", + "description": "

The issue the comment belongs to.

", "isRequired": true, "childParamsGroups": [ { @@ -64752,7 +64752,7 @@ }, "edited": { "descriptionHtml": "

A comment on an issue or pull request was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.

\n

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.

\n

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -64788,26 +64788,26 @@ { "type": "object", "name": "comment", - "description": "

The comment itself.

", + "description": "

The comment itself.

", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue the comment belongs to.

", + "description": "

The issue the comment belongs to.

", "isRequired": true, "childParamsGroups": [ { @@ -65752,7 +65752,7 @@ }, "pinned": { "descriptionHtml": "

A comment on an issue was pinned.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.

\n

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.

\n

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -65767,26 +65767,26 @@ { "type": "object", "name": "comment", - "description": "

The comment itself.

", + "description": "

The comment itself.

", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue the comment belongs to.

", + "description": "

The issue the comment belongs to.

", "isRequired": true, "childParamsGroups": [ { @@ -66731,7 +66731,7 @@ }, "unpinned": { "descriptionHtml": "

A comment on an issue was unpinned.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.

\n

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see \"About issues\" and \"About pull requests.\" For information about the APIs to manage issue comments, see the GraphQL documentation or \"Issue comments\" in the REST API documentation.

\n

For activity relating to an issue as opposed to comments on an issue, use the issue event. For activity related to pull request reviews or pull request review comments, use the pull_request_review or pull_request_review_comment events. For more information about the different types of pull request comments, see \"Working with comments.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -66746,26 +66746,26 @@ { "type": "object", "name": "comment", - "description": "

The comment itself.

", + "description": "

The comment itself.

", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue the comment belongs to.

", + "description": "

The issue the comment belongs to.

", "isRequired": true, "childParamsGroups": [ { @@ -73546,7 +73546,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -79415,7 +79415,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -85284,7 +85284,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -91153,7 +91153,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -91190,7 +91190,7 @@ "issues": { "assigned": { "descriptionHtml": "

An issue was assigned to a user.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -91329,19 +91329,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -93279,7 +93279,7 @@ }, "closed": { "descriptionHtml": "

An issue was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -93294,19 +93294,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -94582,7 +94582,7 @@ }, "deleted": { "descriptionHtml": "

An issue was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -94597,19 +94597,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -96543,7 +96543,7 @@ }, "demilestoned": { "descriptionHtml": "

An issue was removed from a milestone.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -96558,19 +96558,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -98686,7 +98686,7 @@ }, "edited": { "descriptionHtml": "

The title or body on an issue was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -98735,19 +98735,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -100734,7 +100734,7 @@ }, "labeled": { "descriptionHtml": "

A label was added to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -100749,19 +100749,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -102747,8 +102747,8 @@ "category": "issues" }, "locked": { - "descriptionHtml": "

Conversation on an issue was locked. For more information, see \"Locking conversations.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "descriptionHtml": "

Conversation on an issue was locked. For more information, see \"Locking conversations.\"

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -102763,19 +102763,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -104669,7 +104669,7 @@ }, "milestoned": { "descriptionHtml": "

An issue was added to a milestone.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -104684,19 +104684,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -106811,7 +106811,7 @@ }, "opened": { "descriptionHtml": "

An issue was created. When a closed issue is reopened, the action will be reopened instead.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -106831,7 +106831,7 @@ { "type": "object or null", "name": "old_issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -109473,19 +109473,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -111420,8 +111420,8 @@ "category": "issues" }, "pinned": { - "descriptionHtml": "

An issue was pinned to a repository. For more information, see \"Pinning an issue to your repository.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "descriptionHtml": "

An issue was pinned to a repository. For more information, see \"Pinning an issue to your repository.\"

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -111436,19 +111436,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -113382,7 +113382,7 @@ }, "reopened": { "descriptionHtml": "

A closed issue was reopened.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -113397,19 +113397,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -115298,8 +115298,8 @@ "category": "issues" }, "transferred": { - "descriptionHtml": "

An issue was transferred to another repository. For more information, see \"Transferring an issue to another repository.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "descriptionHtml": "

An issue was transferred to another repository. For more information, see \"Transferring an issue to another repository.\"

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -115320,7 +115320,7 @@ { "type": "object", "name": "new_issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -117983,19 +117983,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -119929,7 +119929,7 @@ }, "typed": { "descriptionHtml": "

An issue type was added to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -119944,19 +119944,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -121957,7 +121957,7 @@ }, "unassigned": { "descriptionHtml": "

A user was unassigned from an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -122097,19 +122097,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -124047,7 +124047,7 @@ }, "unlabeled": { "descriptionHtml": "

A label was removed from an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -124062,19 +124062,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -126060,8 +126060,8 @@ "category": "issues" }, "unlocked": { - "descriptionHtml": "

Conversation on an issue was locked. For more information, see \"Locking conversations.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "descriptionHtml": "

Conversation on an issue was locked. For more information, see \"Locking conversations.\"

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -126076,19 +126076,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -127981,8 +127981,8 @@ "category": "issues" }, "unpinned": { - "descriptionHtml": "

An issue was unpinned from a repository. For more information, see \"Pinning an issue to your repository.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "descriptionHtml": "

An issue was unpinned from a repository. For more information, see \"Pinning an issue to your repository.\"

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -127997,19 +127997,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -129943,7 +129943,7 @@ }, "untyped": { "descriptionHtml": "

An issue type was removed from an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an issue. For more information about issues, see \"About issues.\" For information about the APIs to manage issues, see the GraphQL documentation or \"Issues\" in the REST API documentation.

\n

For activity relating to a comment on an issue, use the issue_comment event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -129958,19 +129958,19 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { "type": "object", "name": "issue", - "description": "

The issue itself.

", + "description": "

The issue itself.

", "isRequired": true, "childParamsGroups": [ { @@ -131973,7 +131973,7 @@ "label": { "created": { "descriptionHtml": "

A label was created.

", - "summaryHtml": "

This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.

\n

If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.

\n

If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -131988,13 +131988,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -132077,7 +132077,7 @@ }, "deleted": { "descriptionHtml": "

A label was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.

\n

If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.

\n

If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -132092,13 +132092,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -132182,7 +132182,7 @@ }, "edited": { "descriptionHtml": "

A label's name, description, or color was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.

\n

If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to labels. For more information, see \"Managing labels.\" For information about the APIs to manage labels, see the GraphQL documentation or \"Labels\" in the REST API documentation.

\n

If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the labeled or unlabeled action type for the issues, pull_request, or discussion events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -132243,13 +132243,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -132335,7 +132335,7 @@ "marketplace_purchase": { "cancelled": { "descriptionHtml": "

Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -132356,13 +132356,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -132677,7 +132677,7 @@ }, "changed": { "descriptionHtml": "

Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -132698,13 +132698,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -133019,7 +133019,7 @@ }, "pending_change": { "descriptionHtml": "

Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the changed or cancelled event will be sent.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -133040,13 +133040,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -133361,7 +133361,7 @@ }, "pending_change_cancelled": { "descriptionHtml": "

Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -133382,13 +133382,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -133703,7 +133703,7 @@ }, "purchased": { "descriptionHtml": "

Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.

", - "summaryHtml": "

This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"GitHub Marketplace.\" For information about the APIs to manage GitHub Marketplace listings, see the GraphQL documentation or \"GitHub Marketplace\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -133724,13 +133724,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -134047,7 +134047,7 @@ "member": { "added": { "descriptionHtml": "

A GitHub user accepted an invitation to a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -134100,13 +134100,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -134266,7 +134266,7 @@ }, "edited": { "descriptionHtml": "

Permissions were changed for a collaborator on a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -134319,13 +134319,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -134485,7 +134485,7 @@ }, "removed": { "descriptionHtml": "

A collaborator was removed from a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to collaborators in a repository. For more information, see \"Adding outside collaborators to repositories in your organization.\" For more information about the API to manage repository collaborators, see the GraphQL API documentation or \"Collaborators\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -134500,13 +134500,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -134668,7 +134668,7 @@ "membership": { "added": { "descriptionHtml": "

An organization member was added to a team.

", - "summaryHtml": "

This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the APIs to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the APIs to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -134683,13 +134683,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -135068,7 +135068,7 @@ }, "removed": { "descriptionHtml": "

An organization member was removed from a team.

", - "summaryHtml": "

This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the APIs to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to team membership. For more information, see \"About teams.\" For more information about the APIs to manage team memberships, see the GraphQL API documentation or \"Team members\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -135083,13 +135083,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -135471,7 +135471,7 @@ "merge_group": { "checks_requested": { "descriptionHtml": "

Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.

\n

When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.

", - "summaryHtml": "

This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -135486,7 +135486,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -135620,7 +135620,7 @@ }, "destroyed": { "descriptionHtml": "

The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.

\n

When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.

", - "summaryHtml": "

This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"Managing a merge queue.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -135645,7 +135645,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -135796,7 +135796,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -135893,7 +135893,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -135929,7 +135929,7 @@ "milestone": { "closed": { "descriptionHtml": "

A milestone was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", + "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", "bodyParameters": [ { "type": "string", @@ -135944,13 +135944,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -136212,7 +136212,7 @@ }, "created": { "descriptionHtml": "

A milestone was created.

", - "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", + "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", "bodyParameters": [ { "type": "string", @@ -136227,13 +136227,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -136494,7 +136494,7 @@ }, "deleted": { "descriptionHtml": "

A milestone was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", + "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", "bodyParameters": [ { "type": "string", @@ -136509,13 +136509,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -136777,7 +136777,7 @@ }, "edited": { "descriptionHtml": "

A milestone was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", + "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", "bodyParameters": [ { "type": "string", @@ -136839,13 +136839,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -137107,7 +137107,7 @@ }, "opened": { "descriptionHtml": "

A milestone was opened.

", - "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", + "summaryHtml": "

This event occurs when there is activity relating to milestones. For more information, see \"About milestones.\" For information about the APIs to manage milestones, see the GraphQL documentation or \"Milestones\" in the REST API documentation.

\n

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.

", "bodyParameters": [ { "type": "string", @@ -137122,13 +137122,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -137391,7 +137391,7 @@ "org_block": { "blocked": { "descriptionHtml": "

A user was blocked from the organization.

", - "summaryHtml": "

This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"Blocking a user from your organization.\" For information about the APIs to manage blocked users, see the GraphQL documentation or \"Blocking users\" in the REST API documentation.

\n

If you want to receive an event when members are added or removed from an organization, use the organization event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.

", + "summaryHtml": "

This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"Blocking a user from your organization.\" For information about the APIs to manage blocked users, see the GraphQL documentation or \"Blocking users\" in the REST API documentation.

\n

If you want to receive an event when members are added or removed from an organization, use the organization event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -137531,13 +137531,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -137571,7 +137571,7 @@ }, "unblocked": { "descriptionHtml": "

A previously blocked user was unblocked from the organization.

", - "summaryHtml": "

This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"Blocking a user from your organization.\" For information about the APIs to manage blocked users, see the GraphQL documentation or \"Blocking users\" in the REST API documentation.

\n

If you want to receive an event when members are added or removed from an organization, use the organization event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.

", + "summaryHtml": "

This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"Blocking a user from your organization.\" For information about the APIs to manage blocked users, see the GraphQL documentation or \"Blocking users\" in the REST API documentation.

\n

If you want to receive an event when members are added or removed from an organization, use the organization event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -137711,13 +137711,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -137837,7 +137837,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "isRequired": true, "childParamsGroups": [] }, @@ -137885,14 +137885,14 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -137994,14 +137994,14 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -138036,14 +138036,14 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -138112,7 +138112,7 @@ "organization": { "deleted": { "descriptionHtml": "

An organization was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -138127,13 +138127,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -138333,7 +138333,7 @@ }, "member_added": { "descriptionHtml": "

A member accepted an invitation to join an organization.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -138348,13 +138348,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -138555,7 +138555,7 @@ }, "member_invited": { "descriptionHtml": "

A member was invited to join the organization.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -138570,13 +138570,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -138932,7 +138932,7 @@ }, "member_removed": { "descriptionHtml": "

A member was removed from the organization.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -138947,13 +138947,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -139154,7 +139154,7 @@ }, "renamed": { "descriptionHtml": "

The name of an organization was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to an organization and its members. For more information, see \"About organizations.\" For information about the APIs to manage organizations, see the GraphQL documentation or \"Organizations\" in the REST API documentation.

\n

If you want to receive an event when a non-member is blocked or unblocked from an organization, use the org_block event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -139188,13 +139188,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -139396,7 +139396,7 @@ "package": { "published": { "descriptionHtml": "

A package was published to a registry.

", - "summaryHtml": "

This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -139411,13 +139411,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -140504,7 +140504,7 @@ }, "updated": { "descriptionHtml": "

A previously published package was updated.

", - "summaryHtml": "

This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.

", + "summaryHtml": "

This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.

", "bodyParameters": [ { "type": "string", @@ -140519,13 +140519,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -141374,12 +141374,12 @@ "page_build": { "default": { "descriptionHtml": "", - "summaryHtml": "

This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"Configuring a publishing source for your GitHub Pages site.\" For information about the API to manage GitHub Pages, see \"Pages\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.

", + "summaryHtml": "

This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see \"Configuring a publishing source for your GitHub Pages site.\" For information about the API to manage GitHub Pages, see \"Pages\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pages\" repository permission.

", "bodyParameters": [ { "type": "object", "name": "build", - "description": "

The List GitHub Pages builds itself.

", + "description": "

The List GitHub Pages builds itself.

", "isRequired": true, "childParamsGroups": [ { @@ -141562,7 +141562,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -141574,7 +141574,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -141610,7 +141610,7 @@ "personal_access_token_request": { "approved": { "descriptionHtml": "

A fine-grained personal access token request was approved.

", - "summaryHtml": "

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -141935,7 +141935,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -141955,7 +141955,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "isRequired": true, "childParamsGroups": [] } @@ -141969,7 +141969,7 @@ }, "cancelled": { "descriptionHtml": "

A fine-grained personal access token request was cancelled by the requester.

", - "summaryHtml": "

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -142294,7 +142294,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -142314,7 +142314,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "isRequired": true, "childParamsGroups": [] } @@ -142328,7 +142328,7 @@ }, "created": { "descriptionHtml": "

A fine-grained personal access token request was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -142653,7 +142653,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -142673,7 +142673,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] } ], @@ -142686,7 +142686,7 @@ }, "denied": { "descriptionHtml": "

A fine-grained personal access token request was denied.

", - "summaryHtml": "

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"Creating a personal access token.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -143018,7 +143018,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -143031,7 +143031,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "isRequired": true, "childParamsGroups": [] } @@ -143084,7 +143084,7 @@ { "type": "string", "name": "secret", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

" }, { "type": "string", @@ -143222,7 +143222,7 @@ "project_card": { "converted": { "descriptionHtml": "

A note in a project (classic) was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -143259,13 +143259,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -143501,7 +143501,7 @@ }, "created": { "descriptionHtml": "

A card was added to a project (classic).

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -143516,13 +143516,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -143758,7 +143758,7 @@ }, "deleted": { "descriptionHtml": "

A card on a project (classic) was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -143773,13 +143773,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -144016,7 +144016,7 @@ }, "edited": { "descriptionHtml": "

A note on a project (classic) was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -144053,13 +144053,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -144295,7 +144295,7 @@ }, "moved": { "descriptionHtml": "

A card on a project (classic) was moved to another column or to another position in its column.

", - "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a card on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a column on a project (classic), use the project and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -144331,13 +144331,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -144577,7 +144577,7 @@ "project": { "closed": { "descriptionHtml": "

A project (classic) was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -144592,13 +144592,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -144840,7 +144840,7 @@ }, "created": { "descriptionHtml": "

A project (classic) was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -144855,13 +144855,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -145103,7 +145103,7 @@ }, "deleted": { "descriptionHtml": "

A project (classic) was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -145118,13 +145118,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -145365,7 +145365,7 @@ }, "edited": { "descriptionHtml": "

The name or description of a project (classic) was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -145413,13 +145413,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -145660,7 +145660,7 @@ }, "reopened": { "descriptionHtml": "

A project (classic) was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a card or column on a project (classic), use the project_card and project_column event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -145675,13 +145675,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -145925,7 +145925,7 @@ "project_column": { "created": { "descriptionHtml": "

A column was added to a project (classic).

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -145940,13 +145940,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -146039,7 +146039,7 @@ }, "deleted": { "descriptionHtml": "

A column was deleted from a project (classic).

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -146054,13 +146054,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -146153,7 +146153,7 @@ }, "edited": { "descriptionHtml": "

The name of a column on a project (classic) was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -146189,13 +146189,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -146288,7 +146288,7 @@ }, "moved": { "descriptionHtml": "

A column was moved to a new position on a project (classic).

", - "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a column on a project (classic). For more information, see \"About projects (classic).\" For information about the API to manage classic projects, see the GraphQL API documentation or \"Projects (classic)\" in the REST API documentation.

\n

For activity relating to a project (classic) or a card on a project (classic), use the project and project_card event.

\n

This event relates to projects (classic) only. For activity relating to the new Projects experience, use the projects_v2 event instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -146303,13 +146303,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -146405,7 +146405,7 @@ "projects_v2": { "closed": { "descriptionHtml": "

A project in the organization was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -146420,7 +146420,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -147141,7 +147141,7 @@ }, "created": { "descriptionHtml": "

A project in the organization was created.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -147156,7 +147156,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -147877,7 +147877,7 @@ }, "deleted": { "descriptionHtml": "

A project in the organization was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -147892,7 +147892,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -148613,7 +148613,7 @@ }, "edited": { "descriptionHtml": "

The title, description, or README of a project in the organization was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -148704,7 +148704,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -149425,7 +149425,7 @@ }, "reopened": { "descriptionHtml": "

A project in the organization was reopened.

", - "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a item on a project, use the projects_v2_item event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -149440,7 +149440,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -150162,8 +150162,8 @@ }, "projects_v2_item": { "archived": { - "descriptionHtml": "

An item on an organization project was archived. For more information, see \"Archiving items from your project.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "descriptionHtml": "

An item on an organization project was archived. For more information, see \"Archiving items from your project.\"

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -150203,7 +150203,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -150423,7 +150423,7 @@ }, "converted": { "descriptionHtml": "

A draft issue in an organization project was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -150463,7 +150463,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -150683,7 +150683,7 @@ }, "created": { "descriptionHtml": "

An item was added to a project in the organization.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -150698,7 +150698,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -150918,7 +150918,7 @@ }, "deleted": { "descriptionHtml": "

An item was deleted from a project in the organization.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -150933,7 +150933,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -151153,7 +151153,7 @@ }, "edited": { "descriptionHtml": "

The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -151246,7 +151246,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -151466,7 +151466,7 @@ }, "reordered": { "descriptionHtml": "

The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -151506,7 +151506,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -151725,8 +151725,8 @@ "category": "projects_v2_item" }, "restored": { - "descriptionHtml": "

An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"

", - "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "descriptionHtml": "

An archived item on an organization project was restored from the archive. For more information, see \"Archiving items from your project.\"

", + "summaryHtml": "

This event occurs when there is activity relating to an item on an organization-level project. For more information, see \"About Projects.\" For information about the Projects API, see the GraphQL documentation.

\n

For activity relating to a project (instead of an item on a project), use the projects_v2 event. For activity relating to Projects (classic), use the project, project_card, and project_column events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nWebhook events for projects are currently in public preview and subject to change. To share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -151766,7 +151766,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -151988,7 +151988,7 @@ "projects_v2_status_update": { "created": { "descriptionHtml": "

A status update was added to a project in the organization.

", - "summaryHtml": "

This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"

\n

For activity relating to a project, use the projects_v2 event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"

\n

For activity relating to a project, use the projects_v2 event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -152003,7 +152003,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -152229,7 +152229,7 @@ }, "deleted": { "descriptionHtml": "

A status update was removed from a project in the organization.

", - "summaryHtml": "

This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"

\n

For activity relating to a project, use the projects_v2 event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"

\n

For activity relating to a project, use the projects_v2 event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -152244,7 +152244,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -152470,7 +152470,7 @@ }, "edited": { "descriptionHtml": "

A status update was edited on a project in the organization.

", - "summaryHtml": "

This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"

\n

For activity relating to a project, use the projects_v2 event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"About Projects.\"

\n

For activity relating to a project, use the projects_v2 event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.

\n

\n

\nTo share feedback about projects webhooks with GitHub, see the Projects webhook feedback discussion.

\n
", "bodyParameters": [ { "type": "string", @@ -152576,7 +152576,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -152804,18 +152804,18 @@ "public": { "default": { "descriptionHtml": "", - "summaryHtml": "

This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when repository visibility changes from private to public. For more information, see \"Setting repository visibility.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -152851,7 +152851,7 @@ "pull_request": { "assigned": { "descriptionHtml": "

A pull request was assigned to a user.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -152991,13 +152991,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -156255,8 +156255,8 @@ "category": "pull_request" }, "auto_merge_disabled": { - "descriptionHtml": "

Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "descriptionHtml": "

Auto merge was disabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -156271,13 +156271,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -159539,8 +159539,8 @@ "category": "pull_request" }, "auto_merge_enabled": { - "descriptionHtml": "

Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "descriptionHtml": "

Auto merge was enabled for a pull request. For more information, see \"Automatically merging a pull request.\"

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -159555,13 +159555,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -162824,7 +162824,7 @@ }, "closed": { "descriptionHtml": "

A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -162839,13 +162839,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -166500,8 +166500,8 @@ "category": "pull_request" }, "converted_to_draft": { - "descriptionHtml": "

A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "descriptionHtml": "

A pull request was converted to a draft. For more information, see \"Changing the stage of a pull request.\"

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -166516,13 +166516,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -170178,7 +170178,7 @@ }, "demilestoned": { "descriptionHtml": "

A pull request was removed from a milestone.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -170193,7 +170193,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -173690,7 +173690,7 @@ }, "dequeued": { "descriptionHtml": "

A pull request was removed from the merge queue.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -173705,13 +173705,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -176989,7 +176989,7 @@ }, "edited": { "descriptionHtml": "

The title or body of a pull request was edited, or the base branch of a pull request was changed.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -177073,13 +177073,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -180734,7 +180734,7 @@ }, "enqueued": { "descriptionHtml": "

A pull request was added to the merge queue.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -180749,13 +180749,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -184013,7 +184013,7 @@ }, "labeled": { "descriptionHtml": "

A label was added to a pull request.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -184028,13 +184028,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -187342,8 +187342,8 @@ "category": "pull_request" }, "locked": { - "descriptionHtml": "

Conversation on a pull request was locked. For more information, see \"Locking conversations.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "descriptionHtml": "

Conversation on a pull request was locked. For more information, see \"Locking conversations.\"

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -187358,13 +187358,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -190622,7 +190622,7 @@ }, "milestoned": { "descriptionHtml": "

A pull request was added to a milestone.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -190637,7 +190637,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -194134,7 +194134,7 @@ }, "opened": { "descriptionHtml": "

A pull request was created

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -194149,13 +194149,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -197810,8 +197810,8 @@ "category": "pull_request" }, "ready_for_review": { - "descriptionHtml": "

A draft pull request was marked as ready for review. For more information, see \"Changing the stage of a pull request.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "descriptionHtml": "

A draft pull request was marked as ready for review. For more information, see \"Changing the stage of a pull request.\"

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -197826,13 +197826,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -201488,7 +201488,7 @@ }, "reopened": { "descriptionHtml": "

A previously closed pull request was reopened.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -201503,13 +201503,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -205165,7 +205165,7 @@ }, "review_request_removed": { "descriptionHtml": "

A request for review by a person or team was removed from a pull request.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -205180,13 +205180,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -208737,8 +208737,8 @@ "category": "pull_request" }, "review_requested": { - "descriptionHtml": "

Review by a person or team was requested for a pull request. For more information, see \"Requesting a pull request review.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "descriptionHtml": "

Review by a person or team was requested for a pull request. For more information, see \"Requesting a pull request review.\"

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -208753,13 +208753,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -212297,7 +212297,7 @@ }, "synchronize": { "descriptionHtml": "

A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -212324,13 +212324,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -215589,7 +215589,7 @@ }, "unassigned": { "descriptionHtml": "

A user was unassigned from a pull request.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -215729,13 +215729,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -218994,7 +218994,7 @@ }, "unlabeled": { "descriptionHtml": "

A label was removed from a pull request.

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -219009,13 +219009,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -222322,8 +222322,8 @@ "category": "pull_request" }, "unlocked": { - "descriptionHtml": "

Conversation on a pull request was unlocked. For more information, see \"Locking conversations.\"

", - "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "descriptionHtml": "

Conversation on a pull request was unlocked. For more information, see \"Locking conversations.\"

", + "summaryHtml": "

This event occurs when there is activity on a pull request. For more information, see \"About pull requests.\" For information about the APIs to manage pull requests, see the GraphQL API documentation or \"Pulls\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the pull_request_review, pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -222338,13 +222338,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -225602,7 +225602,7 @@ "pull_request_review_comment": { "created": { "descriptionHtml": "

A comment on a pull request diff was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -225617,20 +225617,20 @@ { "type": "object", "name": "comment", - "description": "

The comment itself.

", + "description": "

The comment itself.

", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -228701,7 +228701,7 @@ }, "deleted": { "descriptionHtml": "

A comment on a pull request diff was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -228716,20 +228716,20 @@ { "type": "object", "name": "comment", - "description": "

The comment itself.

", + "description": "

The comment itself.

", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -231799,7 +231799,7 @@ }, "edited": { "descriptionHtml": "

The content of a comment on a pull request diff was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see \"Commenting on a pull request.\" For information about the APIs to manage pull request review comments, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request reviews, pull request comments, or pull request review threads, use the pull_request_review, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -231835,20 +231835,20 @@ { "type": "object", "name": "comment", - "description": "

The comment itself.

", + "description": "

The comment itself.

", "isRequired": true, "childParamsGroups": [] }, { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -234921,7 +234921,7 @@ "pull_request_review": { "dismissed": { "descriptionHtml": "

A review on a pull request was dismissed.

", - "summaryHtml": "

This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -234936,13 +234936,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -238259,7 +238259,7 @@ }, "edited": { "descriptionHtml": "

The body comment on a pull request review was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -238295,13 +238295,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -241471,7 +241471,7 @@ }, "submitted": { "descriptionHtml": "

A review on a pull request was submitted.

", - "summaryHtml": "

This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request reviews\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request review threads, use the pull_request_review_comment, issue_comment, or pull_request_review_thread events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -241486,13 +241486,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -244806,7 +244806,7 @@ "pull_request_review_thread": { "resolved": { "descriptionHtml": "

A comment thread on a pull request was marked as resolved.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -244821,13 +244821,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -248247,7 +248247,7 @@ }, "unresolved": { "descriptionHtml": "

A previously resolved comment thread on a pull request was marked as unresolved.

", - "summaryHtml": "

This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a comment thread on a pull request. For more information, see \"About pull request reviews.\" For information about the APIs to manage pull request reviews, see the GraphQL API documentation or \"Pull request review comments\" in the REST API documentation.

\n

For activity related to pull request review comments, pull request comments, or pull request reviews, use the pull_request_review_comment, issue_comment, or pull_request_review events instead.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -248262,13 +248262,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -251711,7 +251711,7 @@ { "type": "array of objects", "name": "commits", - "description": "

An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 2048 commits. If necessary, you can use the Commits API to fetch additional commits.

", + "description": "

An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the compare between the before commit and the after commit.) The array includes a maximum of 2048 commits. If necessary, you can use the Commits API to fetch additional commits.

", "isRequired": true, "childParamsGroups": [ { @@ -251848,7 +251848,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -251979,7 +251979,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -252049,7 +252049,7 @@ "registry_package": { "published": { "descriptionHtml": "

A package was published to a registry.

", - "summaryHtml": "

This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.

\n

To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.

\n

\n

\nGitHub recommends that you use the newer package event instead.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.

\n

To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.

\n

\n

\nGitHub recommends that you use the newer package event instead.

\n
", "bodyParameters": [ { "type": "string", @@ -252064,13 +252064,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -253108,7 +253108,7 @@ }, "updated": { "descriptionHtml": "

A package that was previously published to a registry was updated.

", - "summaryHtml": "

This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.

\n

To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.

\n

\n

\nGitHub recommends that you use the newer package event instead.

\n
", + "summaryHtml": "

This event occurs when there is activity relating to GitHub Packages. For more information, see \"Introduction to GitHub Packages.\" For information about the APIs to manage GitHub Packages, see the GraphQL API documentation or \"Packages\" in the REST API documentation.

\n

To install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.

\n

\n

\nGitHub recommends that you use the newer package event instead.

\n
", "bodyParameters": [ { "type": "string", @@ -253123,13 +253123,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -253912,7 +253912,7 @@ "release": { "created": { "descriptionHtml": "

A draft was saved, or a release or pre-release was published without previously being saved as a draft.

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -253927,13 +253927,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -253945,7 +253945,7 @@ { "type": "object", "name": "release", - "description": "

The release object.

", + "description": "

The release object.

", "isRequired": true, "childParamsGroups": [ { @@ -254488,7 +254488,7 @@ }, "deleted": { "descriptionHtml": "

A release, pre-release, or draft release was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -254503,13 +254503,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -254521,7 +254521,7 @@ { "type": "object", "name": "release", - "description": "

The release object.

", + "description": "

The release object.

", "isRequired": true, "childParamsGroups": [ { @@ -255063,8 +255063,8 @@ "category": "release" }, "edited": { - "descriptionHtml": "

The details of a release, pre-release, or draft release were edited. For more information, see \"Managing releases in a repository.\"

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "descriptionHtml": "

The details of a release, pre-release, or draft release were edited. For more information, see \"Managing releases in a repository.\"

", + "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -255139,13 +255139,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -255157,7 +255157,7 @@ { "type": "object", "name": "release", - "description": "

The release object.

", + "description": "

The release object.

", "isRequired": true, "childParamsGroups": [ { @@ -255699,7 +255699,7 @@ }, "prereleased": { "descriptionHtml": "

A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -255714,13 +255714,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -255732,7 +255732,7 @@ { "type": "object", "name": "release", - "description": "

The release object.

", + "description": "

The release object.

", "isRequired": true, "childParamsGroups": [ { @@ -256075,7 +256075,7 @@ }, "published": { "descriptionHtml": "

A release, pre-release, or draft of a release was published.

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -256090,13 +256090,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -256108,7 +256108,7 @@ { "type": "object", "name": "release", - "description": "

The release object.

", + "description": "

The release object.

", "isRequired": true, "childParamsGroups": [ { @@ -256448,7 +256448,7 @@ }, "released": { "descriptionHtml": "

A release was published, or a pre-release was changed to a release.

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -256463,13 +256463,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -256481,7 +256481,7 @@ { "type": "object", "name": "release", - "description": "

The release object.

", + "description": "

The release object.

", "isRequired": true, "childParamsGroups": [ { @@ -257023,7 +257023,7 @@ }, "unpublished": { "descriptionHtml": "

A release or pre-release was unpublished.

", - "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to releases. For more information, see \"About releases.\" For information about the APIs to manage releases, see the GraphQL API documentation or \"Releases\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -257038,13 +257038,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -257056,7 +257056,7 @@ { "type": "object", "name": "release", - "description": "

The release object.

", + "description": "

The release object.

", "isRequired": true, "childParamsGroups": [ { @@ -257398,7 +257398,7 @@ "repository_advisory": { "published": { "descriptionHtml": "

A repository security advisory was published.

", - "summaryHtml": "

This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"About GitHub Security Advisories for repositories.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"About GitHub Security Advisories for repositories.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.

", "bodyParameters": [ { "type": "string", @@ -257413,13 +257413,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -259005,7 +259005,7 @@ }, "reported": { "descriptionHtml": "

A private vulnerability report was submitted.

", - "summaryHtml": "

This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"About GitHub Security Advisories for repositories.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"About GitHub Security Advisories for repositories.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.

", "bodyParameters": [ { "type": "string", @@ -259020,13 +259020,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -260614,7 +260614,7 @@ "repository": { "archived": { "descriptionHtml": "

A repository was archived.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -260629,13 +260629,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -260670,7 +260670,7 @@ }, "created": { "descriptionHtml": "

A repository was created.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -260685,13 +260685,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -260726,7 +260726,7 @@ }, "deleted": { "descriptionHtml": "

A repository was deleted. GitHub Apps and repository webhooks will not receive this event.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -260741,13 +260741,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -260782,7 +260782,7 @@ }, "edited": { "descriptionHtml": "

The topics, default branch, description, or homepage of a repository was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -260856,13 +260856,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -260897,7 +260897,7 @@ }, "privatized": { "descriptionHtml": "

The visibility of a repository was changed to private.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -260912,13 +260912,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -260953,7 +260953,7 @@ }, "publicized": { "descriptionHtml": "

The visibility of a repository was changed to public.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -260968,13 +260968,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -261009,7 +261009,7 @@ }, "renamed": { "descriptionHtml": "

The name of a repository was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -261054,13 +261054,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -261095,7 +261095,7 @@ }, "transferred": { "descriptionHtml": "

Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the repository.transferred event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -261342,13 +261342,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -261383,7 +261383,7 @@ }, "unarchived": { "descriptionHtml": "

A previously archived repository was unarchived.

", - "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repositories. For more information, see \"About repositories.\" For information about the APIs to manage repositories, see the GraphQL documentation or \"Repositories\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -261398,13 +261398,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -261441,7 +261441,7 @@ "repository_dispatch": { "default": { "descriptionHtml": "", - "summaryHtml": "

This event occurs when a GitHub App sends a POST request to /repos/{owner}/{repo}/dispatches. For more information, see the REST API documentation for creating a repository dispatch event. In the payload, the action will be the event_type that was specified in the POST /repos/{owner}/{repo}/dispatches request body.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "summaryHtml": "

This event occurs when a GitHub App sends a POST request to /repos/{owner}/{repo}/dispatches. For more information, see the REST API documentation for creating a repository dispatch event. In the payload, the action will be the event_type that was specified in the POST /repos/{owner}/{repo}/dispatches request body.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -261465,13 +261465,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "isRequired": true, "childParamsGroups": [] }, @@ -261506,18 +261506,18 @@ "repository_import": { "default": { "descriptionHtml": "", - "summaryHtml": "

This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"Importing a repository with GitHub Importer.\" For more information about the API to manage imports, see the REST API documentation.

", + "summaryHtml": "

This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"Importing a repository with GitHub Importer.\" For more information about the API to manage imports, see the REST API documentation.

", "bodyParameters": [ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -261563,7 +261563,7 @@ "repository_ruleset": { "created": { "descriptionHtml": "

A repository ruleset was created.

", - "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -261578,13 +261578,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -262571,7 +262571,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -262583,7 +262583,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -262671,7 +262671,7 @@ }, "deleted": { "descriptionHtml": "

A repository ruleset was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -262686,13 +262686,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -263679,7 +263679,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -263691,7 +263691,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -263779,7 +263779,7 @@ }, "edited": { "descriptionHtml": "

A repository ruleset was edited.

", - "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"Managing rulesets.\"\nFor more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or \"Repository rules\" and \"Organization rules in the REST API documentation.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.

", "bodyParameters": [ { "type": "string", @@ -263794,13 +263794,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -264787,7 +264787,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -264799,7 +264799,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -265871,7 +265871,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -265883,7 +265883,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -266768,7 +266768,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -266780,7 +266780,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -267670,7 +267670,7 @@ { "type": "string", "name": "alerts_threshold", - "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -267682,7 +267682,7 @@ { "type": "string", "name": "security_alerts_threshold", - "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", + "description": "

The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"

", "isRequired": true, "enum": [ "none", @@ -268046,13 +268046,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -268334,13 +268334,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -268610,13 +268610,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -268886,13 +268886,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -268927,7 +268927,7 @@ "secret_scanning_alert": { "assigned": { "descriptionHtml": "

A secret scanning alert was assigned.

", - "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -269142,7 +269142,7 @@ { "type": "string", "name": "secret_type_display_name", - "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" + "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" }, { "type": "string or null", @@ -269889,13 +269889,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -269928,7 +269928,7 @@ }, "created": { "descriptionHtml": "

A secret scanning alert was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -270143,7 +270143,7 @@ { "type": "string", "name": "secret_type_display_name", - "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" + "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" }, { "type": "string or null", @@ -270755,13 +270755,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -270794,7 +270794,7 @@ }, "publicly_leaked": { "descriptionHtml": "

A secret scanning alert was detected in a public repo.

", - "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -271009,7 +271009,7 @@ { "type": "string", "name": "secret_type_display_name", - "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" + "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" }, { "type": "string or null", @@ -271621,13 +271621,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -271660,7 +271660,7 @@ }, "reopened": { "descriptionHtml": "

A previously closed secret scanning alert was reopened.

", - "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -271875,7 +271875,7 @@ { "type": "string", "name": "secret_type_display_name", - "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" + "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" }, { "type": "string or null", @@ -272487,13 +272487,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -272526,7 +272526,7 @@ }, "resolved": { "descriptionHtml": "

A secret scanning alert was closed.

", - "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -272741,7 +272741,7 @@ { "type": "string", "name": "secret_type_display_name", - "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" + "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" }, { "type": "string or null", @@ -273353,13 +273353,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -273392,7 +273392,7 @@ }, "unassigned": { "descriptionHtml": "

A secret scanning alert was unassigned.

", - "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -273607,7 +273607,7 @@ { "type": "string", "name": "secret_type_display_name", - "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" + "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" }, { "type": "string or null", @@ -274354,13 +274354,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -274393,7 +274393,7 @@ }, "validated": { "descriptionHtml": "

A secret scanning alert was validated.

", - "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -274608,7 +274608,7 @@ { "type": "string", "name": "secret_type_display_name", - "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" + "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" }, { "type": "string or null", @@ -275220,13 +275220,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -275261,7 +275261,7 @@ "secret_scanning_alert_location": { "created": { "descriptionHtml": "

A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.

", - "summaryHtml": "

This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.

\n

For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alerts, use the secret_scanning_alert event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.

\n

For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.

\n

For activity relating to secret scanning alerts, use the secret_scanning_alert event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -275475,7 +275475,7 @@ { "type": "string", "name": "secret_type_display_name", - "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" + "description": "

User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"

" }, { "type": "string or null", @@ -276087,7 +276087,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -276469,7 +276469,7 @@ "secret_scanning_scan": { "completed": { "descriptionHtml": "

A secret scanning scan was completed.

", - "summaryHtml": "

This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"About secret scanning.\"

\n

Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"About custom patterns.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", + "summaryHtml": "

This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"About secret scanning.\"

\n

Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"About custom patterns.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -276547,13 +276547,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -276581,7 +276581,7 @@ "security_advisory": { "published": { "descriptionHtml": "

A security advisory was published to the GitHub community.

", - "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -276596,13 +276596,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -276855,7 +276855,7 @@ }, "updated": { "descriptionHtml": "

The metadata or description of a security advisory was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -276870,13 +276870,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -277129,7 +277129,7 @@ }, "withdrawn": { "descriptionHtml": "

A previously published security advisory was withdrawn.

", - "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see \"About global security advisories.\" For information about the API to manage security advisories, see the REST API documentation or the GraphQL documentation.

\n

GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"About Dependabot alerts.\"

", "bodyParameters": [ { "type": "string", @@ -277144,13 +277144,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -277405,7 +277405,7 @@ "security_and_analysis": { "default": { "descriptionHtml": "", - "summaryHtml": "

This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"GitHub security features.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", + "summaryHtml": "

This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"GitHub security features.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.

", "bodyParameters": [ { "type": "object", @@ -277632,13 +277632,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -277673,7 +277673,7 @@ "sponsorship": { "cancelled": { "descriptionHtml": "

A sponsorship was cancelled and the last billing cycle has ended.

\n

This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.

", - "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", "bodyParameters": [ { "type": "string", @@ -277688,13 +277688,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -278163,7 +278163,7 @@ }, "created": { "descriptionHtml": "

A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.

", - "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", "bodyParameters": [ { "type": "string", @@ -278178,13 +278178,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -278653,7 +278653,7 @@ }, "edited": { "descriptionHtml": "

A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.

", - "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", "bodyParameters": [ { "type": "string", @@ -278689,13 +278689,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -279164,7 +279164,7 @@ }, "pending_cancellation": { "descriptionHtml": "

A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.

\n

This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.

", - "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", "bodyParameters": [ { "type": "string", @@ -279184,13 +279184,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -279659,7 +279659,7 @@ }, "pending_tier_change": { "descriptionHtml": "

A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.

", - "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", "bodyParameters": [ { "type": "string", @@ -279755,13 +279755,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -280230,7 +280230,7 @@ }, "tier_changed": { "descriptionHtml": "

A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.

", - "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", + "summaryHtml": "

This event occurs when there is activity relating to a sponsorship listing. For more information, see \"About GitHub Sponsors.\" For information about the API to manage sponsors, see the GraphQL documentation.

\n

You can only create a sponsorship webhook on GitHub.com. For more information, see \"Configuring webhooks for events in your sponsored account.\"

", "bodyParameters": [ { "type": "string", @@ -280321,13 +280321,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -280798,7 +280798,7 @@ "star": { "created": { "descriptionHtml": "

Someone starred a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -280813,13 +280813,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -280859,7 +280859,7 @@ }, "deleted": { "descriptionHtml": "

Someone unstarred the repository.

", - "summaryHtml": "

This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to repository stars. For more information about stars, see \"Saving repositories with stars.\" For information about the APIs to manage stars, see the GraphQL documentation or \"Starring\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -280874,13 +280874,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -280922,7 +280922,7 @@ "status": { "default": { "descriptionHtml": "", - "summaryHtml": "

This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Commit statuses\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.

", + "summaryHtml": "

This event occurs when the status of a Git commit changes. For example, commits can be marked as error, failure, pending, or success. For more information, see \"About status checks.\" For information about the APIs to manage commit statuses, see the GraphQL documentation or \"Commit statuses\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.

", "bodyParameters": [ { "type": "string or null", @@ -281453,7 +281453,7 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -281465,7 +281465,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -287376,7 +287376,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -293247,7 +293247,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -299118,7 +299118,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -304989,7 +304989,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -305023,18 +305023,18 @@ "team_add": { "default": { "descriptionHtml": "", - "summaryHtml": "

This event occurs when a team is added to a repository.\nFor more information, see \"Managing teams and people with access to your repository.\"

\n

For activity relating to teams, see the teams event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when a team is added to a repository.\nFor more information, see \"Managing teams and people with access to your repository.\"

\n

For activity relating to teams, see the teams event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -305281,7 +305281,7 @@ "team": { "added_to_repository": { "descriptionHtml": "

A team was granted access to a repository.

", - "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -305296,13 +305296,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -305546,7 +305546,7 @@ }, "created": { "descriptionHtml": "

A team was created.

", - "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -305561,13 +305561,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -305812,7 +305812,7 @@ }, "deleted": { "descriptionHtml": "

A team was deleted.

", - "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -305827,13 +305827,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -306077,7 +306077,7 @@ }, "edited": { "descriptionHtml": "

The name, description, or visibility of a team was changed.

", - "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -306190,13 +306190,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -306441,7 +306441,7 @@ }, "removed_from_repository": { "descriptionHtml": "

A team's access to a repository was removed.

", - "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", + "summaryHtml": "

This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"About teams.\"

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.

", "bodyParameters": [ { "type": "string", @@ -306456,13 +306456,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -306709,7 +306709,7 @@ "watch": { "started": { "descriptionHtml": "

Someone started watching the repository.

", - "summaryHtml": "

This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"Managing your subscriptions.\" For information about the APIs to manage watching, see \"Watching\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see \"Managing your subscriptions.\" For information about the APIs to manage watching, see \"Watching\" in the REST API documentation.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -306724,13 +306724,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -306766,12 +306766,12 @@ "workflow_dispatch": { "default": { "descriptionHtml": "", - "summaryHtml": "

This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"Manually running a workflow.\"

\n

For activity relating to workflow runs, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", + "summaryHtml": "

This event occurs when a GitHub Actions workflow is manually triggered. For more information, see \"Manually running a workflow.\"

\n

For activity relating to workflow runs, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.

", "bodyParameters": [ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { @@ -306783,7 +306783,7 @@ { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -306829,7 +306829,7 @@ "workflow_job": { "completed": { "descriptionHtml": "

A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.

", - "summaryHtml": "

This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.

\n

For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.

\n

For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -306844,13 +306844,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -306934,7 +306934,7 @@ { "type": "array of strings", "name": "labels", - "description": "

Custom labels for the job. Specified by the \"runs-on\" attribute in the workflow YAML.

", + "description": "

Custom labels for the job. Specified by the \"runs-on\" attribute in the workflow YAML.

", "isRequired": true }, { @@ -307338,7 +307338,7 @@ }, "in_progress": { "descriptionHtml": "

A job in a workflow run started processing on a runner.

", - "summaryHtml": "

This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.

\n

For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.

\n

For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -307353,13 +307353,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -307440,7 +307440,7 @@ { "type": "array of strings", "name": "labels", - "description": "

Custom labels for the job. Specified by the \"runs-on\" attribute in the workflow YAML.

", + "description": "

Custom labels for the job. Specified by the \"runs-on\" attribute in the workflow YAML.

", "isRequired": true }, { @@ -307844,7 +307844,7 @@ }, "queued": { "descriptionHtml": "

A job in a workflow run was created.

", - "summaryHtml": "

This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.

\n

For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.

\n

For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -307859,13 +307859,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -308344,7 +308344,7 @@ }, "waiting": { "descriptionHtml": "

A job in a workflow run was created and is waiting for approvals.

", - "summaryHtml": "

This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.

\n

For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see \"Using jobs in a workflow.\" For information about the API to manage workflow jobs, see \"Workflow jobs\" in the REST API documentation.

\n

For activity relating to a workflow run instead of a job in a workflow run, use the workflow_run event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -308359,13 +308359,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -308847,7 +308847,7 @@ "workflow_run": { "completed": { "descriptionHtml": "

A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.

", - "summaryHtml": "

This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.

\n

For activity relating to a job in a workflow run, use the workflow_job event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.

\n

For activity relating to a job in a workflow run, use the workflow_job event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -308862,13 +308862,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -310344,7 +310344,7 @@ }, "in_progress": { "descriptionHtml": "

A workflow run started processing on a runner.

", - "summaryHtml": "

This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.

\n

For activity relating to a job in a workflow run, use the workflow_job event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.

\n

For activity relating to a job in a workflow run, use the workflow_job event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -310359,13 +310359,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { @@ -311814,7 +311814,7 @@ }, "requested": { "descriptionHtml": "

A workflow run was triggered.

", - "summaryHtml": "

This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.

\n

For activity relating to a job in a workflow run, use the workflow_job event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", + "summaryHtml": "

This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see \"About workflows.\" For information about the APIs to manage workflow runs, see the GraphQL documentation or \"Workflow runs\" in the REST API documentation.

\n

For activity relating to a job in a workflow run, use the workflow_job event.

\n

To subscribe to this event, a GitHub App must have at least read-level access for the \"Actions\" repository permission.

", "bodyParameters": [ { "type": "string", @@ -311829,13 +311829,13 @@ { "type": "object", "name": "enterprise", - "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", + "description": "

An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"

", "childParamsGroups": [] }, { "type": "object", "name": "installation", - "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", + "description": "

The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"

", "childParamsGroups": [] }, { diff --git a/src/webhooks/scripts/webhook.ts b/src/webhooks/scripts/webhook.ts index 44f4d691c27f..65056da38960 100644 --- a/src/webhooks/scripts/webhook.ts +++ b/src/webhooks/scripts/webhook.ts @@ -1,6 +1,7 @@ import { get, isPlainObject } from 'lodash-es' import { getJsonValidator } from '@/tests/lib/validate-json-schema' import { renderContent } from '@/content-render/index' +import { normalizeDocsUrls } from '../../rest/scripts/utils/normalize-docs-urls' import webhookSchema from './webhook-schema' import { getBodyParams, TransformedParam } from '../../rest/scripts/utils/get-body-params' @@ -90,8 +91,8 @@ export default class Webhook implements WebhookInterface { } async renderDescription(): Promise { - this.descriptionHtml = await renderContent(this.#webhook.description) - this.summaryHtml = await renderContent(this.#webhook.summary) + this.descriptionHtml = normalizeDocsUrls(await renderContent(this.#webhook.description)) + this.summaryHtml = normalizeDocsUrls(await renderContent(this.#webhook.summary)) return this } diff --git a/src/workflows/writers-help-metadata.ts b/src/workflows/writers-help-metadata.ts index 0e2a5757f988..2bd6f24cf561 100644 --- a/src/workflows/writers-help-metadata.ts +++ b/src/workflows/writers-help-metadata.ts @@ -132,8 +132,10 @@ function getCategory(relativePath: string): string { .map((w) => w.charAt(0).toUpperCase() + w.slice(1)) .join(' ') - // Clarify this one category - return category.replace('Content Render', 'Content Tasks') + // Clarify some category names + return category + .replace('Content Render', 'Content Tasks') + .replace('Ghes Releases', 'GHES release notes') } function findScriptName(scripts: Record, relativePath: string): string | null {