From 353c7eae4674195dc963e974a06a15e0cdfe41e9 Mon Sep 17 00:00:00 2001
From: Felix Guntrip <stevecat@github.com>
Date: Mon, 30 Jun 2025 16:57:29 +0100
Subject: [PATCH 01/12] Update "Upgrading Java projects with GitHub Copilot" to
summarise Java and .NET upgrades (#56380)
---
content/copilot/tutorials/index.md | 2 +-
...ading-java-projects-with-github-copilot.md | 106 ------------------
.../upgrading-projects-with-github-copilot.md | 39 +++++++
3 files changed, 40 insertions(+), 107 deletions(-)
delete mode 100644 content/copilot/tutorials/upgrading-java-projects-with-github-copilot.md
create mode 100644 content/copilot/tutorials/upgrading-projects-with-github-copilot.md
diff --git a/content/copilot/tutorials/index.md b/content/copilot/tutorials/index.md
index 5e6222a27ec4..a2f5514e573a 100644
--- a/content/copilot/tutorials/index.md
+++ b/content/copilot/tutorials/index.md
@@ -18,7 +18,7 @@ children:
- /learning-a-new-programming-language-with-github-copilot
- /modernizing-legacy-code-with-github-copilot
- /using-copilot-to-migrate-a-project
- - /upgrading-java-projects-with-github-copilot
+ - /upgrading-projects-with-github-copilot
- /rolling-out-github-copilot-at-scale
redirect_from:
- /copilot/using-github-copilot/guides-on-using-github-copilot
diff --git a/content/copilot/tutorials/upgrading-java-projects-with-github-copilot.md b/content/copilot/tutorials/upgrading-java-projects-with-github-copilot.md
deleted file mode 100644
index 3e9c8e2207aa..000000000000
--- a/content/copilot/tutorials/upgrading-java-projects-with-github-copilot.md
+++ /dev/null
@@ -1,106 +0,0 @@
----
-title: Upgrading Java projects with GitHub Copilot
-shortTitle: Upgrade Java projects
-intro: 'You can use {% data variables.product.prodname_copilot %} to upgrade your Maven and Gradle Java applications.'
-versions:
- feature: copilot
-topics:
- - Copilot
-redirect_from:
- - /copilot/using-github-copilot/guides-on-using-github-copilot/upgrading-java-projects-with-github-copilot
----
-
-> [!NOTE]
-> GitHub Copilot app modernization – upgrade for Java is currently in {% data variables.release-phases.public_preview %} and subject to change.
-
-## Introduction
-
-{% data variables.product.prodname_copilot %} can help streamline the process of upgrading Java applications. The "GitHub Copilot app modernization – upgrade for Java" {% data variables.product.prodname_vscode %} extension assists with every step of upgrading your Java project's runtime and/or framework version.
-
-* Analyzing the project and dependencies to generate an upgrade plan.
-* Executing code transformations based on the plan.
-* Automatically fixing issues during the upgrade.
-* Providing detailed logs, commit history, and output.
-* Performing security scans (CVE) and behavioral consistency checks post-upgrade.
-* Summarizing key changes including updated dependencies and resolved issues.
-* Generating unit tests independently of the upgrade process.
-
-This solution supports both Maven and Gradle build tools and facilitates upgrades between Java versions 8, 11, 17, and 21.
-
-## Prerequisites
-
-Before getting started you must have the following:
-
-* Either a **{% data variables.copilot.copilot_for_business %}** or **{% data variables.copilot.copilot_enterprise %}** [subscription plan](/copilot/about-github-copilot/subscription-plans-for-github-copilot).
-* The latest version of [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/).
-* The "GitHub Copilot app modernization – upgrade for Java (preview)" extension installed in {% data variables.product.prodname_vscode %}.
-* Installed versions of both the source and target JDKs.
-* A Git-based Java project using Maven or Gradle.
-* For Maven-based projects, access to the public Maven Central repository.
-* Make sure `chat.extensionTools.enabled` is set to `true` in your {% data variables.product.prodname_vscode %} settings. This setting might be controlled by your organization.
-
->[!NOTE] For Gradle projects, only wrapper-based builds (Gradle v5+) are supported. Projects using Kotlin DSL are not currently supported.
-
-## Upgrading a Java project
-
-### 1. Install the required extension
-
-To get started, you'll need to install the “GitHub Copilot app modernization – upgrade for Java (preview)” extension for {% data variables.product.prodname_vscode %}.
-
-1. Open {% data variables.product.prodname_vscode %}.
-1. Click on “Extensions”.
-1. Search for “GitHub Copilot app modernization – upgrade for Java (preview)” and click “Download”.
-1. Restart {% data variables.product.prodname_vscode %}.
-
-### 2. Use {% data variables.copilot.copilot_chat %} in agent mode and generate the upgrade plan
-
-Now you have the extension, you can continue to use {% data variables.product.prodname_copilot %} in agent mode and create a plan for your upgrade.
-
-1. In {% data variables.product.prodname_vscode %}, open the {% data variables.copilot.copilot_chat %} panel.
-1. At the bottom of the chat panel, select **Agent** from the mode dropdown.
-1. Enter a prompt describing the upgrade path you need. For example:
-
- > "Upgrade project to Java 21 and Spring Boot 3.2"
-
-1. When prompted, click **Continue** to generate an upgrade plan
-
-### 3. Review and edit the upgrade plan
-
-{% data variables.product.prodname_copilot %} will analyze your project's structure, JDK, dependencies, and build tool before generating a `plan.md` upgrade plan for your specific circumstances that outlines source and target JDK versions and upgrade paths for frameworks and libraries.
-
-1. Click on the new `plan.md` tab in {% data variables.product.prodname_vscode %}.
-1. Review, and edit if necessary, the plan. Make sure the versions in the plan align with your goals and what you've already specified.
-1. When you're ready, click **Continue** to proceed.
-
-### 4. Apply code changes and fix build issues
-
-Next, {% data variables.product.prodname_copilot %} will begin transforming your project. This involves using OpenRewrite to apply code changes via predefined recipes and iteratively fixing remaining issues with {% data variables.product.prodname_copilot_short %} through a build/fix loop.
-
-1. When prompted to "Run Upgrade Java code using OpenRewrite", click **Continue**. Note that this step may take some time.
-1. When prompted to "Run Build project and fix errors", click **Continue**.
-
-You can track the progress of this phase by viewing the `progress.md` file in {% data variables.product.prodname_vscode %}.
-
-### 5. Check for security vulnerabilities (CVE) and code behavior changes
-
-To ensure reliability and security, {% data variables.product.prodname_copilot %} performs additional checks.
-
-1. When prompted to "Run Validate if any modified dependencies have known CVEs", click **Continue**.
-
- If CVEs are detected, {% data variables.product.prodname_copilot_short %} will try to resolve them. You can review and accept or reject the changes.
-1. When prompted to "Run Validate code behavior consistency", click **Continue**.
-
- If inconsistencies are found, {% data variables.product.prodname_copilot_short %} will again attempt fixes and you can decide which to keep.
-
-At the end of this process, the tool rebuilds the project and runs one final validation. The process concludes if only minor issues that don’t block the upgrade may remain. Otherwise, it loops back to address outstanding problems.
-
-### 6. View the Upgrade Summary
-
-Once completed, {% data variables.product.prodname_copilot_short %} generates a `summary.md` file in your project directory containing:
-
-* Project metadata.
-* Lines of code modified.
-* Updated dependencies.
-* Description of code changes.
-* CVEs and inconsistencies resolved.
-* Remaining minor CVE issues (if any).
diff --git a/content/copilot/tutorials/upgrading-projects-with-github-copilot.md b/content/copilot/tutorials/upgrading-projects-with-github-copilot.md
new file mode 100644
index 000000000000..329ee1d4ac1b
--- /dev/null
+++ b/content/copilot/tutorials/upgrading-projects-with-github-copilot.md
@@ -0,0 +1,39 @@
+---
+title: Upgrading projects with GitHub Copilot
+shortTitle: Upgrade projects
+intro: 'You can use {% data variables.product.prodname_copilot %} to upgrade your Maven and Gradle Java applications and .NET applications.'
+versions:
+ feature: copilot
+topics:
+ - Copilot
+redirect_from:
+ - /copilot/using-github-copilot/guides-on-using-github-copilot/upgrading-java-projects-with-github-copilot
+ - /copilot/tutorials/upgrading-java-projects-with-github-copilot
+---
+
+> [!NOTE]
+> "GitHub Copilot app modernization – upgrade for Java" and "GitHub Copilot app modernization – Upgrade for .NET" are currently in {% data variables.release-phases.public_preview %} and subject to change.
+
+## Introduction
+
+{% data variables.product.prodname_copilot %} can help streamline the process of modernizing and upgrading your Java and .NET applications. {% data variables.product.prodname_copilot_short %} will analyze the project, generate a plan, automatically fix issues it encounters when carrying out the plan, and produce a summary.
+
+## Upgrading Java projects
+
+You can upgrade a Git-based Maven or Gradle Java project using {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vscode %}. You will need:
+
+* Either a **{% data variables.copilot.copilot_for_business %}** or **{% data variables.copilot.copilot_enterprise %}** [subscription plan](/copilot/about-github-copilot/subscription-plans-for-github-copilot).
+* The latest version of [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/).
+* For Maven-based projects, access to the public Maven Central repository.
+* Installed versions of both the source and target JDKs.
+
+For the next steps, see [Quickstart: upgrade a Java project with GitHub Copilot App Modernization - upgrade for Java (preview)](https://learn.microsoft.com/en-gb/java/upgrade/quickstart-upgrade) on Microsoft Learn.
+
+## Upgrading .NET projects
+
+You can also upgrade a .NET project using {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_vs %}. You will need:
+
+* Either a **{% data variables.copilot.copilot_pro %}**, **{% data variables.copilot.copilot_pro_plus %}**, **{% data variables.copilot.copilot_for_business %}** or **{% data variables.copilot.copilot_enterprise %}** [subscription plan](/copilot/about-github-copilot/subscription-plans-for-github-copilot).
+* The latest release of {% data variables.product.prodname_vs %} Enterprise, Professional or Community 2022.
+
+For the next steps, see [GitHub Copilot app modernization - upgrade for .NET](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.GitHubCopilotUpgradeAgent) on Microsoft Visual Studio Marketplace.
From b07556198c3f2fd3783411bb6fae75f06c105e25 Mon Sep 17 00:00:00 2001
From: Kevin Heis <heiskr@users.noreply.github.com>
Date: Mon, 30 Jun 2025 09:13:04 -0700
Subject: [PATCH 02/12] Convert src/ai-editors and src/metrics JavaScript files
to TypeScript (#56353)
Co-authored-by: Sarah Schneider <sarahs@github.com>
---
package.json | 3 +
src/ai-editors/lib/call-models-api.js | 24 ----
src/ai-editors/lib/call-models-api.ts | 60 +++++++++
.../scripts/{ai-edit.js => ai-edit.ts} | 70 ++++++++--
src/metrics/lib/{dates.js => dates.ts} | 12 +-
.../lib/{kusto-client.js => kusto-client.ts} | 31 ++++-
.../queries/{bounces.js => bounces.ts} | 35 +++--
.../queries/{constants.js => constants.ts} | 8 +-
...xits-to-support.js => exits-to-support.ts} | 33 +++--
.../{survey-score.js => survey-score.ts} | 35 +++--
src/metrics/queries/users.js | 32 -----
src/metrics/queries/users.ts | 43 ++++++
.../{view-duration.js => view-duration.ts} | 33 +++--
src/metrics/queries/views.js | 32 -----
src/metrics/queries/views.ts | 43 ++++++
.../scripts/{docsaudit.js => docsaudit.ts} | 36 ++++--
.../scripts/{docstat.js => docstat.ts} | 122 ++++++++++++++----
17 files changed, 458 insertions(+), 194 deletions(-)
delete mode 100644 src/ai-editors/lib/call-models-api.js
create mode 100644 src/ai-editors/lib/call-models-api.ts
rename src/ai-editors/scripts/{ai-edit.js => ai-edit.ts} (75%)
mode change 100755 => 100644
rename src/metrics/lib/{dates.js => dates.ts} (71%)
rename src/metrics/lib/{kusto-client.js => kusto-client.ts} (59%)
rename src/metrics/queries/{bounces.js => bounces.ts} (52%)
rename src/metrics/queries/{constants.js => constants.ts} (86%)
rename src/metrics/queries/{exits-to-support.js => exits-to-support.ts} (60%)
rename src/metrics/queries/{survey-score.js => survey-score.ts} (55%)
delete mode 100644 src/metrics/queries/users.js
create mode 100644 src/metrics/queries/users.ts
rename src/metrics/queries/{view-duration.js => view-duration.ts} (50%)
delete mode 100644 src/metrics/queries/views.js
create mode 100644 src/metrics/queries/views.ts
rename src/metrics/scripts/{docsaudit.js => docsaudit.ts} (72%)
rename src/metrics/scripts/{docstat.js => docstat.ts} (84%)
mode change 100755 => 100644
diff --git a/package.json b/package.json
index 64c778bbf72e..205d36922a11 100644
--- a/package.json
+++ b/package.json
@@ -16,6 +16,7 @@
},
"exports": "./src/frame/server.ts",
"scripts": {
+ "ai-edit": "tsx src/ai-editors/scripts/ai-edit.ts",
"all-documents": "tsx src/content-render/scripts/all-documents/cli.ts",
"analyze-text": "tsx src/search/scripts/analyze-text.ts",
"analyze-comment": "tsx src/events/scripts/analyze-comment-cli.ts",
@@ -30,6 +31,8 @@
"create-enterprise-issue": "tsx src/ghes-releases/scripts/create-enterprise-issue.ts",
"debug": "cross-env NODE_ENV=development ENABLED_LANGUAGES=en nodemon --inspect src/frame/server.ts",
"delete-orphan-translation-files": "tsx src/workflows/delete-orphan-translation-files.ts",
+ "docsaudit": "tsx src/metrics/scripts/docsaudit.ts",
+ "docstat": "tsx src/metrics/scripts/docstat.ts",
"deleted-assets-pr-comment": "tsx src/assets/scripts/deleted-assets-pr-comment.ts",
"deleted-features-pr-comment": "tsx src/data-directory/scripts/deleted-features-pr-comment.ts",
"deprecate-ghes": "tsx src/ghes-releases/scripts/deprecate/index.ts",
diff --git a/src/ai-editors/lib/call-models-api.js b/src/ai-editors/lib/call-models-api.js
deleted file mode 100644
index d48a4ee15d81..000000000000
--- a/src/ai-editors/lib/call-models-api.js
+++ /dev/null
@@ -1,24 +0,0 @@
-const modelsCompletionsEndpoint = 'https://models.github.ai/inference/chat/completions'
-
-export async function callModelsApi(promptWithContent) {
- let aiResponse
- try {
- const response = await fetch(modelsCompletionsEndpoint, {
- method: 'post',
- body: JSON.stringify(promptWithContent),
- headers: {
- 'Content-Type': 'application/json',
- Authorization: `Bearer ${process.env.GITHUB_TOKEN}`,
- 'X-GitHub-Api-Version': '2022-11-28',
- Accept: 'Accept: application/vnd.github+json',
- },
- })
- const data = await response.json()
- aiResponse = data.choices[0]
- } catch (error) {
- console.error('Error calling GitHub Models REST API')
- throw error
- }
-
- return aiResponse.message.content
-}
diff --git a/src/ai-editors/lib/call-models-api.ts b/src/ai-editors/lib/call-models-api.ts
new file mode 100644
index 000000000000..dda311baa04f
--- /dev/null
+++ b/src/ai-editors/lib/call-models-api.ts
@@ -0,0 +1,60 @@
+const modelsCompletionsEndpoint = 'https://models.github.ai/inference/chat/completions'
+
+interface ChatMessage {
+ role: string
+ content: string
+}
+
+interface ChatCompletionRequest {
+ messages: ChatMessage[]
+ model?: string
+ temperature?: number
+ max_tokens?: number
+}
+
+interface ChatCompletionChoice {
+ message: {
+ content: string
+ role: string
+ }
+ finish_reason: string
+ index: number
+}
+
+interface ChatCompletionResponse {
+ choices: ChatCompletionChoice[]
+ id: string
+ object: string
+ created: number
+ model: string
+ usage?: {
+ prompt_tokens: number
+ completion_tokens: number
+ total_tokens: number
+ }
+}
+
+export async function callModelsApi(promptWithContent: ChatCompletionRequest): Promise<string> {
+ let aiResponse: ChatCompletionChoice
+
+ try {
+ const response = await fetch(modelsCompletionsEndpoint, {
+ method: 'post',
+ body: JSON.stringify(promptWithContent),
+ headers: {
+ 'Content-Type': 'application/json',
+ Authorization: `Bearer ${process.env.GITHUB_TOKEN}`,
+ 'X-GitHub-Api-Version': '2022-11-28',
+ Accept: 'Accept: application/vnd.github+json',
+ },
+ })
+
+ const data: ChatCompletionResponse = await response.json()
+ aiResponse = data.choices[0]
+ } catch (error) {
+ console.error('Error calling GitHub Models REST API')
+ throw error
+ }
+
+ return aiResponse.message.content
+}
diff --git a/src/ai-editors/scripts/ai-edit.js b/src/ai-editors/scripts/ai-edit.ts
old mode 100755
new mode 100644
similarity index 75%
rename from src/ai-editors/scripts/ai-edit.js
rename to src/ai-editors/scripts/ai-edit.ts
index cca7cc87c134..ca3633acec4a
--- a/src/ai-editors/scripts/ai-edit.js
+++ b/src/ai-editors/scripts/ai-edit.ts
@@ -6,8 +6,9 @@ import fs from 'fs'
import yaml from 'js-yaml'
import path from 'path'
import ora from 'ora'
-import github from '#src/workflows/github.ts'
-import { callModelsApi } from '#src/ai-editors/lib/call-models-api.js'
+import { callModelsApi } from '@/ai-editors/lib/call-models-api'
+import dotenv from 'dotenv'
+dotenv.config()
const __dirname = path.dirname(fileURLToPath(import.meta.url))
const promptDir = path.join(__dirname, '../prompts')
@@ -16,15 +17,36 @@ if (!process.env.GITHUB_TOKEN) {
throw new Error('Error! You must have a GITHUB_TOKEN set in an .env file to run this script.')
}
-const responseTypes = {
+interface ResponseTypes {
+ rewrite: string
+ list: string
+ json: string
+}
+
+const responseTypes: ResponseTypes = {
rewrite: 'Edit the versioning only. Return the edited content.',
list: `Do NOT rewrite the content. Report your edits in numbered list format.`,
json: `Do NOT rewrite the content. Report your edits as a JSON list, with the format { lineNumber, currentText, suggestion }.`,
}
-const validResponseTypes = Object.keys(responseTypes)
+const validResponseTypes = Object.keys(responseTypes) as Array<keyof ResponseTypes>
+
+interface EditorType {
+ promptFile: string
+ description: string
+}
+
+interface EditorTypes {
+ versioning: EditorType
+ // TODO
+ // scannability: EditorType
+ // readability: EditorType
+ // technical: EditorType
+ // styleguide: EditorType
+ // contentModels: EditorType
+}
-const editorTypes = {
+const editorTypes: EditorTypes = {
versioning: {
promptFile: 'versioning-editor.prompt.yml',
description: 'Review against simplifying versioning guidelines.',
@@ -54,7 +76,7 @@ const editorTypes = {
// Add more here...
}
-const editorDescriptions = () => {
+const editorDescriptions = (): string => {
let str = '\n\n'
Object.entries(editorTypes).forEach(([ed, edObj]) => {
str += `\t${ed}\n\t\t\t${edObj.description}\n\n`
@@ -62,6 +84,13 @@ const editorDescriptions = () => {
return str
}
+interface CliOptions {
+ verbose?: boolean
+ editor?: Array<keyof EditorTypes>
+ response?: keyof ResponseTypes
+ files: string[]
+}
+
const program = new Command()
program
@@ -80,7 +109,7 @@ program
'-f, --files <files...>',
'One or more content file paths in the content directory',
)
- .action((options) => {
+ .action((options: CliOptions) => {
;(async () => {
const spinner = ora('Starting AI review...').start()
@@ -88,7 +117,7 @@ program
const editors = options.editor || ['versioning']
const response = options.response || 'rewrite'
- let responseTypeInstruction
+ let responseTypeInstruction: string
if (validResponseTypes.includes(response)) {
responseTypeInstruction = responseTypes[response]
} else {
@@ -126,7 +155,8 @@ program
}
}
} catch (err) {
- spinner.fail(`Error processing file ${file}: ${err.message}`)
+ const error = err as Error
+ spinner.fail(`Error processing file ${file}: ${error.message}`)
process.exitCode = 1
}
}
@@ -135,13 +165,31 @@ program
program.parse(process.argv)
-async function callEditor(editorType, responseTypeInstruction, content) {
+interface PromptMessage {
+ content: string
+ role: string
+}
+
+interface PromptData {
+ messages: PromptMessage[]
+ model?: string
+ temperature?: number
+ max_tokens?: number
+}
+
+async function callEditor(
+ editorType: keyof EditorTypes,
+ responseTypeInstruction: string,
+ content: string,
+): Promise<string> {
const promptName = editorTypes[editorType].promptFile
const promptPath = path.join(promptDir, promptName)
- const prompt = yaml.load(fs.readFileSync(promptPath, 'utf8'))
+ const prompt = yaml.load(fs.readFileSync(promptPath, 'utf8')) as PromptData
+
prompt.messages.forEach((msg) => {
msg.content = msg.content.replace('{{responseTypeInstruction}}', responseTypeInstruction)
msg.content = msg.content.replace('{{input}}', content)
})
+
return callModelsApi(prompt)
}
diff --git a/src/metrics/lib/dates.js b/src/metrics/lib/dates.ts
similarity index 71%
rename from src/metrics/lib/dates.js
rename to src/metrics/lib/dates.ts
index 355c78d3a8a8..d44ff794d0da 100644
--- a/src/metrics/lib/dates.js
+++ b/src/metrics/lib/dates.ts
@@ -1,11 +1,17 @@
-const dateOpts = {
+const dateOpts: Intl.DateTimeFormatOptions = {
year: 'numeric',
month: 'long',
day: 'numeric',
}
+export interface DateRange {
+ endDate: string
+ startDate: string
+ friendlyRange: string
+}
+
// Default to 30 days ago if a range option is not provided
-export function getDates(range = '30') {
+export function getDates(range: string | number = '30'): DateRange {
// Get current datetime in ISO format
const today = new Date()
const todayISO = today.toISOString()
@@ -21,7 +27,7 @@ export function getDates(range = '30') {
}
}
-function getDaysAgo(range) {
+function getDaysAgo(range: number): Date {
const daysAgo = new Date()
daysAgo.setDate(daysAgo.getDate() - range)
return daysAgo
diff --git a/src/metrics/lib/kusto-client.js b/src/metrics/lib/kusto-client.ts
similarity index 59%
rename from src/metrics/lib/kusto-client.js
rename to src/metrics/lib/kusto-client.ts
index eb8b13bdbd50..72a84a062eb6 100644
--- a/src/metrics/lib/kusto-client.js
+++ b/src/metrics/lib/kusto-client.ts
@@ -1,16 +1,28 @@
-import { Client as KustoClient, KustoConnectionStringBuilder } from 'azure-kusto-data'
+import {
+ Client as KustoClient,
+ KustoConnectionStringBuilder,
+ KustoResultTable,
+} from 'azure-kusto-data'
import dotenv from 'dotenv'
+
dotenv.config()
+
if (!(process.env.KUSTO_CLUSTER || process.env.KUSTO_DATABASE)) {
console.error(`Add KUSTO_CLUSTER and KUSTO_DATABASE to your .env file`)
process.exit(0)
}
-const KUSTO_CLUSTER = process.env.KUSTO_CLUSTER
-const KUSTO_DATABASE = process.env.KUSTO_DATABASE
-export function getKustoClient() {
- let client
+const KUSTO_CLUSTER = process.env.KUSTO_CLUSTER!
+const KUSTO_DATABASE = process.env.KUSTO_DATABASE!
+
+export interface KustoQueryResult {
+ primaryResults: KustoResultTable[]
+}
+
+export function getKustoClient(): KustoClient | undefined {
+ let client: KustoClient | undefined
+
try {
const kcsb = KustoConnectionStringBuilder.withAzLoginIdentity(KUSTO_CLUSTER)
client = new KustoClient(kcsb)
@@ -18,10 +30,17 @@ export function getKustoClient() {
console.error('Error connecting to Kusto')
console.error(error)
}
+
return client
}
-export async function runQuery(pathToFetch, query, client, queryType, verbose = false) {
+export async function runQuery(
+ pathToFetch: string | string[],
+ query: string,
+ client: KustoClient,
+ queryType: string,
+ verbose: boolean = false,
+): Promise<KustoQueryResult | null> {
// Display query if verbose mode is on
if (verbose) {
console.log(`\n--- EXECUTING QUERY FOR "${queryType.toUpperCase()}" ---`)
diff --git a/src/metrics/queries/bounces.js b/src/metrics/queries/bounces.ts
similarity index 52%
rename from src/metrics/queries/bounces.js
rename to src/metrics/queries/bounces.ts
index 465d6896bac3..0ca65b7fb2bc 100644
--- a/src/metrics/queries/bounces.js
+++ b/src/metrics/queries/bounces.ts
@@ -1,25 +1,36 @@
-import { runQuery } from '#src/metrics/lib/kusto-client.js'
-import { SHARED_DECLARATIONS, SHARED_FILTERS } from '#src/metrics/queries/constants.js'
+import { runQuery } from '@/metrics/lib/kusto-client'
+import { SHARED_DECLARATIONS, SHARED_FILTERS } from '@/metrics/queries/constants'
+import type { DateRange } from '@/metrics/lib/dates'
+import type { Client as KustoClient } from 'azure-kusto-data'
const QUERY_TYPE = 'bounces'
export async function getBounces(
- pathToFetch,
- client,
- dates,
- version = null,
- verbose = false,
- queryType = QUERY_TYPE,
-) {
+ pathToFetch: string | string[],
+ client: KustoClient,
+ dates: DateRange,
+ version: string | null = null,
+ verbose: boolean = false,
+ queryType: string = QUERY_TYPE,
+): Promise<string> {
const query = getBouncesQuery(pathToFetch, dates, version)
const results = await runQuery(pathToFetch, query, client, queryType, verbose)
+
+ if (!results) {
+ return '0%'
+ }
+
const data = JSON.parse(results.primaryResults[0].toString()).data[0]
// Extract Bounces
const bounces = data.Bounces
return bounces
}
-export function getBouncesQuery(pathToFetch, dates, version) {
+export function getBouncesQuery(
+ pathToFetch: string | string[],
+ dates: DateRange,
+ version: string | null,
+): string {
return `
${SHARED_DECLARATIONS(pathToFetch, dates, version)}
let _exits = () {
@@ -28,8 +39,8 @@ export function getBouncesQuery(pathToFetch, dates, version) {
};
_exits
| summarize Bounces=round(
- countif(exit_scroll_length < 0.1 and exit_visit_duration < 5) /
- toreal(count()),
+ countif(exit_scroll_length < 0.1 and exit_visit_duration < 5) /
+ toreal(count()),
2
)
| project Bounces=strcat(toint(
diff --git a/src/metrics/queries/constants.js b/src/metrics/queries/constants.ts
similarity index 86%
rename from src/metrics/queries/constants.js
rename to src/metrics/queries/constants.ts
index be732f5f01a7..5e060f8a47dc 100644
--- a/src/metrics/queries/constants.js
+++ b/src/metrics/queries/constants.ts
@@ -1,5 +1,11 @@
+import type { DateRange } from '@/metrics/lib/dates'
+
// SHARED QUERY CONSTANTS
-export const SHARED_DECLARATIONS = (path, dates, version) =>
+export const SHARED_DECLARATIONS = (
+ path: string | string[],
+ dates: DateRange,
+ version: string | null,
+): string =>
`
let _article = dynamic(['${Array.isArray(path) ? path.join("', '") : path}']);
let _articleType = dynamic(null);
diff --git a/src/metrics/queries/exits-to-support.js b/src/metrics/queries/exits-to-support.ts
similarity index 60%
rename from src/metrics/queries/exits-to-support.js
rename to src/metrics/queries/exits-to-support.ts
index a4ac2d156d86..ff85d2201874 100644
--- a/src/metrics/queries/exits-to-support.js
+++ b/src/metrics/queries/exits-to-support.ts
@@ -1,25 +1,36 @@
-import { runQuery } from '#src/metrics/lib/kusto-client.js'
-import { SHARED_DECLARATIONS, SHARED_FILTERS } from '#src/metrics/queries/constants.js'
+import { runQuery } from '@/metrics/lib/kusto-client'
+import { SHARED_DECLARATIONS, SHARED_FILTERS } from '@/metrics/queries/constants'
+import type { DateRange } from '@/metrics/lib/dates'
+import type { Client as KustoClient } from 'azure-kusto-data'
const QUERY_TYPE = 'exits'
export async function getExitsToSupport(
- pathToFetch,
- client,
- dates,
- version = null,
- verbose = false,
- queryType = QUERY_TYPE,
-) {
+ pathToFetch: string | string[],
+ client: KustoClient,
+ dates: DateRange,
+ version: string | null = null,
+ verbose: boolean = false,
+ queryType: string = QUERY_TYPE,
+): Promise<string> {
const query = getExitsQueryStatement(pathToFetch, dates, version)
const results = await runQuery(pathToFetch, query, client, queryType, verbose)
+
+ if (!results) {
+ return '0%'
+ }
+
const data = JSON.parse(results.primaryResults[0].toString()).data[0]
// Extract Column1
const exitsToSupport = data.Column1
return exitsToSupport
}
-export function getExitsQueryStatement(pathToFetch, dates, version) {
+export function getExitsQueryStatement(
+ pathToFetch: string | string[],
+ dates: DateRange,
+ version: string | null,
+): string {
return `
${SHARED_DECLARATIONS(pathToFetch, dates, version)}
let _links = () {
@@ -30,7 +41,7 @@ export function getExitsQueryStatement(pathToFetch, dates, version) {
| where isempty(link_samesite) or link_samesite == false
| where link_samepage != true // allow false or null
| extend link_url_parsed=parse_url(link_url)
- | extend IsSupport=tostring(link_url_parsed.Host) == "support.github.com"
+ | extend IsSupport=tostring(link_url_parsed.Host) == "support.github.com"
and tostring(link_url_parsed.path) != "/enterprise/server-upgrade"
| summarize Ratio=round(countif(IsSupport) / toreal(count()), 2)
| project strcat(toint(Ratio * 100), '%')
diff --git a/src/metrics/queries/survey-score.js b/src/metrics/queries/survey-score.ts
similarity index 55%
rename from src/metrics/queries/survey-score.js
rename to src/metrics/queries/survey-score.ts
index 5c42290eb5b6..caf7624d9f4f 100644
--- a/src/metrics/queries/survey-score.js
+++ b/src/metrics/queries/survey-score.ts
@@ -1,25 +1,36 @@
-import { runQuery } from '#src/metrics/lib/kusto-client.js'
-import { SHARED_DECLARATIONS, SHARED_FILTERS } from '#src/metrics/queries/constants.js'
+import { runQuery } from '@/metrics/lib/kusto-client'
+import { SHARED_DECLARATIONS, SHARED_FILTERS } from '@/metrics/queries/constants'
+import type { DateRange } from '@/metrics/lib/dates'
+import type { Client as KustoClient } from 'azure-kusto-data'
const QUERY_TYPE = 'score'
export async function getScore(
- pathToFetch,
- client,
- dates,
- version = null,
- verbose = false,
- queryType = QUERY_TYPE,
-) {
+ pathToFetch: string | string[],
+ client: KustoClient,
+ dates: DateRange,
+ version: string | null = null,
+ verbose: boolean = false,
+ queryType: string = QUERY_TYPE,
+): Promise<string> {
const query = getScoreQuery(pathToFetch, dates, version)
const results = await runQuery(pathToFetch, query, client, queryType, verbose)
+
+ if (!results) {
+ return '0%'
+ }
+
const data = JSON.parse(results.primaryResults[0].toString()).data[0]
// Extract Score
const score = data.Score
return score
}
-export function getScoreQuery(pathToFetch, dates, version) {
+export function getScoreQuery(
+ pathToFetch: string | string[],
+ dates: DateRange,
+ version: string | null,
+): string {
return `
${SHARED_DECLARATIONS(pathToFetch, dates, version)}
let _surveys = () {
@@ -33,8 +44,8 @@ export function getScoreQuery(pathToFetch, dates, version) {
};
_surveys
| summarize Score=round(
- (countif(survey_vote) + 0.75 * 30)
- / (count() + 30),
+ (countif(survey_vote) + 0.75 * 30)
+ / (count() + 30),
2
)
| project Score=strcat(toint(Score * 100), '%')
diff --git a/src/metrics/queries/users.js b/src/metrics/queries/users.js
deleted file mode 100644
index 0df19d0f4514..000000000000
--- a/src/metrics/queries/users.js
+++ /dev/null
@@ -1,32 +0,0 @@
-import { runQuery } from '#src/metrics/lib/kusto-client.js'
-import { SHARED_DECLARATIONS, SHARED_FILTERS } from '#src/metrics/queries/constants.js'
-
-const QUERY_TYPE = 'users'
-
-export async function getUsers(
- pathToFetch,
- client,
- dates,
- version = null,
- verbose = false,
- queryType = QUERY_TYPE,
-) {
- const query = getUsersQuery(pathToFetch, dates, version)
- const results = await runQuery(pathToFetch, query, client, queryType, verbose)
- const data = JSON.parse(results.primaryResults[0].toString()).data[0]
- // Extract Users
- const users = data.Users
- return users.toLocaleString()
-}
-
-export function getUsersQuery(pathToFetch, dates, version) {
- return `
- ${SHARED_DECLARATIONS(pathToFetch, dates, version)}
- let _pages = () {
- docs_v0_page_event
- ${SHARED_FILTERS}
- };
- _pages
- | summarize Users=dcount(tostring(context.user))
- `
-}
diff --git a/src/metrics/queries/users.ts b/src/metrics/queries/users.ts
new file mode 100644
index 000000000000..dc4f197c155e
--- /dev/null
+++ b/src/metrics/queries/users.ts
@@ -0,0 +1,43 @@
+import { runQuery } from '@/metrics/lib/kusto-client'
+import { SHARED_DECLARATIONS, SHARED_FILTERS } from '@/metrics/queries/constants'
+import type { DateRange } from '@/metrics/lib/dates'
+import type { Client as KustoClient } from 'azure-kusto-data'
+
+const QUERY_TYPE = 'users'
+
+export async function getUsers(
+ pathToFetch: string | string[],
+ client: KustoClient,
+ dates: DateRange,
+ version: string | null = null,
+ verbose: boolean = false,
+ queryType: string = QUERY_TYPE,
+): Promise<string> {
+ const query = getUsersQuery(pathToFetch, dates, version)
+ const results = await runQuery(pathToFetch, query, client, queryType, verbose)
+
+ if (!results) {
+ return '0'
+ }
+
+ const data = JSON.parse(results.primaryResults[0].toString()).data[0]
+ // Extract Users
+ const users = data.Users
+ return users.toLocaleString()
+}
+
+export function getUsersQuery(
+ pathToFetch: string | string[],
+ dates: DateRange,
+ version: string | null,
+): string {
+ return `
+ ${SHARED_DECLARATIONS(pathToFetch, dates, version)}
+ let _pages = () {
+ docs_v0_page_event
+ ${SHARED_FILTERS}
+ };
+ _pages
+ | summarize Users=dcount(tostring(context.user))
+ `
+}
diff --git a/src/metrics/queries/view-duration.js b/src/metrics/queries/view-duration.ts
similarity index 50%
rename from src/metrics/queries/view-duration.js
rename to src/metrics/queries/view-duration.ts
index 95950e10f8ba..1f53bcee3cea 100644
--- a/src/metrics/queries/view-duration.js
+++ b/src/metrics/queries/view-duration.ts
@@ -1,25 +1,36 @@
-import { runQuery } from '#src/metrics/lib/kusto-client.js'
-import { SHARED_DECLARATIONS, SHARED_FILTERS } from '#src/metrics/queries/constants.js'
+import { runQuery } from '@/metrics/lib/kusto-client'
+import { SHARED_DECLARATIONS, SHARED_FILTERS } from '@/metrics/queries/constants'
+import type { DateRange } from '@/metrics/lib/dates'
+import type { Client as KustoClient } from 'azure-kusto-data'
const QUERY_TYPE = 'view duration'
export async function getViewDuration(
- pathToFetch,
- client,
- dates,
- version = null,
- verbose = false,
- queryType = QUERY_TYPE,
-) {
+ pathToFetch: string | string[],
+ client: KustoClient,
+ dates: DateRange,
+ version: string | null = null,
+ verbose: boolean = false,
+ queryType: string = QUERY_TYPE,
+): Promise<string> {
const query = getViewDurationQuery(pathToFetch, dates, version)
const results = await runQuery(pathToFetch, query, client, queryType, verbose)
+
+ if (!results) {
+ return '0 seconds'
+ }
+
const data = JSON.parse(results.primaryResults[0].toString()).data[0]
// Extract avg_VisitDuration
const viewDuration = data.avg_VisitDuration
return `${viewDuration} seconds`
}
-export function getViewDurationQuery(pathToFetch, dates, version) {
+export function getViewDurationQuery(
+ pathToFetch: string | string[],
+ dates: DateRange,
+ version: string | null,
+): string {
return `
${SHARED_DECLARATIONS(pathToFetch, dates, version)}
let _exits = () {
@@ -28,7 +39,7 @@ export function getViewDurationQuery(pathToFetch, dates, version) {
};
_exits
| summarize VisitDuration=round(
- percentile(toreal(exit_visit_duration), 50),
+ percentile(toreal(exit_visit_duration), 50),
2
)
by bin(timestamp, 1d)
diff --git a/src/metrics/queries/views.js b/src/metrics/queries/views.js
deleted file mode 100644
index 80438d8c05ca..000000000000
--- a/src/metrics/queries/views.js
+++ /dev/null
@@ -1,32 +0,0 @@
-import { runQuery } from '#src/metrics/lib/kusto-client.js'
-import { SHARED_DECLARATIONS, SHARED_FILTERS } from '#src/metrics/queries/constants.js'
-
-const QUERY_TYPE = 'views'
-
-export async function getViews(
- pathToFetch,
- client,
- dates,
- version = null,
- verbose = false,
- queryType = QUERY_TYPE,
-) {
- const query = getViewsQuery(pathToFetch, dates, version)
- const results = await runQuery(pathToFetch, query, client, queryType, verbose)
- const data = JSON.parse(results.primaryResults[0].toString()).data[0]
- // Extract Views
- const views = data.Views
- return views.toLocaleString()
-}
-
-export function getViewsQuery(pathToFetch, dates, version) {
- return `
- ${SHARED_DECLARATIONS(pathToFetch, dates, version)}
- let _pages = () {
- docs_v0_page_event
- ${SHARED_FILTERS}
- };
- _pages
- | summarize Views=count()
- `
-}
diff --git a/src/metrics/queries/views.ts b/src/metrics/queries/views.ts
new file mode 100644
index 000000000000..51bab657fd90
--- /dev/null
+++ b/src/metrics/queries/views.ts
@@ -0,0 +1,43 @@
+import { runQuery } from '@/metrics/lib/kusto-client'
+import { SHARED_DECLARATIONS, SHARED_FILTERS } from '@/metrics/queries/constants'
+import type { DateRange } from '@/metrics/lib/dates'
+import type { Client as KustoClient } from 'azure-kusto-data'
+
+const QUERY_TYPE = 'views'
+
+export async function getViews(
+ pathToFetch: string | string[],
+ client: KustoClient,
+ dates: DateRange,
+ version: string | null = null,
+ verbose: boolean = false,
+ queryType: string = QUERY_TYPE,
+): Promise<string> {
+ const query = getViewsQuery(pathToFetch, dates, version)
+ const results = await runQuery(pathToFetch, query, client, queryType, verbose)
+
+ if (!results) {
+ return '0'
+ }
+
+ const data = JSON.parse(results.primaryResults[0].toString()).data[0]
+ // Extract Views
+ const views = data.Views
+ return views.toLocaleString()
+}
+
+export function getViewsQuery(
+ pathToFetch: string | string[],
+ dates: DateRange,
+ version: string | null,
+): string {
+ return `
+ ${SHARED_DECLARATIONS(pathToFetch, dates, version)}
+ let _pages = () {
+ docs_v0_page_event
+ ${SHARED_FILTERS}
+ };
+ _pages
+ | summarize Views=count()
+ `
+}
diff --git a/src/metrics/scripts/docsaudit.js b/src/metrics/scripts/docsaudit.ts
similarity index 72%
rename from src/metrics/scripts/docsaudit.js
rename to src/metrics/scripts/docsaudit.ts
index ff87cafee1b1..011998939751 100644
--- a/src/metrics/scripts/docsaudit.js
+++ b/src/metrics/scripts/docsaudit.ts
@@ -4,28 +4,33 @@ import fs from 'fs'
import path from 'path'
import { fileURLToPath } from 'url'
import { Command } from 'commander'
-import walkFiles from '#src/workflows/walk-files.ts'
+import walkFiles from '@/workflows/walk-files'
import readFrontmatter from '@/frame/lib/read-frontmatter.js'
-import { getKustoClient } from '#src/metrics/lib/kusto-client.js'
-import { getDates } from 'src/metrics/lib/dates.js'
-import { getViews } from '#src/metrics/queries/views.js'
-import { getUsers } from '#src/metrics/queries/users.js'
+import { getKustoClient } from '@/metrics/lib/kusto-client'
+import { getDates, type DateRange } from '@/metrics/lib/dates'
+import { getViews } from '@/metrics/queries/views'
+import { getUsers } from '@/metrics/queries/users'
const __filename = fileURLToPath(import.meta.url)
const __dirname = path.dirname(__filename)
const ROOTDIR = process.cwd()
+interface CliOptions {
+ range?: string
+ verbose?: boolean
+}
+
const program = new Command()
program
.name('docsaudit')
.description('Get data about a top-level docs product and output a CSV')
.argument('<auditDir>', 'Name of the content directory you want to audit, e.g., actions')
- .option('-r, --range <days>', 'Number of days to look back', 30)
+ .option('-r, --range <days>', 'Number of days to look back', '30')
.option('--verbose', 'Display Kusto queries being executed')
.parse(process.argv)
-const options = program.opts()
+const options = program.opts<CliOptions>()
const [auditDirName] = program.args
const contentDir = path.join(ROOTDIR, 'content')
const auditDir = path.join(contentDir, auditDirName)
@@ -37,27 +42,32 @@ if (!fs.existsSync(auditDir)) {
}
// Get dates object in format { endDate, startDate, friendlyRange }
-const dates = getDates(options.range)
+const dates: DateRange = getDates(options.range)
const files = walkFiles(auditDir, ['.md'])
console.log(`Auditing the ${files.length} "${auditDirName}" files. This may take a while.\n`)
main()
-async function main() {
+async function main(): Promise<void> {
const client = getKustoClient()
+ if (!client) {
+ console.error('Failed to initialize Kusto client')
+ process.exit(1)
+ }
+
let csvString = `title,path,versions,${options.range}d views,${options.range}d users\n`
console.log(`Assembling data for these CSV columns: ${csvString}`)
// Get the title, path, and versions from the filesystem
// Get the views and users from the Kusto API
- const results = []
+ const results: string[] = []
for (const file of files) {
const contents = await fs.promises.readFile(file)
const contentPath = path.relative(ROOTDIR, file)
const { data } = readFrontmatter(contents)
- const versionString = JSON.stringify(data.versions).replaceAll('"', "'")
+ const versionString = JSON.stringify(data?.versions || {}).replaceAll('"', "'")
const pathToQuery = getPathToQuery(file)
// Pass null to get all versions (the default if no version is provided)
const version = null
@@ -65,7 +75,7 @@ async function main() {
const isFirst = results.length === 0
const views = await getViews(pathToQuery, client, dates, version, options.verbose && isFirst)
const users = await getUsers(pathToQuery, client, dates, version, options.verbose && isFirst)
- const csvEntry = `"${data.title}","${contentPath}","${versionString}","${views}","${users}"`
+ const csvEntry = `"${data?.title || 'Unknown'}","${contentPath}","${versionString}","${views}","${users}"`
console.log(csvEntry)
results.push(csvEntry)
}
@@ -75,6 +85,6 @@ async function main() {
console.log(`Done! Wrote ${outputFile}`)
}
-function getPathToQuery(file) {
+function getPathToQuery(file: string): string {
return path.relative(contentDir, file).replace('/index.md', '').replace('.md', '')
}
diff --git a/src/metrics/scripts/docstat.js b/src/metrics/scripts/docstat.ts
old mode 100755
new mode 100644
similarity index 84%
rename from src/metrics/scripts/docstat.js
rename to src/metrics/scripts/docstat.ts
index 65428ccb276b..3fbc8b79a63d
--- a/src/metrics/scripts/docstat.js
+++ b/src/metrics/scripts/docstat.ts
@@ -6,14 +6,14 @@ import { Command } from 'commander'
import chalk from 'chalk'
import ora from 'ora'
import frontmatter from '@/frame/lib/read-frontmatter.js'
-import { getKustoClient } from '#src/metrics/lib/kusto-client.js'
-import { getDates } from 'src/metrics/lib/dates.js'
-import { getViews } from '#src/metrics/queries/views.js'
-import { getUsers } from '#src/metrics/queries/users.js'
-import { getViewDuration } from '#src/metrics/queries/view-duration.js'
-import { getBounces } from '#src/metrics/queries/bounces.js'
-import { getScore } from '#src/metrics/queries/survey-score.js'
-import { getExitsToSupport } from '#src/metrics/queries/exits-to-support.js'
+import { getKustoClient } from '@/metrics/lib/kusto-client'
+import { getDates, type DateRange } from '@/metrics/lib/dates'
+import { getViews } from '@/metrics/queries/views'
+import { getUsers } from '@/metrics/queries/users'
+import { getViewDuration } from '@/metrics/queries/view-duration'
+import { getBounces } from '@/metrics/queries/bounces'
+import { getScore } from '@/metrics/queries/survey-score'
+import { getExitsToSupport } from '@/metrics/queries/exits-to-support'
const { green, white, red, blue } = chalk
@@ -22,6 +22,68 @@ const DOCS_API_PATH = 'https://docs.github.com/api/pagelist/en'
const FREE_PRO_TEAM = 'free-pro-team@latest'
const ENTERPRISE_REGEX = /enterprise-(server|cloud)@/
+interface CliOptions {
+ range?: string
+ compare?: boolean
+ views?: boolean
+ users?: boolean
+ viewDuration?: boolean
+ bounces?: boolean
+ score?: boolean
+ exits?: boolean
+ json?: boolean
+ skipValidation?: boolean
+ redirects?: boolean
+ fptOnly?: boolean
+ verbose?: boolean
+ defaultToAll?: boolean
+ showDocset?: boolean
+ allVersions?: boolean
+}
+
+interface QueryResults {
+ views?: string
+ viewsDocset?: string
+ users?: string
+ usersDocset?: string
+ viewDuration?: string
+ viewDurationDocset?: string
+ bounces?: string
+ bouncesDocset?: string
+ score?: string
+ scoreDocset?: string
+ exits?: string
+ exitsDocset?: string
+}
+
+interface JsonOutput {
+ daysRange: string
+ startDate: string
+ endDate: string
+ dateRange: string
+ inputUrl: string
+ data: {
+ path: string
+ views?: string
+ users?: string
+ viewDuration?: string
+ bounces?: string
+ score?: string
+ exits?: string
+ }
+ docset?: {
+ path: string
+ data: {
+ views?: string
+ users?: string
+ viewDuration?: string
+ bounces?: string
+ score?: string
+ exits?: string
+ }
+ }
+}
+
const program = new Command()
program
@@ -37,7 +99,7 @@ program
- Exits to support`,
)
.argument('<url>', 'URL to query data for')
- .option('-r, --range <days>', 'Number of days to look back', 30)
+ .option('-r, --range <days>', 'Number of days to look back', '30')
.option('-c, --compare', 'Compare with top-level docset data')
.option('-v, --views', 'Get page views')
.option('-u, --users', 'Get unique users')
@@ -55,7 +117,7 @@ program
.option('--verbose', 'Display Kusto queries being executed')
.parse(process.argv)
-const options = program.opts()
+const options = program.opts<CliOptions>()
// If specific options are not provided, default to all
options.defaultToAll = !(
@@ -84,7 +146,7 @@ const providedPath = program.args[0]
let cleanPath = getCleanPath(providedPath)
// Get the version
-let version = getVersion(cleanPath)
+let version: string | null = getVersion(cleanPath)
let usingFptOnly = !!options.fptOnly
// If the URL does not specify a version, default to all versions unless --fptOnly is passed
@@ -127,7 +189,7 @@ if (options.allVersions) version = null
const docsetPath = cleanPath.split('/')[0]
// Get redirect_from frontmatter and include those paths in the queries
-let redirects = []
+let redirects: string[] = []
if (options.redirects) {
let contentPath = path.join('content', cleanPath)
contentPath = fs.existsSync(contentPath)
@@ -135,19 +197,25 @@ if (options.redirects) {
: `${contentPath}.md`
const { data } = frontmatter(fs.readFileSync(contentPath, 'utf8'))
// If redirect_from paths exists, they'll be in this format: /foo/bar
- redirects = (data.redirect_from || []).map((oldPath) => oldPath.replace('/', '')) // remove leading '/'
+ redirects = (data?.redirect_from || []).map((oldPath: string) => oldPath.replace('/', '')) // remove leading '/'
}
const queryPaths = [cleanPath].concat(redirects)
// Get dates object in format { endDate, startDate, friendlyRange }
-const dates = getDates(options.range)
+const dates: DateRange = getDates(options.range)
-async function main() {
+async function main(): Promise<void> {
const spinner = ora('Connecting to Kusto...').start()
try {
const client = getKustoClient()
+
+ if (!client) {
+ spinner.fail('Failed to connect to Kusto')
+ process.exit(1)
+ }
+
spinner.text = 'Connected! Querying Kusto...'
// Only show docset stats if option is passed AND if the given path is not already a docset.
@@ -157,8 +225,8 @@ async function main() {
}
// Create query promises for all requested metrics
- const queryPromises = []
- const results = {}
+ const queryPromises: Promise<void>[] = []
+ const results: QueryResults = {}
// Setup all the promises for parallel execution
if (options.views) {
@@ -296,8 +364,8 @@ async function main() {
// Output JSON and exit
if (options.json) {
- const jsonOutput = {
- daysRange: options.range,
+ const jsonOutput: JsonOutput = {
+ daysRange: options.range || '30',
startDate: dates.startDate,
endDate: dates.endDate,
dateRange: dates.friendlyRange,
@@ -358,7 +426,7 @@ async function main() {
return // Exit early
}
- console.log(white(`Last ${options.range} days:`), blue(dates.friendlyRange))
+ console.log(white(`Last ${options.range || '30'} days:`), blue(dates.friendlyRange))
console.log(green('-------------------------------------------'))
console.log(green('Path:'), white(cleanPath))
if (options.redirects) {
@@ -435,7 +503,7 @@ main().catch((error) => {
// Given input: https://docs.github.com/en/copilot/managing-copilot/
// Use: copilot/managing-copilot
-function getCleanPath(providedPath) {
+function getCleanPath(providedPath: string): string {
let clean = providedPath
const cleanArr = clean.split('?') // remove query params
if (cleanArr.length > 1) cleanArr.pop()
@@ -454,13 +522,13 @@ function getCleanPath(providedPath) {
return clean
}
-function getVersion(cleanPath) {
+function getVersion(cleanPath: string): string {
const pathParts = cleanPath.split('/')
const version = ENTERPRISE_REGEX.test(pathParts[0]) ? pathParts[0] : FREE_PRO_TEAM
return version
}
-function removeVersionSegment(cleanPath, version) {
+function removeVersionSegment(cleanPath: string, version: string): string {
if (version === FREE_PRO_TEAM) return cleanPath
const pathParts = cleanPath.split('/')
pathParts.shift()
@@ -469,7 +537,7 @@ function removeVersionSegment(cleanPath, version) {
}
// Try to find the path in the list of valid pages at https://docs.github.com/api/pagelist/en
-async function validatePath(cleanPath, version) {
+async function validatePath(cleanPath: string, version: string): Promise<void> {
// Only Kusto uses 'index' for the homepage; the Docs API uses '/en'
const basePath = cleanPath === 'index' ? '' : cleanPath
@@ -478,16 +546,18 @@ async function validatePath(cleanPath, version) {
? path.join('/', 'en', basePath)
: path.join('/', 'en', version, basePath)
- let data
+ let data: string
try {
const response = await fetch(VERSIONED_DOCS_API_PATH)
data = await response.text()
} catch (err) {
console.error(`Error fetching data from ${VERSIONED_DOCS_API_PATH}`)
+ throw err
}
if (data.startsWith('{')) {
- if (JSON.parse(data).error) {
+ const parsedData = JSON.parse(data)
+ if (parsedData.error) {
console.error(data)
process.exit(1)
}
From 3b86e3fb43ce5c508f70ddf959f5a750ffcbaf23 Mon Sep 17 00:00:00 2001
From: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com>
Date: Mon, 30 Jun 2025 10:18:32 -0700
Subject: [PATCH 03/12] Rename all BYOK mentions of "custom keys" to "API keys"
(#56336)
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
---
.../set-up-custom-model-integration-models-byok.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/content/github-models/github-models-at-scale/set-up-custom-model-integration-models-byok.md b/content/github-models/github-models-at-scale/set-up-custom-model-integration-models-byok.md
index 9068289d5830..a48a98383657 100644
--- a/content/github-models/github-models-at-scale/set-up-custom-model-integration-models-byok.md
+++ b/content/github-models/github-models-at-scale/set-up-custom-model-integration-models-byok.md
@@ -38,8 +38,8 @@ You must first add the relevant API keys for the organization. After that, your
{% data reusables.profile.access_org %}
{% data reusables.profile.org_settings %}
{% data reusables.organizations.custom-models %}
-1. Click **Add custom key**.
-1. In the "Add a custom key" dialog, provide details about your key. **Name** and **Key** are compulsory fields.
+1. Click **Add API key**.
+1. In the "Add the API key" dialog, provide details about your key. **Name** and **API key** are compulsory fields.
1. Click **Save**.
## Enabling custom models
@@ -47,7 +47,7 @@ You must first add the relevant API keys for the organization. After that, your
{% data reusables.profile.access_org %}
{% data reusables.profile.org_settings %}
{% data reusables.organizations.models-development %}
-1. Under "Models permissions", select **All publishers** to enable models added by custom keys.
+1. Under "Models permissions", select **All publishers** to enable models added by API keys.
* If this option isn't available, you need to allow the use of the model in the organization. See [AUTOTITLE](/github-models/github-models-at-scale/manage-models-at-scale#controlling-model-usage-in-your-organization).
1. Optionally, select **Only select models** to create a custom list of enabled or disabled models. This allows you to control which models are available to your organization.
From 96da8d16398f11ed0e43461c66c2cebcad409df4 Mon Sep 17 00:00:00 2001
From: Evan Bonsignori <ebonsignori@github.com>
Date: Mon, 30 Jun 2025 10:23:31 -0700
Subject: [PATCH 04/12] launch to 100% and update public feedback URL (#56389)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
---
src/events/components/experiments/experiments.ts | 5 ++++-
src/search/components/input/SearchOverlay.tsx | 2 +-
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/src/events/components/experiments/experiments.ts b/src/events/components/experiments/experiments.ts
index b1da9440f624..7c5e83be7d24 100644
--- a/src/events/components/experiments/experiments.ts
+++ b/src/events/components/experiments/experiments.ts
@@ -21,7 +21,10 @@ export const EXPERIMENTS = {
ai_search_experiment: {
key: 'ai_search_experiment',
isActive: true, // Set to false when the experiment is over
- percentOfUsersToGetExperiment: 30, // 30% of users will get the experiment
+ // We still use an experiment for the AI Search until we:
+ // 1. Move analytics over the main dashboard
+ // 2. Don't require an emergency rollback, which experiments provides us
+ percentOfUsersToGetExperiment: 100, // 100% of users will get the experiment
includeVariationInContext: true, // All events will include the `experiment_variation` of the `ai_search_experiment`
limitToLanguages: ['en'], // Only users with the `en` language will be included in the experiment
alwaysShowForStaff: true, // When set to true, staff will always see the experiment (determined by the `staffonly` cookie)
diff --git a/src/search/components/input/SearchOverlay.tsx b/src/search/components/input/SearchOverlay.tsx
index c2e4d2e6d202..177a6f7a8205 100644
--- a/src/search/components/input/SearchOverlay.tsx
+++ b/src/search/components/input/SearchOverlay.tsx
@@ -805,7 +805,7 @@ export function SearchOverlay({
window.open('https://github.com/github/docs-team/discussions/5172', '_blank')
} else {
// public discussion for feedback
- window.open('https://github.com/orgs/community/discussions/158488', '_blank')
+ window.open('https://github.com/orgs/community/discussions/164214', '_blank')
}
}}
as="button"
From bb325d575d18c59408542d872b1fb471c9c244b2 Mon Sep 17 00:00:00 2001
From: docs-bot <77750099+docs-bot@users.noreply.github.com>
Date: Mon, 30 Jun 2025 10:44:03 -0700
Subject: [PATCH 05/12] Update docs changelog (for PR #56101) (#56360)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
---
CHANGELOG.md | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 80d173763104..67d797bfec26 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,6 +12,12 @@ Get started at [Achieving your company's engineering goals with GitHub Copilot](
**27 June 2025**
+We've published a new guide about how to combine use of GitHub Copilot's agent mode with Model Context Protocol (MCP) servers to complete complex tasks through agentic "loops" - illustrated through an accessibility compliance example. The guide also discusses best practices and benefits around using these two features together. See [Enhancing Copilot agent mode with MCP](https://docs.github.com/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp).
+
+<hr>
+
+**27 June 2025**
+
We’ve published a new set of new documentation articles designed to help users make the most of the **Dependabot metrics page** in the organization’s security overview.
These clear, actionable guides help users:
From b63d9f03359a8532ff416bde9fec1a7af0df5262 Mon Sep 17 00:00:00 2001
From: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
Date: Mon, 30 Jun 2025 19:04:34 +0100
Subject: [PATCH 06/12] Adds a missing redirect (#56390)
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
---
.../managing-workflow-runs/manually-running-a-workflow.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow.md b/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow.md
index 3f2031f90b2b..b21b91b199dd 100644
--- a/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow.md
+++ b/content/actions/how-tos/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow.md
@@ -10,6 +10,7 @@ redirect_from:
- /actions/managing-workflow-runs/manually-running-a-workflow
- /actions/using-workflows/manually-running-a-workflow
- /actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow
+ - /articles/configuring-a-workflow
---
{% data reusables.actions.enterprise-github-hosted-runners %}
From 02c09ec204d3c75d7902685dc1ee9b3493ac8092 Mon Sep 17 00:00:00 2001
From: docs-bot <77750099+docs-bot@users.noreply.github.com>
Date: Mon, 30 Jun 2025 11:07:02 -0700
Subject: [PATCH 07/12] Update OpenAPI Description (#56387)
Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com>
---
.../code-scanning/alert-dismissal-requests.md | 13 +
content/rest/code-scanning/index.md | 1 +
.../fine-grained-pat-permissions.json | 2 +-
.../fine-grained-pat-permissions.json | 75 +-
.../ghec-2022-11-28/fine-grained-pat.json | 24 +
.../server-to-server-permissions.json | 87 +-
.../server-to-server-rest.json | 24 +
.../ghec-2022-11-28/user-to-server-rest.json | 24 +
.../fine-grained-pat-permissions.json | 4 +-
.../server-to-server-permissions.json | 2 +-
.../fine-grained-pat-permissions.json | 4 +-
.../server-to-server-permissions.json | 2 +-
.../fine-grained-pat-permissions.json | 4 +-
.../server-to-server-permissions.json | 2 +-
.../fine-grained-pat-permissions.json | 4 +-
.../server-to-server-permissions.json | 2 +-
.../fine-grained-pat-permissions.json | 4 +-
.../server-to-server-permissions.json | 2 +-
src/github-apps/lib/config.json | 2 +-
src/rest/data/fpt-2022-11-28/schema.json | 308 ++--
src/rest/data/ghec-2022-11-28/schema.json | 1378 ++++++++++++++++-
.../data/ghes-3.13-2022-11-28/schema.json | 43 +-
.../data/ghes-3.14-2022-11-28/schema.json | 353 +++--
.../data/ghes-3.15-2022-11-28/schema.json | 43 +-
.../data/ghes-3.16-2022-11-28/schema.json | 43 +-
.../data/ghes-3.17-2022-11-28/schema.json | 43 +-
src/rest/lib/config.json | 2 +-
src/webhooks/lib/config.json | 2 +-
28 files changed, 2007 insertions(+), 490 deletions(-)
create mode 100644 content/rest/code-scanning/alert-dismissal-requests.md
diff --git a/content/rest/code-scanning/alert-dismissal-requests.md b/content/rest/code-scanning/alert-dismissal-requests.md
new file mode 100644
index 000000000000..53300f4b6d0c
--- /dev/null
+++ b/content/rest/code-scanning/alert-dismissal-requests.md
@@ -0,0 +1,13 @@
+---
+title: REST API endpoints for {% data variables.product.prodname_code_scanning %} alert dismissal requests
+shortTitle: Alert dismissal requests
+intro: Use the REST API to interact with {% data variables.product.prodname_code_scanning %} alert dismissal requests from a repository.
+versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
+ ghec: '*'
+topics:
+ - API
+autogenerated: rest
+allowTitleToDifferFromFilename: true
+---
+
+<!-- Content after this section is automatically generated -->
diff --git a/content/rest/code-scanning/index.md b/content/rest/code-scanning/index.md
index d103e6ec6a4c..6d878af647e5 100644
--- a/content/rest/code-scanning/index.md
+++ b/content/rest/code-scanning/index.md
@@ -14,6 +14,7 @@ topics:
- Code scanning
- REST
children:
+ - /alert-dismissal-requests
- /code-scanning
autogenerated: rest
---
diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
index 66dc27855714..d2f2165e43e8 100644
--- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
@@ -8288,4 +8288,4 @@
}
]
}
-}
+}
\ No newline at end of file
diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
index 75e64e80181a..f17bd9e3ec2a 100644
--- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
@@ -1,7 +1,7 @@
{
"enterprise_custom_properties": {
"title": "Custom properties",
- "displayTitle": "Business permissions for \"Custom properties\"",
+ "displayTitle": "Enterprise permissions for \"Custom properties\"",
"permissions": [
{
"category": "enterprise-admin",
@@ -61,7 +61,7 @@
},
"enterprise_scim": {
"title": "Enterprise SCIM",
- "displayTitle": "Business permissions for \"Enterprise SCIM\"",
+ "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
"permissions": [
{
"category": "enterprise-admin",
@@ -2264,6 +2264,48 @@
}
]
},
+ "organization_code_scanning_dismissal_requests": {
+ "title": "Organization dismissal requests for code scanning",
+ "displayTitle": "Organization permissions for \"Organization dismissal requests for code scanning\"",
+ "permissions": [
+ {
+ "category": "code-scanning",
+ "slug": "list-dismissal-requests-for-code-scanning-alerts-for-an-organization",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/dismissal-requests/code-scanning",
+ "additional-permissions": false,
+ "access": "read"
+ },
+ {
+ "category": "code-scanning",
+ "slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning",
+ "additional-permissions": true,
+ "access": "read"
+ },
+ {
+ "category": "code-scanning",
+ "slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
+ "additional-permissions": true,
+ "access": "read"
+ },
+ {
+ "category": "code-scanning",
+ "slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
+ "additional-permissions": true,
+ "access": "write"
+ }
+ ]
+ },
"organization_private_registries": {
"title": "Organization private registries",
"displayTitle": "Organization permissions for \"Organization private registries\"",
@@ -4961,6 +5003,33 @@
"requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}",
"additional-permissions": false,
"access": "read"
+ },
+ {
+ "category": "code-scanning",
+ "slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning",
+ "additional-permissions": true,
+ "access": "read"
+ },
+ {
+ "category": "code-scanning",
+ "slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
+ "additional-permissions": true,
+ "access": "read"
+ },
+ {
+ "category": "code-scanning",
+ "slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
+ "additional-permissions": true,
+ "access": "read"
}
]
},
@@ -9002,4 +9071,4 @@
}
]
}
-}
+}
\ No newline at end of file
diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
index 8f5bc9c4171c..b59a79100994 100644
--- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
+++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
@@ -1512,6 +1512,12 @@
"verb": "get",
"requestPath": "/orgs/{org}/code-scanning/alerts"
},
+ {
+ "slug": "list-dismissal-requests-for-code-scanning-alerts-for-an-organization",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/dismissal-requests/code-scanning"
+ },
{
"slug": "list-code-scanning-alerts-for-a-repository",
"subcategory": "code-scanning",
@@ -1631,6 +1637,24 @@
"subcategory": "code-scanning",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}"
+ },
+ {
+ "slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning"
+ },
+ {
+ "slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}"
+ },
+ {
+ "slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}"
}
],
"code-security": [
diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
index a1cd8431eee8..37fe7ed46828 100644
--- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
@@ -1,7 +1,7 @@
{
"enterprise_custom_properties": {
"title": "Custom properties",
- "displayTitle": "Business permissions for \"Custom properties\"",
+ "displayTitle": "Enterprise permissions for \"Custom properties\"",
"permissions": [
{
"category": "enterprise-admin",
@@ -73,7 +73,7 @@
},
"enterprise_scim": {
"title": "Enterprise SCIM",
- "displayTitle": "Business permissions for \"Enterprise SCIM\"",
+ "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
"permissions": [
{
"category": "enterprise-admin",
@@ -2742,6 +2742,56 @@
}
]
},
+ "organization_code_scanning_dismissal_requests": {
+ "title": "Organization dismissal requests for code scanning",
+ "displayTitle": "Organization permissions for \"Organization dismissal requests for code scanning\"",
+ "permissions": [
+ {
+ "category": "code-scanning",
+ "slug": "list-dismissal-requests-for-code-scanning-alerts-for-an-organization",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/dismissal-requests/code-scanning",
+ "access": "read",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": false
+ },
+ {
+ "category": "code-scanning",
+ "slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning",
+ "access": "read",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": true
+ },
+ {
+ "category": "code-scanning",
+ "slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
+ "access": "read",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": true
+ },
+ {
+ "category": "code-scanning",
+ "slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
+ "access": "write",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": true
+ }
+ ]
+ },
"organization_private_registries": {
"title": "Organization private registries",
"displayTitle": "Organization permissions for \"Organization private registries\"",
@@ -6019,6 +6069,39 @@
"user-to-server": true,
"server-to-server": true,
"additional-permissions": false
+ },
+ {
+ "category": "code-scanning",
+ "slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning",
+ "access": "read",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": true
+ },
+ {
+ "category": "code-scanning",
+ "slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
+ "access": "read",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": true
+ },
+ {
+ "category": "code-scanning",
+ "slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
+ "access": "read",
+ "user-to-server": true,
+ "server-to-server": true,
+ "additional-permissions": true
}
]
},
diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
index 3eebdb0b992f..47b2bb717c71 100644
--- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
+++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
@@ -1408,6 +1408,12 @@
"verb": "get",
"requestPath": "/orgs/{org}/code-scanning/alerts"
},
+ {
+ "slug": "list-dismissal-requests-for-code-scanning-alerts-for-an-organization",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/dismissal-requests/code-scanning"
+ },
{
"slug": "list-code-scanning-alerts-for-a-repository",
"subcategory": "code-scanning",
@@ -1527,6 +1533,24 @@
"subcategory": "code-scanning",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}"
+ },
+ {
+ "slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning"
+ },
+ {
+ "slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}"
+ },
+ {
+ "slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}"
}
],
"code-security": [
diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
index 8f5bc9c4171c..b59a79100994 100644
--- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
+++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
@@ -1512,6 +1512,12 @@
"verb": "get",
"requestPath": "/orgs/{org}/code-scanning/alerts"
},
+ {
+ "slug": "list-dismissal-requests-for-code-scanning-alerts-for-an-organization",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/dismissal-requests/code-scanning"
+ },
{
"slug": "list-code-scanning-alerts-for-a-repository",
"subcategory": "code-scanning",
@@ -1631,6 +1637,24 @@
"subcategory": "code-scanning",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}"
+ },
+ {
+ "slug": "list-dismissal-requests-for-code-scanning-alerts-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning"
+ },
+ {
+ "slug": "get-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}"
+ },
+ {
+ "slug": "review-a-dismissal-request-for-a-code-scanning-alert-for-a-repository",
+ "subcategory": "alert-dismissal-requests",
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}"
}
],
"code-security": [
diff --git a/src/github-apps/data/ghes-3.13-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.13-2022-11-28/fine-grained-pat-permissions.json
index e360ad6f8bd5..8ae7bee00417 100644
--- a/src/github-apps/data/ghes-3.13-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghes-3.13-2022-11-28/fine-grained-pat-permissions.json
@@ -1,7 +1,7 @@
{
"enterprise_scim": {
"title": "Enterprise SCIM",
- "displayTitle": "Business permissions for \"Enterprise SCIM\"",
+ "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
"permissions": [
{
"category": "enterprise-admin",
@@ -6527,4 +6527,4 @@
}
]
}
-}
+}
\ No newline at end of file
diff --git a/src/github-apps/data/ghes-3.13-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.13-2022-11-28/server-to-server-permissions.json
index ea44c8cfb4e7..4c69a60f5936 100644
--- a/src/github-apps/data/ghes-3.13-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghes-3.13-2022-11-28/server-to-server-permissions.json
@@ -1,7 +1,7 @@
{
"enterprise_scim": {
"title": "Enterprise SCIM",
- "displayTitle": "Business permissions for \"Enterprise SCIM\"",
+ "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
"permissions": [
{
"category": "enterprise-admin",
diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json
index 23ed1f8913fd..e862e8eec6a2 100644
--- a/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghes-3.14-2022-11-28/fine-grained-pat-permissions.json
@@ -1,7 +1,7 @@
{
"enterprise_scim": {
"title": "Enterprise SCIM",
- "displayTitle": "Business permissions for \"Enterprise SCIM\"",
+ "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
"permissions": [
{
"category": "enterprise-admin",
@@ -6659,4 +6659,4 @@
}
]
}
-}
+}
\ No newline at end of file
diff --git a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json
index 8ee51bad2fac..4ab01d7df872 100644
--- a/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghes-3.14-2022-11-28/server-to-server-permissions.json
@@ -1,7 +1,7 @@
{
"enterprise_scim": {
"title": "Enterprise SCIM",
- "displayTitle": "Business permissions for \"Enterprise SCIM\"",
+ "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
"permissions": [
{
"category": "enterprise-admin",
diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json
index e51bb0c1b42b..9b6a96326b2a 100644
--- a/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghes-3.15-2022-11-28/fine-grained-pat-permissions.json
@@ -1,7 +1,7 @@
{
"enterprise_scim": {
"title": "Enterprise SCIM",
- "displayTitle": "Business permissions for \"Enterprise SCIM\"",
+ "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
"permissions": [
{
"category": "enterprise-admin",
@@ -6767,4 +6767,4 @@
}
]
}
-}
+}
\ No newline at end of file
diff --git a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json
index 6af75f134a9b..5d98f087396b 100644
--- a/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghes-3.15-2022-11-28/server-to-server-permissions.json
@@ -1,7 +1,7 @@
{
"enterprise_scim": {
"title": "Enterprise SCIM",
- "displayTitle": "Business permissions for \"Enterprise SCIM\"",
+ "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
"permissions": [
{
"category": "enterprise-admin",
diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json
index 771e80d91687..caabdbc6be47 100644
--- a/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghes-3.16-2022-11-28/fine-grained-pat-permissions.json
@@ -1,7 +1,7 @@
{
"enterprise_scim": {
"title": "Enterprise SCIM",
- "displayTitle": "Business permissions for \"Enterprise SCIM\"",
+ "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
"permissions": [
{
"category": "enterprise-admin",
@@ -6827,4 +6827,4 @@
}
]
}
-}
+}
\ No newline at end of file
diff --git a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json
index d3270373cf39..8e1de330a93b 100644
--- a/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghes-3.16-2022-11-28/server-to-server-permissions.json
@@ -1,7 +1,7 @@
{
"enterprise_scim": {
"title": "Enterprise SCIM",
- "displayTitle": "Business permissions for \"Enterprise SCIM\"",
+ "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
"permissions": [
{
"category": "enterprise-admin",
diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json
index 14e134c38203..769ff8f6c13d 100644
--- a/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghes-3.17-2022-11-28/fine-grained-pat-permissions.json
@@ -1,7 +1,7 @@
{
"enterprise_scim": {
"title": "Enterprise SCIM",
- "displayTitle": "Business permissions for \"Enterprise SCIM\"",
+ "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
"permissions": [
{
"category": "enterprise-admin",
@@ -6899,4 +6899,4 @@
}
]
}
-}
+}
\ No newline at end of file
diff --git a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json
index 5bde08a9e536..e514e8e2f214 100644
--- a/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghes-3.17-2022-11-28/server-to-server-permissions.json
@@ -1,7 +1,7 @@
{
"enterprise_scim": {
"title": "Enterprise SCIM",
- "displayTitle": "Business permissions for \"Enterprise SCIM\"",
+ "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"",
"permissions": [
{
"category": "enterprise-admin",
diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json
index e6073ba1720f..254723f085c3 100644
--- a/src/github-apps/lib/config.json
+++ b/src/github-apps/lib/config.json
@@ -60,5 +60,5 @@
"2022-11-28"
]
},
- "sha": "3ae8ad33b4276583395c1b28852650f329018927"
+ "sha": "042ebdf85f1f5234751ac9603b977c9929e72c66"
}
\ No newline at end of file
diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json
index 5be0190f94e0..5a2da7e4f6eb 100644
--- a/src/rest/data/fpt-2022-11-28/schema.json
+++ b/src/rest/data/fpt-2022-11-28/schema.json
@@ -276,13 +276,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists all artifacts for a repository.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists all artifacts for a repository.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -576,13 +576,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -1035,13 +1035,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -1733,13 +1733,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Deletes a GitHub Actions cache for a repository, using a cache ID.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Deletes a GitHub Actions cache for a repository, using a cache ID.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
}
],
"hosted-runners": [
@@ -5771,13 +5771,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -6252,13 +6252,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -6506,13 +6506,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"<a href=\"https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to private repositories.\nFor more information, see \"<a href=\"https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository\">Allowing access to components in a private repository</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -7462,13 +7462,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -9003,13 +9003,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists all secrets available in a repository without revealing their encrypted\nvalues.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists all secrets available in a repository without revealing their encrypted\nvalues.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -9228,13 +9228,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a single repository secret without revealing its encrypted value.</p>\n<p>The authenticated user must have collaborator access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a single repository secret without revealing its encrypted value.</p>\n<p>The authenticated user must have collaborator access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -9580,13 +9580,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists all secrets available in an environment without revealing their\nencrypted values.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists all secrets available in an environment without revealing their\nencrypted values.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -9708,13 +9708,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -9825,13 +9825,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a single environment secret without revealing its encrypted value.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a single environment secret without revealing its encrypted value.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -10263,13 +10263,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -12449,13 +12449,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists the repositories with access to a self-hosted runner group configured in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists the repositories with access to a self-hosted runner group configured in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -16059,13 +16059,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a specific self-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a specific self-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -19628,13 +19628,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an repository. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ],
- "descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an repository. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization:</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -20951,13 +20951,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Creates an organization variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Response when creating a variable</p>"
}
- ],
- "descriptionHTML": "<p>Creates an organization variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -21084,13 +21084,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a specific variable in an organization.</p>\n<p>The authenticated user must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a specific variable in an organization.</p>\n<p>The authenticated user must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -21188,13 +21188,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Updates an organization variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Updates an organization variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -23051,13 +23051,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a specific variable in a repository.</p>\n<p>The authenticated user must have collaborator access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a specific variable in a repository.</p>\n<p>The authenticated user must have collaborator access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -23806,13 +23806,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Deletes an environment variable using the variable name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Deletes an environment variable using the variable name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
}
],
"workflow-jobs": [
@@ -24371,13 +24371,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor <code>Location:</code> in the response header to find the URL for the download.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "302",
"description": "<p>Found</p>"
}
- ],
- "descriptionHTML": "<p>Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor <code>Location:</code> in the response header to find the URL for the download.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -25546,6 +25546,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Re-run a job and its dependent jobs in a workflow run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -25555,8 +25556,7 @@
"httpStatusCode": "403",
"description": "<p>Forbidden</p>"
}
- ],
- "descriptionHTML": "<p>Re-run a job and its dependent jobs in a workflow run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -34778,13 +34778,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for <code>Location:</code> in the response header to find the URL for the download.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "302",
"description": "<p>Found</p>"
}
- ],
- "descriptionHTML": "<p>Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for <code>Location:</code> in the response header to find the URL for the download.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -35107,13 +35107,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n<code>Location:</code> in the response header to find the URL for the download.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "302",
"description": "<p>Found</p>"
}
- ],
- "descriptionHTML": "<p>Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n<code>Location:</code> in the response header to find the URL for the download.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -36678,13 +36678,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Approve or reject pending deployments that are waiting on approval by a required reviewer.</p>\n<p>Required reviewers with read access to the repository contents and deployments can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Approve or reject pending deployments that are waiting on approval by a required reviewer.</p>\n<p>Required reviewers with read access to the repository contents and deployments can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -40050,13 +40050,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>List all workflow runs for a workflow. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>. You can use parameters to narrow the list of results. For more information about using parameters, see <a href=\"https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>\n<p>This endpoint will return up to 1,000 results for each search when using the following parameters: <code>actor</code>, <code>branch</code>, <code>check_suite_id</code>, <code>created</code>, <code>event</code>, <code>head_sha</code>, <code>status</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>List all workflow runs for a workflow. You can replace <code>workflow_id</code> with the workflow file name. For example, you could use <code>main.yaml</code>. You can use parameters to narrow the list of results. For more information about using parameters, see <a href=\"https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>\n<p>This endpoint will return up to 1,000 results for each search when using the following parameters: <code>actor</code>, <code>branch</code>, <code>check_suite_id</code>, <code>created</code>, <code>event</code>, <code>head_sha</code>, <code>status</code>.</p>"
+ ]
}
],
"workflows": [
@@ -40465,13 +40465,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a specific workflow. You can replace <code>workflow_id</code> with the workflow\nfile name. For example, you could use <code>main.yaml</code>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a specific workflow. You can replace <code>workflow_id</code> with the workflow\nfile name. For example, you could use <code>main.yaml</code>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -52298,13 +52298,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -90433,13 +90433,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>The permissions the installation has are included under the <code>permissions</code> key.</p>\n<p>You must use a <a href=\"https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>The permissions the installation has are included under the <code>permissions</code> key.</p>"
}
- ],
- "descriptionHTML": "<p>The permissions the installation has are included under the <code>permissions</code> key.</p>\n<p>You must use a <a href=\"https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -108743,13 +108743,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets the summary of the free and paid GitHub Actions minutes used.</p>\n<p>Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"<a href=\"https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions\">Managing billing for GitHub Actions</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets the summary of the free and paid GitHub Actions minutes used.</p>\n<p>Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see \"<a href=\"https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions\">Managing billing for GitHub Actions</a>\".</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -108825,13 +108825,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets the free and paid storage used for GitHub Packages in gigabytes.</p>\n<p>Paid minutes only apply to packages stored for private repositories. For more information, see \"<a href=\"https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages\">Managing billing for GitHub Packages</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets the free and paid storage used for GitHub Packages in gigabytes.</p>\n<p>Paid minutes only apply to packages stored for private repositories. For more information, see \"<a href=\"https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages\">Managing billing for GitHub Packages</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -108907,13 +108907,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.</p>\n<p>Paid minutes only apply to packages stored for private repositories. For more information, see \"<a href=\"https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages\">Managing billing for GitHub Packages</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.</p>\n<p>Paid minutes only apply to packages stored for private repositories. For more information, see \"<a href=\"https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages\">Managing billing for GitHub Packages</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -156560,13 +156560,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -171216,6 +171216,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists all code security configurations available in an enterprise.</p>\n<p>The authenticated user must be an administrator of the enterprise in order to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -171229,8 +171230,7 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ],
- "descriptionHTML": "<p>Lists all code security configurations available in an enterprise.</p>\n<p>The authenticated user must be an administrator of the enterprise in order to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:enterprise</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -172233,13 +172233,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists the default code security configurations for an enterprise.</p>\n<p>The authenticated user must be an administrator of the enterprise in order to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists the default code security configurations for an enterprise.</p>\n<p>The authenticated user must be an administrator of the enterprise in order to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:enterprise</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -177300,13 +177300,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.</p>\n<p>If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.</p>\n<p>The authenticated user must be an administrator or security manager for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
"description": "<p>Accepted</p>"
}
- ],
- "descriptionHTML": "<p>Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.</p>\n<p>If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.</p>\n<p>The authenticated user must be an administrator or security manager for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -208335,13 +208335,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted\nvalues.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -208561,13 +208561,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets an organization development environment secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets an organization development environment secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -217085,13 +217085,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Deletes a development environment secret in a repository using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint. The associated user must be a repository admin.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Deletes a development environment secret in a repository using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint. The associated user must be a repository admin.</p>"
+ ]
}
],
"secrets": [
@@ -224374,13 +224374,13 @@
}
],
"previews": [],
+ "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": ""
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -251426,13 +251426,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -251749,13 +251749,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -252852,13 +252852,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code>\nfor repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret\">Create\nor update an organization secret</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code>\nfor repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret\">Create\nor update an organization secret</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -258329,13 +258329,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a deployment branch or tag policy for an environment.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a deployment branch or tag policy for an environment.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -258469,13 +258469,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Updates a deployment branch or tag policy for an environment.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Updates a deployment branch or tag policy for an environment.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -260073,13 +260073,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies#get-a-deployment-branch-policy\">Get a deployment branch policy</a>.\"</p>\n</div>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nTo get information about name patterns that branches must match in order to deploy to this environment, see \"<a href=\"/rest/deployments/branch-policies#get-a-deployment-branch-policy\">Get a deployment branch policy</a>.\"</p>\n</div>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -260969,13 +260969,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>Default response</p>"
}
- ],
- "descriptionHTML": "<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
}
],
"protection-rules": [
@@ -261711,13 +261711,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>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 \"<a href=\"https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see <a href=\"https://docs.github.com/rest/apps/apps#get-an-app\"><code>GET /apps/{app_slug}</code></a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>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 \"<a href=\"https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see <a href=\"https://docs.github.com/rest/apps/apps#get-an-app\"><code>GET /apps/{app_slug}</code></a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -303746,6 +303746,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Users with push access can unlock an issue's conversation.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -303759,8 +303760,7 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ],
- "descriptionHTML": "<p>Users with push access can unlock an issue's conversation.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -315182,6 +315182,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>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.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -315191,8 +315192,7 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ],
- "descriptionHTML": "<p>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.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -316112,13 +316112,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -372537,6 +372537,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw contents of the license.</li>\n<li><strong><code>application/vnd.github.html+json</code></strong>: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source <a href=\"https://github.com/github/markup\">Markup library</a>.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -372546,8 +372547,7 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ],
- "descriptionHTML": "<p>This method returns the contents of the repository's license file, if one is detected.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw contents of the license.</li>\n<li><strong><code>application/vnd.github.html+json</code></strong>: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source <a href=\"https://github.com/github/markup\">Markup library</a>.</li>\n</ul>"
+ ]
}
]
},
@@ -372948,13 +372948,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Get Hypermedia links to resources accessible in GitHub's REST API</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -378460,6 +378460,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Initiates the generation of a migration archive.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -378473,8 +378474,7 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ],
- "descriptionHTML": "<p>Initiates the generation of a migration archive.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -389753,13 +389753,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>This endpoint allows you to run an embedding request attributed to a specific organization. You must be a member of the organization and have enabled models to use this endpoint.\nThe token used to authenticate must have the <code>models: read</code> permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>This endpoint allows you to run an embedding request attributed to a specific organization. You must be a member of the organization and have enabled models to use this endpoint.\nThe token used to authenticate must have the <code>models: read</code> permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.</p>"
+ ]
},
{
"serverUrl": "https://models.github.ai",
@@ -389937,13 +389937,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>This endpoint allows you to run an embedding request. The token used to authenticate must have the <code>models: read</code> permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>This endpoint allows you to run an embedding request. The token used to authenticate must have the <code>models: read</code> permission if using a fine-grained PAT or GitHub App minted token.\nThe request body should contain the model ID and the input text(s) for the embedding request. The response will include the generated embeddings.</p>"
+ ]
}
]
},
@@ -393370,13 +393370,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -394061,13 +394061,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Get API request count statistics for an actor broken down by route within a specified time frame.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Get API request count statistics for an actor broken down by route within a specified time frame.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -394336,13 +394336,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -394440,13 +394440,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Get overall statistics of API requests within the organization for a user.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Get overall statistics of API requests within the organization for a user.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -394696,13 +394696,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Get the number of API requests and rate-limited requests made within an organization over a specified time period.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Get the number of API requests and rate-limited requests made within an organization over a specified time period.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -401143,6 +401143,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>The user can publicize their own membership. (A user cannot publicize the membership for another user.)</p>\n<p>Note that you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method\">HTTP method</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -401152,8 +401153,7 @@
"httpStatusCode": "403",
"description": "<p>Forbidden</p>"
}
- ],
- "descriptionHTML": "<p>The user can publicize their own membership. (A user cannot publicize the membership for another user.)</p>\n<p>Note that you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method\">HTTP method</a>.\"</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -402790,13 +402790,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists all hosted compute network configurations configured in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:network_configurations</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists all hosted compute network configurations configured in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:network_configurations</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -402944,13 +402944,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Creates a hosted compute network configuration for an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:network_configurations</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ],
- "descriptionHTML": "<p>Creates a hosted compute network configuration for an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:network_configurations</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -403237,13 +403237,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Updates a hosted compute network configuration for an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:network_configurations</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Updates a hosted compute network configuration for an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:network_configurations</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -403421,13 +403421,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a hosted compute network settings resource configured for an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:network_configurations</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a hosted compute network settings resource configured for an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:network_configurations</code> scope to use this endpoint.</p>"
+ ]
}
],
"organization-roles": [
@@ -404038,13 +404038,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Removes an organization role from a team. For more information on organization roles, see \"<a href=\"https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Removes an organization role from a team. For more information on organization roles, see \"<a href=\"https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles\">Using organization roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -424933,13 +424933,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a specific package version in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a specific package version in an organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:packages</code> scope to use this endpoint. For more information, see \"<a href=\"https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages\">About permissions for GitHub Packages</a>.\"</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -435774,13 +435774,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.</p>\n<p>Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ],
- "descriptionHTML": "<p>You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.</p>\n<p>Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -436432,13 +436432,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets information about a GitHub Pages build.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets information about a GitHub Pages build.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -437927,6 +437927,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Get the configuration of a single private registry defined for an organization, omitting its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -437936,8 +437937,7 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ],
- "descriptionHTML": "<p>Get the configuration of a single private registry defined for an organization, omitting its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -438562,6 +438562,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the <a href=\"https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/\">changelog</a> for more information.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -438571,8 +438572,7 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the <a href=\"https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/\">changelog</a> for more information.</p>\n</div>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -484927,13 +484927,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -501097,13 +501097,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists repositories for the specified organization.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nIn order to see the <code>security_and_analysis</code> 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 \"<a href=\"https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists repositories for the specified organization.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nIn order to see the <code>security_and_analysis</code> 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 \"<a href=\"https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization\">Managing security managers in your organization</a>.\"</p>\n</div>"
+ ]
},
{
"serverUrl": "https://api.github.com",
@@ -628564,13 +628564,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists the <em>verified</em> public SSH keys for a user. This is accessible by anyone.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists the <em>verified</em> public SSH keys for a user. This is accessible by anyone.</p>"
+ ]
}
],
"social-accounts": [
diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json
index 28534d3c88ff..29f55db22601 100644
--- a/src/rest/data/ghec-2022-11-28/schema.json
+++ b/src/rest/data/ghec-2022-11-28/schema.json
@@ -992,7 +992,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -6180,7 +6180,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -181919,6 +181919,1320 @@
}
]
}
+ ],
+ "alert-dismissal-requests": [
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "get",
+ "requestPath": "/orgs/{org}/dismissal-requests/code-scanning",
+ "title": "List dismissal requests for code scanning alerts for an organization",
+ "category": "code-scanning",
+ "subcategory": "alert-dismissal-requests",
+ "parameters": [
+ {
+ "name": "org",
+ "description": "<p>The organization name. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "reviewer",
+ "description": "<p>Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "requester",
+ "description": "<p>Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "time_period",
+ "description": "<p>The time period to filter by.</p>\n<p>For example, <code>day</code> will filter for rule suites that occurred in the past 24 hours, and <code>week</code> will filter for insights that occurred in the past 7 days (168 hours).</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "default": "month"
+ }
+ },
+ {
+ "name": "request_status",
+ "description": "<p>Filter alert dismissal requests by status. When specified, only requests with this status will be returned.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "approved",
+ "expired",
+ "denied",
+ "all"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "name": "repository_name",
+ "description": "<p>The name of the repository to filter on.</p>",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "<p>The number of results per page (max 100). For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "<p>The page number of the results to fetch. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "bodyParameters": [],
+ "progAccess": {
+ "userToServerRest": true,
+ "serverToServer": true,
+ "fineGrainedPat": true,
+ "permissions": [
+ {
+ "\"Organization dismissal requests for code scanning\" organization permissions": "read"
+ }
+ ]
+ },
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "parameters": {
+ "org": "ORG"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "<p>A list of alert dismissal requests.</p>",
+ "example": [
+ {
+ "id": 21,
+ "number": 42,
+ "repository": {
+ "id": 1,
+ "name": "smile",
+ "full_name": "octo-org/smile"
+ },
+ "organization": {
+ "id": 1,
+ "name": "octo-org"
+ },
+ "requester": {
+ "actor_id": 12,
+ "actor_name": "monalisa"
+ },
+ "request_type": "code_scanning_alert_dismissal",
+ "data": [
+ {
+ "reason": "won't fix",
+ "alert_number": 1
+ }
+ ],
+ "resource_identifier": "123/10",
+ "status": "denied",
+ "requester_comment": "Won't fix",
+ "expires_at": "2024-07-08T08:43:03Z",
+ "created_at": "2024-07-01T08:43:03Z",
+ "responses": [
+ {
+ "id": 42,
+ "reviewer": {
+ "actor_id": 4,
+ "actor_name": "octocat"
+ },
+ "status": "denied",
+ "created_at": "2024-07-02T08:43:04Z"
+ }
+ ],
+ "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/1",
+ "html_url": "https://github.com/octo-org/smile/code-scanning/alerts/1"
+ },
+ {
+ "id": 12,
+ "number": 24,
+ "repository": {
+ "id": 1,
+ "name": "smile",
+ "full_name": "octo-org/smile"
+ },
+ "organization": {
+ "id": 1,
+ "name": "octo-org"
+ },
+ "requester": {
+ "actor_id": 12,
+ "actor_name": "monalisa"
+ },
+ "request_type": "code_scanning_alert_dismissal",
+ "data": [
+ {
+ "reason": "won't fix",
+ "alert_number": 2
+ }
+ ],
+ "resource_identifier": "123/12",
+ "status": "denied",
+ "requester_comment": "Token is already revoked, I'll remove it later",
+ "expires_at": "2024-07-08T07:43:03Z",
+ "created_at": "2024-07-01T07:43:03Z",
+ "responses": [
+ {
+ "id": 42,
+ "reviewer": {
+ "actor_id": 4,
+ "actor_name": "octocat"
+ },
+ "status": "denied",
+ "created_at": "2024-07-02T08:43:04Z"
+ }
+ ],
+ "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/2",
+ "html_url": "https://github.com/octo-org/smile/code-scanning/alerts/2"
+ }
+ ],
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Code scanning alert dismissal request",
+ "description": "Alert dismisal request made by a user asking to dismiss a code scanning alert.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The unique identifier of the dismissal request."
+ },
+ "number": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number uniquely identifying the dismissal request within its repository."
+ },
+ "repository": {
+ "type": "object",
+ "description": "The repository the dismissal request is for.",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the repository the dismissal request is for."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the repository the dismissal request is for."
+ },
+ "full_name": {
+ "type": "string",
+ "description": "The full name of the repository the dismissal request is for."
+ }
+ }
+ },
+ "organization": {
+ "type": "object",
+ "description": "The organization associated with the repository the dismissal request is for.",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the organization."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the organization."
+ }
+ }
+ },
+ "requester": {
+ "type": "object",
+ "description": "The user who requested the dismissal request.",
+ "properties": {
+ "actor_id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the GitHub user who requested the dismissal request."
+ },
+ "actor_name": {
+ "type": "string",
+ "description": "The name of the GitHub user who requested the dismissal request."
+ }
+ }
+ },
+ "request_type": {
+ "type": "string",
+ "description": "The type of request."
+ },
+ "data": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "Data describing the dismissal request metadata.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "The reason for the dismissal request."
+ },
+ "alert_number": {
+ "type": "string",
+ "description": "alert number."
+ },
+ "pr_review_thread_id": {
+ "type": "string",
+ "description": "The ID of the pull request review thread."
+ }
+ }
+ }
+ },
+ "resource_identifier": {
+ "type": "string",
+ "description": "The unique identifier for the request type of the dismissal request.",
+ "examples": [
+ "827efc6d56897b048c772eb4087f854f46256132"
+ ]
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the dismissal request.",
+ "enum": [
+ "pending",
+ "denied",
+ "approved",
+ "expired"
+ ]
+ },
+ "requester_comment": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The comment the requester provided when creating the dismissal request."
+ },
+ "expires_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the dismissal request will expire."
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the dismissal request was created."
+ },
+ "responses": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "The responses to the dismissal request.",
+ "items": {
+ "title": "Dismissal request response",
+ "description": "A response made by a requester to dismiss the request.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the response to the dismissal request."
+ },
+ "reviewer": {
+ "type": "object",
+ "description": "The user who reviewed the dismissal request.",
+ "properties": {
+ "actor_id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the GitHub user who reviewed the dismissal request."
+ },
+ "actor_name": {
+ "type": "string",
+ "description": "The name of the GitHub user who reviewed the dismissal request."
+ }
+ }
+ },
+ "message": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The response comment of the reviewer."
+ },
+ "status": {
+ "type": "string",
+ "description": "The response status to the dismissal request until dismissed.",
+ "enum": [
+ "approved",
+ "denied",
+ "dismissed"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the response to the dismissal request was created."
+ }
+ }
+ }
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/1"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "description": "The URL to view the dismissal request in a browser.",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octo-org/smile/code-scanning/alerts/1"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ ],
+ "previews": [],
+ "descriptionHTML": "<p>Lists dismissal requests for code scanning alerts for all repositories in an organization.</p>\n<p>The user must be authorized to review dismissal requests for the organization.\nPersonal access tokens (classic) need the <code>security_events</code> scope to use this endpoint.</p>",
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "<p>A list of alert dismissal requests.</p>"
+ },
+ {
+ "httpStatusCode": "403",
+ "description": "<p>Forbidden</p>"
+ },
+ {
+ "httpStatusCode": "404",
+ "description": "<p>Resource not found</p>"
+ },
+ {
+ "httpStatusCode": "422",
+ "description": "<p>Validation failed, or the endpoint has been spammed.</p>"
+ },
+ {
+ "httpStatusCode": "500",
+ "description": "<p>Internal Error</p>"
+ }
+ ]
+ },
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning",
+ "title": "List dismissal requests for code scanning alerts for a repository",
+ "category": "code-scanning",
+ "subcategory": "alert-dismissal-requests",
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "<p>The account owner of the repository. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "<p>The name of the repository without the <code>.git</code> extension. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "reviewer",
+ "description": "<p>Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "requester",
+ "description": "<p>Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "time_period",
+ "description": "<p>The time period to filter by.</p>\n<p>For example, <code>day</code> will filter for rule suites that occurred in the past 24 hours, and <code>week</code> will filter for insights that occurred in the past 7 days (168 hours).</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "hour",
+ "day",
+ "week",
+ "month"
+ ],
+ "default": "month"
+ }
+ },
+ {
+ "name": "request_status",
+ "description": "<p>Filter alert dismissal requests by status. When specified, only requests with this status will be returned.</p>",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "open",
+ "approved",
+ "expired",
+ "denied",
+ "all"
+ ],
+ "default": "all"
+ }
+ },
+ {
+ "name": "per_page",
+ "description": "<p>The number of results per page (max 100). For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 30
+ }
+ },
+ {
+ "name": "page",
+ "description": "<p>The page number of the results to fetch. For more information, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api\">Using pagination in the REST API</a>.\"</p>",
+ "in": "query",
+ "schema": {
+ "type": "integer",
+ "default": 1
+ }
+ }
+ ],
+ "bodyParameters": [],
+ "progAccess": {
+ "userToServerRest": true,
+ "serverToServer": true,
+ "fineGrainedPat": true,
+ "permissions": [
+ {
+ "\"Organization dismissal requests for code scanning\" organization permissions": "read",
+ "\"Code scanning alerts\" repository permissions": "read"
+ }
+ ]
+ },
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "parameters": {
+ "owner": "OWNER",
+ "repo": "REPO"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "<p>A list of alert dismissal requests.</p>",
+ "example": [
+ {
+ "id": 21,
+ "number": 42,
+ "repository": {
+ "id": 1,
+ "name": "smile",
+ "full_name": "octo-org/smile"
+ },
+ "organization": {
+ "id": 1,
+ "name": "octo-org"
+ },
+ "requester": {
+ "actor_id": 12,
+ "actor_name": "monalisa"
+ },
+ "request_type": "code_scanning_alert_dismissal",
+ "data": [
+ {
+ "reason": "won't fix",
+ "alert_number": 1
+ }
+ ],
+ "resource_identifier": "123/10",
+ "status": "denied",
+ "requester_comment": "Won't fix",
+ "expires_at": "2024-07-08T08:43:03Z",
+ "created_at": "2024-07-01T08:43:03Z",
+ "responses": [
+ {
+ "id": 42,
+ "reviewer": {
+ "actor_id": 4,
+ "actor_name": "octocat"
+ },
+ "status": "denied",
+ "created_at": "2024-07-02T08:43:04Z"
+ }
+ ],
+ "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/1",
+ "html_url": "https://github.com/octo-org/smile/code-scanning/alerts/1"
+ },
+ {
+ "id": 12,
+ "number": 24,
+ "repository": {
+ "id": 1,
+ "name": "smile",
+ "full_name": "octo-org/smile"
+ },
+ "organization": {
+ "id": 1,
+ "name": "octo-org"
+ },
+ "requester": {
+ "actor_id": 12,
+ "actor_name": "monalisa"
+ },
+ "request_type": "code_scanning_alert_dismissal",
+ "data": [
+ {
+ "reason": "won't fix",
+ "alert_number": 2
+ }
+ ],
+ "resource_identifier": "123/12",
+ "status": "denied",
+ "requester_comment": "Token is already revoked, I'll remove it later",
+ "expires_at": "2024-07-08T07:43:03Z",
+ "created_at": "2024-07-01T07:43:03Z",
+ "responses": [
+ {
+ "id": 42,
+ "reviewer": {
+ "actor_id": 4,
+ "actor_name": "octocat"
+ },
+ "status": "denied",
+ "created_at": "2024-07-02T08:43:04Z"
+ }
+ ],
+ "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/2",
+ "html_url": "https://github.com/octo-org/smile/code-scanning/alerts/2"
+ }
+ ],
+ "schema": {
+ "type": "array",
+ "items": {
+ "title": "Code scanning alert dismissal request",
+ "description": "Alert dismisal request made by a user asking to dismiss a code scanning alert.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The unique identifier of the dismissal request."
+ },
+ "number": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number uniquely identifying the dismissal request within its repository."
+ },
+ "repository": {
+ "type": "object",
+ "description": "The repository the dismissal request is for.",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the repository the dismissal request is for."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the repository the dismissal request is for."
+ },
+ "full_name": {
+ "type": "string",
+ "description": "The full name of the repository the dismissal request is for."
+ }
+ }
+ },
+ "organization": {
+ "type": "object",
+ "description": "The organization associated with the repository the dismissal request is for.",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the organization."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the organization."
+ }
+ }
+ },
+ "requester": {
+ "type": "object",
+ "description": "The user who requested the dismissal request.",
+ "properties": {
+ "actor_id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the GitHub user who requested the dismissal request."
+ },
+ "actor_name": {
+ "type": "string",
+ "description": "The name of the GitHub user who requested the dismissal request."
+ }
+ }
+ },
+ "request_type": {
+ "type": "string",
+ "description": "The type of request."
+ },
+ "data": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "Data describing the dismissal request metadata.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "The reason for the dismissal request."
+ },
+ "alert_number": {
+ "type": "string",
+ "description": "alert number."
+ },
+ "pr_review_thread_id": {
+ "type": "string",
+ "description": "The ID of the pull request review thread."
+ }
+ }
+ }
+ },
+ "resource_identifier": {
+ "type": "string",
+ "description": "The unique identifier for the request type of the dismissal request.",
+ "examples": [
+ "827efc6d56897b048c772eb4087f854f46256132"
+ ]
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the dismissal request.",
+ "enum": [
+ "pending",
+ "denied",
+ "approved",
+ "expired"
+ ]
+ },
+ "requester_comment": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The comment the requester provided when creating the dismissal request."
+ },
+ "expires_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the dismissal request will expire."
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the dismissal request was created."
+ },
+ "responses": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "The responses to the dismissal request.",
+ "items": {
+ "title": "Dismissal request response",
+ "description": "A response made by a requester to dismiss the request.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the response to the dismissal request."
+ },
+ "reviewer": {
+ "type": "object",
+ "description": "The user who reviewed the dismissal request.",
+ "properties": {
+ "actor_id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the GitHub user who reviewed the dismissal request."
+ },
+ "actor_name": {
+ "type": "string",
+ "description": "The name of the GitHub user who reviewed the dismissal request."
+ }
+ }
+ },
+ "message": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The response comment of the reviewer."
+ },
+ "status": {
+ "type": "string",
+ "description": "The response status to the dismissal request until dismissed.",
+ "enum": [
+ "approved",
+ "denied",
+ "dismissed"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the response to the dismissal request was created."
+ }
+ }
+ }
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/1"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "description": "The URL to view the dismissal request in a browser.",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octo-org/smile/code-scanning/alerts/1"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ ],
+ "previews": [],
+ "descriptionHTML": "<p>Lists dismissal requests for code scanning alerts for a repository.</p>\n<p>Delegated alert dismissal must be enabled on the repository.\nPersonal access tokens (classic) need the <code>security_events</code> scope to use this endpoint.</p>",
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "<p>A list of alert dismissal requests.</p>"
+ },
+ {
+ "httpStatusCode": "403",
+ "description": "<p>Forbidden</p>"
+ },
+ {
+ "httpStatusCode": "404",
+ "description": "<p>Resource not found</p>"
+ },
+ {
+ "httpStatusCode": "500",
+ "description": "<p>Internal Error</p>"
+ }
+ ]
+ },
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
+ "title": "Get a dismissal request for a code scanning alert for a repository",
+ "category": "code-scanning",
+ "subcategory": "alert-dismissal-requests",
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "<p>The account owner of the repository. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "<p>The name of the repository without the <code>.git</code> extension. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "alert_number",
+ "in": "path",
+ "required": true,
+ "description": "<p>The number that identifies the code scanning alert.</p>",
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "bodyParameters": [],
+ "progAccess": {
+ "userToServerRest": true,
+ "serverToServer": true,
+ "fineGrainedPat": true,
+ "permissions": [
+ {
+ "\"Organization dismissal requests for code scanning\" organization permissions": "read",
+ "\"Code scanning alerts\" repository permissions": "read"
+ }
+ ]
+ },
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "parameters": {
+ "owner": "OWNER",
+ "repo": "REPO",
+ "alert_number": "ALERT_NUMBER"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "<p>A single dismissal request.</p>",
+ "example": {
+ "id": 21,
+ "number": 42,
+ "repository": {
+ "id": 1,
+ "name": "smile",
+ "full_name": "octo-org/smile"
+ },
+ "organization": {
+ "id": 1,
+ "name": "octo-org"
+ },
+ "requester": {
+ "actor_id": 12,
+ "actor_name": "monalisa"
+ },
+ "request_type": "code_scanning_alert_dismissal",
+ "data": [
+ {
+ "reason": "won't fix",
+ "alert_number": 2
+ }
+ ],
+ "resource_identifier": "1/1",
+ "status": "denied",
+ "requester_comment": "Won't fix",
+ "expires_at": "2024-07-08T08:43:03Z",
+ "created_at": "2024-07-01T08:43:03Z",
+ "responses": [
+ {
+ "id": 42,
+ "reviewer": {
+ "actor_id": 4,
+ "actor_name": "octocat"
+ },
+ "status": "denied",
+ "created_at": "2024-07-02T08:43:04Z"
+ }
+ ],
+ "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/1",
+ "html_url": "https://github.com/octo-org/smile/code-scanning/alerts/1"
+ },
+ "schema": {
+ "title": "Code scanning alert dismissal request",
+ "description": "Alert dismisal request made by a user asking to dismiss a code scanning alert.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The unique identifier of the dismissal request."
+ },
+ "number": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The number uniquely identifying the dismissal request within its repository."
+ },
+ "repository": {
+ "type": "object",
+ "description": "The repository the dismissal request is for.",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the repository the dismissal request is for."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the repository the dismissal request is for."
+ },
+ "full_name": {
+ "type": "string",
+ "description": "The full name of the repository the dismissal request is for."
+ }
+ }
+ },
+ "organization": {
+ "type": "object",
+ "description": "The organization associated with the repository the dismissal request is for.",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the organization."
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the organization."
+ }
+ }
+ },
+ "requester": {
+ "type": "object",
+ "description": "The user who requested the dismissal request.",
+ "properties": {
+ "actor_id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the GitHub user who requested the dismissal request."
+ },
+ "actor_name": {
+ "type": "string",
+ "description": "The name of the GitHub user who requested the dismissal request."
+ }
+ }
+ },
+ "request_type": {
+ "type": "string",
+ "description": "The type of request."
+ },
+ "data": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "Data describing the dismissal request metadata.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "reason": {
+ "type": "string",
+ "description": "The reason for the dismissal request."
+ },
+ "alert_number": {
+ "type": "string",
+ "description": "alert number."
+ },
+ "pr_review_thread_id": {
+ "type": "string",
+ "description": "The ID of the pull request review thread."
+ }
+ }
+ }
+ },
+ "resource_identifier": {
+ "type": "string",
+ "description": "The unique identifier for the request type of the dismissal request.",
+ "examples": [
+ "827efc6d56897b048c772eb4087f854f46256132"
+ ]
+ },
+ "status": {
+ "type": "string",
+ "description": "The status of the dismissal request.",
+ "enum": [
+ "pending",
+ "denied",
+ "approved",
+ "expired"
+ ]
+ },
+ "requester_comment": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The comment the requester provided when creating the dismissal request."
+ },
+ "expires_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the dismissal request will expire."
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the dismissal request was created."
+ },
+ "responses": {
+ "type": [
+ "array",
+ "null"
+ ],
+ "description": "The responses to the dismissal request.",
+ "items": {
+ "title": "Dismissal request response",
+ "description": "A response made by a requester to dismiss the request.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the response to the dismissal request."
+ },
+ "reviewer": {
+ "type": "object",
+ "description": "The user who reviewed the dismissal request.",
+ "properties": {
+ "actor_id": {
+ "type": "integer",
+ "format": "int64",
+ "description": "The ID of the GitHub user who reviewed the dismissal request."
+ },
+ "actor_name": {
+ "type": "string",
+ "description": "The name of the GitHub user who reviewed the dismissal request."
+ }
+ }
+ },
+ "message": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "The response comment of the reviewer."
+ },
+ "status": {
+ "type": "string",
+ "description": "The response status to the dismissal request until dismissed.",
+ "enum": [
+ "approved",
+ "denied",
+ "dismissed"
+ ]
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "description": "The date and time the response to the dismissal request was created."
+ }
+ }
+ }
+ },
+ "url": {
+ "type": "string",
+ "format": "uri",
+ "examples": [
+ "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/1"
+ ]
+ },
+ "html_url": {
+ "type": "string",
+ "description": "The URL to view the dismissal request in a browser.",
+ "format": "uri",
+ "examples": [
+ "https://github.com/octo-org/smile/code-scanning/alerts/1"
+ ]
+ }
+ }
+ }
+ }
+ }
+ ],
+ "previews": [],
+ "descriptionHTML": "<p>Gets a dismissal request to dismiss a code scanning alert in a repository.</p>\n<p>Delegated alert dismissal must be enabled on the repository.\nPersonal access tokens (classic) need the <code>security_events</code> scope to use this endpoint.</p>",
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "<p>A single dismissal request.</p>"
+ },
+ {
+ "httpStatusCode": "403",
+ "description": "<p>Forbidden</p>"
+ },
+ {
+ "httpStatusCode": "404",
+ "description": "<p>Resource not found</p>"
+ },
+ {
+ "httpStatusCode": "500",
+ "description": "<p>Internal Error</p>"
+ }
+ ]
+ },
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "patch",
+ "requestPath": "/repos/{owner}/{repo}/dismissal-requests/code-scanning/{alert_number}",
+ "title": "Review a dismissal request for a code scanning alert for a repository",
+ "category": "code-scanning",
+ "subcategory": "alert-dismissal-requests",
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "<p>The account owner of the repository. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo",
+ "description": "<p>The name of the repository without the <code>.git</code> extension. The name is not case sensitive.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "alert_number",
+ "in": "path",
+ "required": true,
+ "description": "<p>The number that identifies the code scanning alert.</p>",
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "name": "status",
+ "in": "body",
+ "description": "<p>The review action to perform on the bypass request.</p>",
+ "isRequired": true,
+ "enum": [
+ "approve",
+ "deny"
+ ]
+ },
+ {
+ "type": "string",
+ "name": "message",
+ "in": "body",
+ "description": "<p>A message to include with the review. Has a maximum character length of 2048.</p>",
+ "isRequired": true
+ }
+ ],
+ "progAccess": {
+ "userToServerRest": true,
+ "serverToServer": true,
+ "fineGrainedPat": true,
+ "permissions": [
+ {
+ "\"Organization dismissal requests for code scanning\" organization permissions": "write",
+ "\"Code scanning alerts\" repository permissions": "read"
+ }
+ ]
+ },
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "contentType": "application/json",
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "status": "approve",
+ "message": "Used in tests."
+ },
+ "parameters": {
+ "owner": "OWNER",
+ "repo": "REPO",
+ "alert_number": "ALERT_NUMBER"
+ }
+ },
+ "response": {
+ "statusCode": "204",
+ "description": "<p>Successful update</p>"
+ }
+ }
+ ],
+ "previews": [],
+ "descriptionHTML": "<p>Approve or deny a dismissal request to dismiss a code scanning alert in a repository.</p>\n<p>Delegated alert dismissal must be enabled on the repository and the user must be a dismissal reviewer to access this endpoint.\nPersonal access tokens (classic) need the <code>security_events</code> scope to use this endpoint.</p>",
+ "statusCodes": [
+ {
+ "httpStatusCode": "204",
+ "description": "<p>Successful update</p>"
+ },
+ {
+ "httpStatusCode": "403",
+ "description": "<p>Forbidden</p>"
+ },
+ {
+ "httpStatusCode": "404",
+ "description": "<p>Resource not found</p>"
+ },
+ {
+ "httpStatusCode": "422",
+ "description": "<p>Validation failed, or the endpoint has been spammed.</p>"
+ },
+ {
+ "httpStatusCode": "500",
+ "description": "<p>Internal Error</p>"
+ }
+ ]
+ }
]
},
"code-security": {
@@ -280528,7 +281842,7 @@
"\"Administration\" organization permissions": "read"
},
{
- "\"Enterprise administration\" business permissions": "read"
+ "\"Enterprise administration\" enterprise permissions": "read"
}
]
},
@@ -281042,7 +282356,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "read"
+ "\"Enterprise administration\" enterprise permissions": "read"
}
]
},
@@ -282590,7 +283904,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -282774,7 +284088,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -283297,7 +284611,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -283379,7 +284693,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -284440,7 +285754,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Custom properties\" business permissions": "read"
+ "\"Custom properties\" enterprise permissions": "read"
}
]
},
@@ -284708,7 +286022,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Custom properties\" business permissions": "write"
+ "\"Custom properties\" enterprise permissions": "write"
}
]
},
@@ -284948,7 +286262,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Custom properties\" business permissions": "write"
+ "\"Custom properties\" enterprise permissions": "write"
}
]
},
@@ -285136,7 +286450,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Custom properties\" business permissions": "read"
+ "\"Custom properties\" enterprise permissions": "read"
}
]
},
@@ -285372,7 +286686,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Custom properties\" business permissions": "write"
+ "\"Custom properties\" enterprise permissions": "write"
}
]
},
@@ -285570,7 +286884,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Custom properties\" business permissions": "write"
+ "\"Custom properties\" enterprise permissions": "write"
}
]
},
@@ -285653,7 +286967,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "read"
+ "\"Enterprise administration\" enterprise permissions": "read"
}
]
},
@@ -285888,7 +287202,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "read"
+ "\"Enterprise administration\" enterprise permissions": "read"
}
]
},
@@ -288097,7 +289411,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -289480,7 +290794,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -292151,7 +293465,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -293535,7 +294849,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -293967,7 +295281,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -294327,7 +295641,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -294620,7 +295934,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -294937,7 +296251,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -295477,7 +296791,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -295990,7 +297304,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -296114,7 +297428,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -296655,7 +297969,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -297372,7 +298686,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -297873,7 +299187,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -298311,7 +299625,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -299319,7 +300633,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json
index cbbfc3d6f5b1..6156ead9bfc2 100644
--- a/src/rest/data/ghes-3.13-2022-11-28/schema.json
+++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json
@@ -957,7 +957,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -1033,7 +1033,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -1126,7 +1126,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -156852,12 +156852,6 @@
"name": "dismissed_comment",
"in": "body",
"description": "<p>The dismissal comment associated with the dismissal of the alert.</p>"
- },
- {
- "type": "boolean",
- "name": "create_request",
- "in": "body",
- "description": "<p>If <code>true</code>, attempt to create an alert dismissal request.</p>"
}
],
"progAccess": {
@@ -156880,8 +156874,7 @@
"bodyParameters": {
"state": "dismissed",
"dismissed_reason": "false positive",
- "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
- "create_request": true
+ "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library."
},
"parameters": {
"owner": "OWNER",
@@ -201754,7 +201747,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "read"
+ "\"Enterprise administration\" enterprise permissions": "read"
}
]
},
@@ -202132,7 +202125,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -210899,7 +210892,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -211259,7 +211252,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -211552,7 +211545,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -211869,7 +211862,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -212409,7 +212402,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -212922,7 +212915,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -213046,7 +213039,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -213587,7 +213580,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -214304,7 +214297,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -214805,7 +214798,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -215243,7 +215236,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -216251,7 +216244,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json
index 2884df768d10..df759579e103 100644
--- a/src/rest/data/ghes-3.14-2022-11-28/schema.json
+++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json
@@ -553,13 +553,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -957,7 +957,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -1033,7 +1033,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -1126,7 +1126,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -2168,13 +2168,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the customization template for an OpenID Connect (OIDC) subject claim.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>A JSON serialized template for OIDC subject claim customization</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets the customization template for an OpenID Connect (OIDC) subject claim.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2961,13 +2961,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -3178,13 +3178,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -4737,13 +4737,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5904,7 +5904,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Sets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository\">Setting the permissions of the GITHUB_TOKEN for your repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -5914,7 +5913,8 @@
"httpStatusCode": "409",
"description": "<p>Conflict response when changing a setting is prevented by the owning organization or enterprise</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Sets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository\">Setting the permissions of the GITHUB_TOKEN for your repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}
],
"secrets": [
@@ -6499,13 +6499,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -7561,13 +7561,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code>\nfor repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-organization-secret\">Create\nor update an organization secret</a>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code>\nfor repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-organization-secret\">Create\nor update an organization secret</a>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -8224,13 +8224,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets a single repository secret without revealing its encrypted value.</p>\n<p>The authenticated user must have collaborator access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets a single repository secret without revealing its encrypted value.</p>\n<p>The authenticated user must have collaborator access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -9044,13 +9044,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a secret in an environment using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>Default response</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Deletes a secret in an environment using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}
],
"self-hosted-runner-groups": [
@@ -10070,13 +10070,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10140,13 +10140,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -11462,13 +11462,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a self-hosted runner group for an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Deletes a self-hosted runner group for an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -12847,13 +12847,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-organization\">Create a self-hosted runner group for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-organization\">Create a self-hosted runner group for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -13169,13 +13169,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an organization runner group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an organization runner group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -13243,13 +13243,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -16034,13 +16034,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>Example using remove token:</p>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>Example using remove token:</p>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -19899,13 +19899,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets a specific self-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets a specific self-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -26737,13 +26737,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Creates a repository variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Creates a repository variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -27026,13 +27026,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a repository variable using the variable name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Deletes a repository variable using the variable name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -29260,13 +29260,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see <a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see <a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
}
],
"workflow-runs": [
@@ -34955,13 +34955,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets a specific workflow run.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets a specific workflow run.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -35402,13 +35402,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -38250,13 +38250,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for <code>Location:</code> in the response header to find the URL for the download.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "302",
"description": "<p>Found</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for <code>Location:</code> in the response header to find the URL for the download.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -38333,7 +38333,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Cancels a workflow run using its <code>id</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -38343,7 +38342,8 @@
"httpStatusCode": "409",
"description": "<p>Conflict</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Cancels a workflow run using its <code>id</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -40330,13 +40330,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Re-run all of the failed jobs and their dependent jobs in a workflow run using the <code>id</code> of the workflow run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Re-run all of the failed jobs and their dependent jobs in a workflow run using the <code>id</code> of the workflow run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -55267,13 +55267,13 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -62859,13 +62859,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. <em>Optional</em>: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. <em>Optional</em>: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -78406,13 +78406,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>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.</p>\n<ul>\n<li><strong>Timeline</strong>: The GitHub Enterprise Server global public timeline</li>\n<li><strong>User</strong>: The public timeline for any user, using <code>uri_template</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia\">Hypermedia</a>.\"</li>\n<li><strong>Current user public</strong>: The public timeline for the authenticated user</li>\n<li><strong>Current user</strong>: The private timeline for the authenticated user</li>\n<li><strong>Current user actor</strong>: The private timeline for activity created by the authenticated user</li>\n<li><strong>Current user organizations</strong>: The private timeline for the organizations the authenticated user is a member of.</li>\n<li><strong>Security advisories</strong>: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.</li>\n</ul>\n<p>By default, timeline resources are returned in JSON. You can specify the <code>application/atom+xml</code> type in the <code>Accept</code> header to return timeline resources in Atom format. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPrivate feeds are only returned when <a href=\"https://docs.github.com/enterprise-server@3.14/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication\">authenticating via Basic Auth</a> since current feed URIs use the older, non revocable auth tokens.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>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.</p>\n<ul>\n<li><strong>Timeline</strong>: The GitHub Enterprise Server global public timeline</li>\n<li><strong>User</strong>: The public timeline for any user, using <code>uri_template</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia\">Hypermedia</a>.\"</li>\n<li><strong>Current user public</strong>: The public timeline for the authenticated user</li>\n<li><strong>Current user</strong>: The private timeline for the authenticated user</li>\n<li><strong>Current user actor</strong>: The private timeline for activity created by the authenticated user</li>\n<li><strong>Current user organizations</strong>: The private timeline for the organizations the authenticated user is a member of.</li>\n<li><strong>Security advisories</strong>: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.</li>\n</ul>\n<p>By default, timeline resources are returned in JSON. You can specify the <code>application/atom+xml</code> type in the <code>Accept</code> header to return timeline resources in Atom format. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPrivate feeds are only returned when <a href=\"https://docs.github.com/enterprise-server@3.14/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication\">authenticating via Basic Auth</a> since current feed URIs use the older, non revocable auth tokens.</p>\n</div>"
}
],
"notifications": [
@@ -99824,13 +99824,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -101996,13 +101996,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Enables an authenticated GitHub App to find the user’s installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Enables an authenticated GitHub App to find the user’s installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
}
],
"installations": [
@@ -123586,13 +123586,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -136754,13 +136754,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Creates a new check run for a specific commit in a repository.</p>\n<p>To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.</p>\n<p>In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe 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 <code>pull_requests</code> array.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Creates a new check run for a specific commit in a repository.</p>\n<p>To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.</p>\n<p>In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe 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 <code>pull_requests</code> array.</p>\n</div>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -139729,13 +139729,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates a check run for a specific commit in a repository.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array.</p>\n</div>\n<p>OAuth apps and personal access tokens (classic) cannot use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Updates a check run for a specific commit in a repository.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array.</p>\n</div>\n<p>OAuth apps and personal access tokens (classic) cannot use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -147933,13 +147933,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>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 <a href=\"https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite\">Create a check suite</a>.\nYou must have admin permissions in the repository to set preferences for check suites.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>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 <a href=\"https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite\">Create a check suite</a>.\nYou must have admin permissions in the repository to set preferences for check suites.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -149869,13 +149869,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets a single check suite using its <code>id</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe 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 <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets a single check suite using its <code>id</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe 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 <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -151824,13 +151824,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists check suites for a commit <code>ref</code>. The <code>ref</code> can be a SHA, branch name, or a tag name.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists check suites for a commit <code>ref</code>. The <code>ref</code> can be a SHA, branch name, or a tag name.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>"
}
]
},
@@ -156852,12 +156852,6 @@
"name": "dismissed_comment",
"in": "body",
"description": "<p>The dismissal comment associated with the dismissal of the alert.</p>"
- },
- {
- "type": "boolean",
- "name": "create_request",
- "in": "body",
- "description": "<p>If <code>true</code>, attempt to create an alert dismissal request.</p>"
}
],
"progAccess": {
@@ -156880,8 +156874,7 @@
"bodyParameters": {
"state": "dismissed",
"dismissed_reason": "false positive",
- "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
- "create_request": true
+ "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library."
},
"parameters": {
"owner": "OWNER",
@@ -159934,7 +159927,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method\">HTTP method</a>.\"</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>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 <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -159948,7 +159940,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method\">HTTP method</a>.\"</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>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 <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -160016,7 +160009,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Removes a collaborator from a repository.</p>\n<p>To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.</p>\n<p>This endpoint also:</p>\n<ul>\n<li>Cancels any outstanding invitations sent by the collaborator</li>\n<li>Unassigns the user from any issues</li>\n<li>Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.</li>\n<li>Unstars the repository</li>\n<li>Updates access permissions to packages</li>\n</ul>\n<p>Removing a user as a collaborator has the following effects on forks:</p>\n<ul>\n<li>If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.</li>\n<li>If the user had their own fork of the repository, the fork will be deleted.</li>\n<li>If the user still has read access to the repository, open pull requests by this user from a fork will be denied.</li>\n</ul>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nA user can still have access to the repository through organization permissions like base repository permissions.</p>\n</div>\n<p>Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.</p>\n<p>For more information on fork permissions, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks\">About permissions and visibility of forks</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -160030,7 +160022,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Removes a collaborator from a repository.</p>\n<p>To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.</p>\n<p>This endpoint also:</p>\n<ul>\n<li>Cancels any outstanding invitations sent by the collaborator</li>\n<li>Unassigns the user from any issues</li>\n<li>Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.</li>\n<li>Unstars the repository</li>\n<li>Updates access permissions to packages</li>\n</ul>\n<p>Removing a user as a collaborator has the following effects on forks:</p>\n<ul>\n<li>If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.</li>\n<li>If the user had their own fork of the repository, the fork will be deleted.</li>\n<li>If the user still has read access to the repository, open pull requests by this user from a fork will be denied.</li>\n</ul>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nA user can still have access to the repository through organization permissions like base repository permissions.</p>\n</div>\n<p>Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.</p>\n<p>For more information on fork permissions, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks\">About permissions and visibility of forks</a>\".</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -185488,13 +185481,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -185572,13 +185565,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -185688,13 +185681,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets a single organization secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets a single organization secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -186957,13 +186950,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code>\nfor repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret\">Create\nor update an organization secret</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code>\nfor repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret\">Create\nor update an organization secret</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -187456,13 +187449,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets a single repository secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets a single repository secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -188236,13 +188229,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a new snapshot of a repository's dependencies.</p>\n<p>The authenticated user must have access to the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Create a new snapshot of a repository's dependencies.</p>\n<p>The authenticated user must have access to the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}
],
"sboms": [
@@ -192608,13 +192601,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a deployment branch or tag policy for an environment.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Deletes a deployment branch or tag policy for an environment.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}
],
"environments": [
@@ -195249,13 +195242,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>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 \"<a href=\"https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>List of deployment protection rules</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>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 \"<a href=\"https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -200656,13 +200649,13 @@
}
],
"previews": [],
- "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -200850,13 +200843,13 @@
}
],
"previews": [],
- "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -200976,13 +200969,13 @@
}
],
"previews": [],
- "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -201044,13 +201037,13 @@
}
],
"previews": [],
- "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -201349,13 +201342,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the statistics about security products for a GitHub Enterprise Server instance.</p>\n<p>To use this endpoint, you must be a site admin.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets the statistics about security products for a GitHub Enterprise Server instance.</p>\n<p>To use this endpoint, you must be a site admin.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -201754,7 +201747,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "read"
+ "\"Enterprise administration\" enterprise permissions": "read"
}
]
},
@@ -202132,7 +202125,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -208160,13 +208153,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -210899,7 +210892,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -211259,7 +211252,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -211552,7 +211545,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -211869,7 +211862,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -212409,7 +212402,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -212922,7 +212915,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -213046,7 +213039,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -213587,7 +213580,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -214304,7 +214297,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -214805,7 +214798,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -215243,7 +215236,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -216251,7 +216244,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -220016,13 +220009,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Note that you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method\">HTTP method</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Note that you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method\">HTTP method</a>.\"</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -231255,7 +231248,6 @@
}
],
"previews": [],
- "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -231273,7 +231265,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ]
+ ],
+ "descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -315994,13 +315987,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).</p>\n<p>A list of <code>repositories</code> is only returned for export migrations.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).</p>\n<p>A list of <code>repositories</code> is only returned for export migrations.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -319184,7 +319177,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Unlocks a repository that was locked for migration. You should unlock each migrated repository and <a href=\"https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository\">delete them</a> when the migration is complete and you no longer need the source data.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -319194,7 +319186,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Unlocks a repository that was locked for migration. You should unlock each migrated repository and <a href=\"https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository\">delete them</a> when the migration is complete and you no longer need the source data.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -324565,7 +324558,6 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.14/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n</div>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -324587,7 +324579,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ]
+ ],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.14/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n</div>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -336361,13 +336354,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -339934,13 +339927,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -341725,13 +341718,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Members of an organization can choose to have their membership publicized or not.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Members of an organization can choose to have their membership publicized or not.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -341926,13 +341919,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -347132,7 +347125,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists requests from organization members to access organization resources with a fine-grained personal access token.</p>\n<p>Only GitHub Apps can use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -347154,7 +347146,8 @@
"httpStatusCode": "500",
"description": "<p>Internal Error</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists requests from organization members to access organization resources with a fine-grained personal access token.</p>\n<p>Only GitHub Apps can use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -357265,7 +357258,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Delete a ruleset for an organization.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -357279,7 +357271,8 @@
"httpStatusCode": "500",
"description": "<p>Internal Error</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Delete a ruleset for an organization.</p>"
}
],
"security-managers": [
@@ -358873,13 +358866,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -374008,7 +374001,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Updates information for a GitHub Enterprise Server Pages site. For more information, see \"<a href=\"/github/working-with-github-pages/about-github-pages\">About GitHub Pages</a>.</p>\n<p>The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -374026,7 +374018,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Updates information for a GitHub Enterprise Server Pages site. For more information, see \"<a href=\"/github/working-with-github-pages/about-github-pages\">About GitHub Pages</a>.</p>\n<p>The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -404144,13 +404137,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -422941,7 +422934,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<p>A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -422951,7 +422943,8 @@
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<p>A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -423039,13 +423032,13 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -460837,13 +460830,13 @@
}
}
],
- "descriptionHTML": "<p>Creates a new repository using a repository template. Use the <code>template_owner</code> and <code>template_repo</code> 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 <a href=\"https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository\">Get a repository</a> endpoint and check that the <code>is_template</code> key is <code>true</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>public_repo</code> or <code>repo</code> scope to create a public repository, and <code>repo</code> scope to create a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
],
+ "descriptionHTML": "<p>Creates a new repository using a repository template. Use the <code>template_owner</code> and <code>template_repo</code> 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 <a href=\"https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository\">Get a repository</a> endpoint and check that the <code>is_template</code> key is <code>true</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>public_repo</code> or <code>repo</code> scope to create a public repository, and <code>repo</code> scope to create a private repository.</p>",
"previews": [
"<p>Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json\n</code></pre>"
]
@@ -469038,13 +469031,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets all autolinks that are configured for a repository.</p>\n<p>Information about autolinks are only available to repository administrators.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets all autolinks that are configured for a repository.</p>\n<p>Information about autolinks are only available to repository administrators.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -469302,7 +469295,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This returns a single autolink reference by ID that was configured for the given repository.</p>\n<p>Information about autolinks are only available to repository administrators.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -469312,7 +469304,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>This returns a single autolink reference by ID that was configured for the given repository.</p>\n<p>Information about autolinks are only available to repository administrators.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -489945,7 +489938,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Redeliver a webhook delivery for a webhook configured in a repository.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -489959,7 +489951,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Redeliver a webhook delivery for a webhook configured in a repository.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -490105,7 +490098,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>This will trigger the hook with the latest push to the current repository if the hook is subscribed to <code>push</code> events. If the hook is not subscribed to <code>push</code> events, the server will respond with 204 but no test POST will be generated.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPreviously <code>/repos/:owner/:repo/hooks/:hook_id/test</code></p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -490115,7 +490107,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>This will trigger the hook with the latest push to the current repository if the hook is subscribed to <code>push</code> events. If the hook is not subscribed to <code>push</code> events, the server will respond with 204 but no test POST will be generated.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPreviously <code>/repos/:owner/:repo/hooks/:hook_id/test</code></p>\n</div>"
}
]
},
@@ -509971,13 +509964,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists a team's repositories visible to the authenticated user.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/repos</code>.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists a team's repositories visible to the authenticated user.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/repos</code>.</p>\n</div>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -511548,13 +511541,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists the child teams of the team specified by <code>{team_slug}</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/teams</code>.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>if child teams exist</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists the child teams of the team specified by <code>{team_slug}</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/teams</code>.</p>\n</div>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -522778,13 +522771,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/{org_id}/team/{team_id}/discussions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/{org_id}/team/{team_id}/discussions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -526020,13 +526013,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>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.</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>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.</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
diff --git a/src/rest/data/ghes-3.15-2022-11-28/schema.json b/src/rest/data/ghes-3.15-2022-11-28/schema.json
index d33e62485901..8e6b2d61fc6a 100644
--- a/src/rest/data/ghes-3.15-2022-11-28/schema.json
+++ b/src/rest/data/ghes-3.15-2022-11-28/schema.json
@@ -957,7 +957,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -1033,7 +1033,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -1126,7 +1126,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -157544,12 +157544,6 @@
"name": "dismissed_comment",
"in": "body",
"description": "<p>The dismissal comment associated with the dismissal of the alert.</p>"
- },
- {
- "type": "boolean",
- "name": "create_request",
- "in": "body",
- "description": "<p>If <code>true</code>, attempt to create an alert dismissal request.</p>"
}
],
"progAccess": {
@@ -157572,8 +157566,7 @@
"bodyParameters": {
"state": "dismissed",
"dismissed_reason": "false positive",
- "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
- "create_request": true
+ "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library."
},
"parameters": {
"owner": "OWNER",
@@ -205977,7 +205970,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "read"
+ "\"Enterprise administration\" enterprise permissions": "read"
}
]
},
@@ -206355,7 +206348,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -213796,7 +213789,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -214156,7 +214149,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -214449,7 +214442,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -214766,7 +214759,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -215306,7 +215299,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -215819,7 +215812,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -215943,7 +215936,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -216484,7 +216477,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -217201,7 +217194,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -217702,7 +217695,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -218140,7 +218133,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -219148,7 +219141,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json
index 73eff2e6a7e9..48a9084232f3 100644
--- a/src/rest/data/ghes-3.16-2022-11-28/schema.json
+++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json
@@ -957,7 +957,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -1033,7 +1033,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -1126,7 +1126,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -157723,12 +157723,6 @@
"name": "dismissed_comment",
"in": "body",
"description": "<p>The dismissal comment associated with the dismissal of the alert.</p>"
- },
- {
- "type": "boolean",
- "name": "create_request",
- "in": "body",
- "description": "<p>If <code>true</code>, attempt to create an alert dismissal request.</p>"
}
],
"progAccess": {
@@ -157751,8 +157745,7 @@
"bodyParameters": {
"state": "dismissed",
"dismissed_reason": "false positive",
- "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
- "create_request": true
+ "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library."
},
"parameters": {
"owner": "OWNER",
@@ -209855,7 +209848,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "read"
+ "\"Enterprise administration\" enterprise permissions": "read"
}
]
},
@@ -211526,7 +211519,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -218980,7 +218973,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -219340,7 +219333,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -219633,7 +219626,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -219950,7 +219943,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -220490,7 +220483,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -221003,7 +220996,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -221127,7 +221120,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -221668,7 +221661,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -222385,7 +222378,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -222886,7 +222879,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -223324,7 +223317,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -224332,7 +224325,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
diff --git a/src/rest/data/ghes-3.17-2022-11-28/schema.json b/src/rest/data/ghes-3.17-2022-11-28/schema.json
index 7f10423c6533..2ebaf3a875ca 100644
--- a/src/rest/data/ghes-3.17-2022-11-28/schema.json
+++ b/src/rest/data/ghes-3.17-2022-11-28/schema.json
@@ -957,7 +957,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -1033,7 +1033,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -1126,7 +1126,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -158018,12 +158018,6 @@
"name": "dismissed_comment",
"in": "body",
"description": "<p>The dismissal comment associated with the dismissal of the alert.</p>"
- },
- {
- "type": "boolean",
- "name": "create_request",
- "in": "body",
- "description": "<p>If <code>true</code>, attempt to create an alert dismissal request.</p>"
}
],
"progAccess": {
@@ -158046,8 +158040,7 @@
"bodyParameters": {
"state": "dismissed",
"dismissed_reason": "false positive",
- "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
- "create_request": true
+ "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library."
},
"parameters": {
"owner": "OWNER",
@@ -210644,7 +210637,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "read"
+ "\"Enterprise administration\" enterprise permissions": "read"
}
]
},
@@ -212328,7 +212321,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise administration\" business permissions": "write"
+ "\"Enterprise administration\" enterprise permissions": "write"
}
]
},
@@ -219782,7 +219775,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -220142,7 +220135,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -220435,7 +220428,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -220752,7 +220745,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -221292,7 +221285,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -221805,7 +221798,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -221929,7 +221922,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -222470,7 +222463,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -223187,7 +223180,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "read"
+ "\"Enterprise SCIM\" enterprise permissions": "read"
}
]
},
@@ -223688,7 +223681,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -224126,7 +224119,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
@@ -225134,7 +225127,7 @@
"fineGrainedPat": true,
"permissions": [
{
- "\"Enterprise SCIM\" business permissions": "write"
+ "\"Enterprise SCIM\" enterprise permissions": "write"
}
]
},
diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json
index 994bbd9b8044..2a20f0a9855c 100644
--- a/src/rest/lib/config.json
+++ b/src/rest/lib/config.json
@@ -47,5 +47,5 @@
]
}
},
- "sha": "3ae8ad33b4276583395c1b28852650f329018927"
+ "sha": "042ebdf85f1f5234751ac9603b977c9929e72c66"
}
\ No newline at end of file
diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json
index ee79d0900ceb..85e55a87ecc7 100644
--- a/src/webhooks/lib/config.json
+++ b/src/webhooks/lib/config.json
@@ -1,3 +1,3 @@
{
- "sha": "3ae8ad33b4276583395c1b28852650f329018927"
+ "sha": "042ebdf85f1f5234751ac9603b977c9929e72c66"
}
\ No newline at end of file
From b353276729670ab0012aa61996db3e5c04741a50 Mon Sep 17 00:00:00 2001
From: Sarah Schneider <sarahs@users.noreply.github.com>
Date: Mon, 30 Jun 2025 14:14:23 -0400
Subject: [PATCH 08/12] Mention new Docs feature in the RAI content for Copilot
in GitHub Support (#54199)
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
---
.../about-copilot-in-github-support.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/content/support/learning-about-github-support/about-copilot-in-github-support.md b/content/support/learning-about-github-support/about-copilot-in-github-support.md
index 2539643e6b55..6e4e54400e57 100644
--- a/content/support/learning-about-github-support/about-copilot-in-github-support.md
+++ b/content/support/learning-about-github-support/about-copilot-in-github-support.md
@@ -13,7 +13,7 @@ type: rai
## About {% data variables.copilot.copilot_in_support %}
-{% data variables.copilot.copilot_in_support %} is a new conversational AI tool built to offer immediate assistance within the {% data variables.contact.github_support %} portal, allowing you to tackle issues without waiting for a response from {% data variables.contact.github_support %}. {% data variables.copilot.copilot_in_support %} uses a large language model, trained on publicly available {% data variables.product.prodname_dotcom %} documentation, to provide a conversational way to get help for your {% data variables.product.prodname_dotcom %} inquiries without having to wait for customer support to respond to your inquiry.
+{% data variables.copilot.copilot_in_support %} is a new AI search experience on {% data variables.product.prodname_docs %} and a conversational AI tool built to offer immediate assistance within the {% data variables.contact.github_support %} portal, allowing you to tackle issues without waiting for a response from {% data variables.contact.github_support %}. {% data variables.copilot.copilot_in_support %} uses a large language model, trained on publicly available {% data variables.product.prodname_dotcom %} documentation, to provide a conversational way to get help for your {% data variables.product.prodname_dotcom %} inquiries without having to wait for customer support to respond to your inquiry.
The primary supported language for {% data variables.copilot.copilot_in_support %} is English.
From 69ccefe45d308224eb07f59dcd9fbaa72200652f Mon Sep 17 00:00:00 2001
From: docs-bot <77750099+docs-bot@users.noreply.github.com>
Date: Mon, 30 Jun 2025 12:49:43 -0700
Subject: [PATCH 09/12] Delete orphaned features (2025-06-30-16-29) (#56385)
---
data/features/copilot-hadron.yml | 6 ------
1 file changed, 6 deletions(-)
delete mode 100644 data/features/copilot-hadron.yml
diff --git a/data/features/copilot-hadron.yml b/data/features/copilot-hadron.yml
deleted file mode 100644
index f4cd0f41152c..000000000000
--- a/data/features/copilot-hadron.yml
+++ /dev/null
@@ -1,6 +0,0 @@
-# Reference: #15094
-# Copilot Workspace for PRs (the Hadron editor)
-
-versions:
- fpt: '*'
- ghec: '*'
From 095c64746473a13a9fa460bd31a9907d1f51d66a Mon Sep 17 00:00:00 2001
From: docs-bot <77750099+docs-bot@users.noreply.github.com>
Date: Mon, 30 Jun 2025 13:14:59 -0700
Subject: [PATCH 10/12] Update OpenAPI Description (#56395)
Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com>
---
.../fine-grained-pat-permissions.json | 4 +-
.../data/fpt-2022-11-28/fine-grained-pat.json | 4 +-
.../server-to-server-permissions.json | 4 +-
.../fpt-2022-11-28/server-to-server-rest.json | 4 +-
.../fpt-2022-11-28/user-to-server-rest.json | 4 +-
.../fine-grained-pat-permissions.json | 4 +-
.../ghec-2022-11-28/fine-grained-pat.json | 4 +-
.../server-to-server-permissions.json | 4 +-
.../server-to-server-rest.json | 4 +-
.../ghec-2022-11-28/user-to-server-rest.json | 4 +-
src/github-apps/lib/config.json | 2 +-
src/rest/data/fpt-2022-11-28/schema.json | 10 +-
src/rest/data/ghec-2022-11-28/schema.json | 409 +++++++++++++++++-
.../data/ghes-3.13-2022-11-28/schema.json | 212 ++++-----
.../data/ghes-3.14-2022-11-28/schema.json | 310 ++++++-------
.../data/ghes-3.16-2022-11-28/schema.json | 84 ++--
src/rest/lib/config.json | 2 +-
src/webhooks/lib/config.json | 2 +-
18 files changed, 735 insertions(+), 336 deletions(-)
diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
index d2f2165e43e8..b7c620a21fef 100644
--- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json
@@ -92,7 +92,7 @@
"permissions": [
{
"category": "dependabot",
- "slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "lists-the-repositories-dependabot-can-access-in-an-organization",
"subcategory": "repository-access",
"verb": "get",
"requestPath": "/organizations/{org}/dependabot/repository-access",
@@ -101,7 +101,7 @@
},
{
"category": "dependabot",
- "slug": "updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "updates-dependabots-repository-access-list-for-an-organization",
"subcategory": "repository-access",
"verb": "patch",
"requestPath": "/organizations/{org}/dependabot/repository-access",
diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
index 42770196727c..bd5d9b5256a8 100644
--- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
+++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json
@@ -2187,13 +2187,13 @@
],
"dependabot": [
{
- "slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "lists-the-repositories-dependabot-can-access-in-an-organization",
"subcategory": "repository-access",
"verb": "get",
"requestPath": "/organizations/{org}/dependabot/repository-access"
},
{
- "slug": "updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "updates-dependabots-repository-access-list-for-an-organization",
"subcategory": "repository-access",
"verb": "patch",
"requestPath": "/organizations/{org}/dependabot/repository-access"
diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json
index 4abf024f983b..e2530f846cee 100644
--- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json
@@ -110,7 +110,7 @@
"permissions": [
{
"category": "dependabot",
- "slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "lists-the-repositories-dependabot-can-access-in-an-organization",
"subcategory": "repository-access",
"verb": "get",
"requestPath": "/organizations/{org}/dependabot/repository-access",
@@ -121,7 +121,7 @@
},
{
"category": "dependabot",
- "slug": "updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "updates-dependabots-repository-access-list-for-an-organization",
"subcategory": "repository-access",
"verb": "patch",
"requestPath": "/organizations/{org}/dependabot/repository-access",
diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
index 748c841742b3..8d71010009e9 100644
--- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
+++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
@@ -1915,13 +1915,13 @@
],
"dependabot": [
{
- "slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "lists-the-repositories-dependabot-can-access-in-an-organization",
"subcategory": "repository-access",
"verb": "get",
"requestPath": "/organizations/{org}/dependabot/repository-access"
},
{
- "slug": "updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "updates-dependabots-repository-access-list-for-an-organization",
"subcategory": "repository-access",
"verb": "patch",
"requestPath": "/organizations/{org}/dependabot/repository-access"
diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json
index 42770196727c..bd5d9b5256a8 100644
--- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json
+++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json
@@ -2187,13 +2187,13 @@
],
"dependabot": [
{
- "slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "lists-the-repositories-dependabot-can-access-in-an-organization",
"subcategory": "repository-access",
"verb": "get",
"requestPath": "/organizations/{org}/dependabot/repository-access"
},
{
- "slug": "updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "updates-dependabots-repository-access-list-for-an-organization",
"subcategory": "repository-access",
"verb": "patch",
"requestPath": "/organizations/{org}/dependabot/repository-access"
diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
index f17bd9e3ec2a..cc4362ba1c92 100644
--- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
+++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json
@@ -284,7 +284,7 @@
},
{
"category": "dependabot",
- "slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "lists-the-repositories-dependabot-can-access-in-an-organization",
"subcategory": "repository-access",
"verb": "get",
"requestPath": "/organizations/{org}/dependabot/repository-access",
@@ -293,7 +293,7 @@
},
{
"category": "dependabot",
- "slug": "updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "updates-dependabots-repository-access-list-for-an-organization",
"subcategory": "repository-access",
"verb": "patch",
"requestPath": "/organizations/{org}/dependabot/repository-access",
diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
index b59a79100994..7394d3fdf809 100644
--- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
+++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json
@@ -2249,13 +2249,13 @@
],
"dependabot": [
{
- "slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "lists-the-repositories-dependabot-can-access-in-an-organization",
"subcategory": "repository-access",
"verb": "get",
"requestPath": "/organizations/{org}/dependabot/repository-access"
},
{
- "slug": "updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "updates-dependabots-repository-access-list-for-an-organization",
"subcategory": "repository-access",
"verb": "patch",
"requestPath": "/organizations/{org}/dependabot/repository-access"
diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
index 37fe7ed46828..5c180c9112f8 100644
--- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
+++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json
@@ -342,7 +342,7 @@
},
{
"category": "dependabot",
- "slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "lists-the-repositories-dependabot-can-access-in-an-organization",
"subcategory": "repository-access",
"verb": "get",
"requestPath": "/organizations/{org}/dependabot/repository-access",
@@ -353,7 +353,7 @@
},
{
"category": "dependabot",
- "slug": "updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "updates-dependabots-repository-access-list-for-an-organization",
"subcategory": "repository-access",
"verb": "patch",
"requestPath": "/organizations/{org}/dependabot/repository-access",
diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
index 47b2bb717c71..ea3a0fc2bac0 100644
--- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
+++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
@@ -1977,13 +1977,13 @@
],
"dependabot": [
{
- "slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "lists-the-repositories-dependabot-can-access-in-an-organization",
"subcategory": "repository-access",
"verb": "get",
"requestPath": "/organizations/{org}/dependabot/repository-access"
},
{
- "slug": "updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "updates-dependabots-repository-access-list-for-an-organization",
"subcategory": "repository-access",
"verb": "patch",
"requestPath": "/organizations/{org}/dependabot/repository-access"
diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
index b59a79100994..7394d3fdf809 100644
--- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
+++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json
@@ -2249,13 +2249,13 @@
],
"dependabot": [
{
- "slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "lists-the-repositories-dependabot-can-access-in-an-organization",
"subcategory": "repository-access",
"verb": "get",
"requestPath": "/organizations/{org}/dependabot/repository-access"
},
{
- "slug": "updates-repositories-to-the-list-of-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
+ "slug": "updates-dependabots-repository-access-list-for-an-organization",
"subcategory": "repository-access",
"verb": "patch",
"requestPath": "/organizations/{org}/dependabot/repository-access"
diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json
index 254723f085c3..95859016e387 100644
--- a/src/github-apps/lib/config.json
+++ b/src/github-apps/lib/config.json
@@ -60,5 +60,5 @@
"2022-11-28"
]
},
- "sha": "042ebdf85f1f5234751ac9603b977c9929e72c66"
+ "sha": "c52348cd88be16e613e49c26b39d2653e20b817d"
}
\ No newline at end of file
diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json
index 5a2da7e4f6eb..31da1a06f38b 100644
--- a/src/rest/data/fpt-2022-11-28/schema.json
+++ b/src/rest/data/fpt-2022-11-28/schema.json
@@ -250296,7 +250296,7 @@
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/organizations/{org}/dependabot/repository-access",
- "title": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.",
+ "title": "Lists the repositories Dependabot can access in an organization",
"category": "dependabot",
"subcategory": "repository-access",
"parameters": [
@@ -251022,7 +251022,7 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.</p>\n</div>",
+ "descriptionHTML": "<p>Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -251042,7 +251042,7 @@
"serverUrl": "https://api.github.com",
"verb": "patch",
"requestPath": "/organizations/{org}/dependabot/repository-access",
- "title": "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies.",
+ "title": "Updates Dependabot's repository access list for an organization",
"category": "dependabot",
"subcategory": "repository-access",
"parameters": [
@@ -251098,7 +251098,7 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.</p>\n</div>\n<p><strong>Example request body:</strong></p>\n<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"repository_ids_to_add\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span><span class=\"hljs-number\">123</span><span class=\"hljs-punctuation\">,</span> <span class=\"hljs-number\">456</span><span class=\"hljs-punctuation\">]</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"repository_ids_to_remove\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span><span class=\"hljs-number\">789</span><span class=\"hljs-punctuation\">]</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>",
+ "descriptionHTML": "<p>Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.</p>\n</div>\n<p><strong>Example request body:</strong></p>\n<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"repository_ids_to_add\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span><span class=\"hljs-number\">123</span><span class=\"hljs-punctuation\">,</span> <span class=\"hljs-number\">456</span><span class=\"hljs-punctuation\">]</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"repository_ids_to_remove\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span><span class=\"hljs-number\">789</span><span class=\"hljs-punctuation\">]</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -251176,7 +251176,7 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis operation supports both server-to-server and user-to-server access.\nSets the default level of repository access Dependabot will have while performing an update. Available values are:</p>\n</div>\n<ul>\n<li>'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.</li>\n<li>'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.</li>\n</ul>\n<p>Unauthorized users will not see the existence of this endpoint.</p>",
+ "descriptionHTML": "<p>Sets the default level of repository access Dependabot will have while performing an update. Available values are:</p>\n<ul>\n<li>'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.</li>\n<li>'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.</li>\n</ul>\n<p>Unauthorized users will not see the existence of this endpoint.</p>\n<p>This operation supports both server-to-server and user-to-server access.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json
index 29f55db22601..1c847e4685d1 100644
--- a/src/rest/data/ghec-2022-11-28/schema.json
+++ b/src/rest/data/ghec-2022-11-28/schema.json
@@ -265765,7 +265765,7 @@
"serverUrl": "https://api.github.com",
"verb": "get",
"requestPath": "/organizations/{org}/dependabot/repository-access",
- "title": "Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.",
+ "title": "Lists the repositories Dependabot can access in an organization",
"category": "dependabot",
"subcategory": "repository-access",
"parameters": [
@@ -266491,7 +266491,7 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.</p>\n</div>",
+ "descriptionHTML": "<p>Lists repositories that organization admins have allowed Dependabot to access when updating dependencies.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -266511,7 +266511,7 @@
"serverUrl": "https://api.github.com",
"verb": "patch",
"requestPath": "/organizations/{org}/dependabot/repository-access",
- "title": "Updates repositories to the list of repositories that organization admins have allowed Dependabot to access when updating dependencies.",
+ "title": "Updates Dependabot's repository access list for an organization",
"category": "dependabot",
"subcategory": "repository-access",
"parameters": [
@@ -266567,7 +266567,7 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.</p>\n</div>\n<p><strong>Example request body:</strong></p>\n<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"repository_ids_to_add\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span><span class=\"hljs-number\">123</span><span class=\"hljs-punctuation\">,</span> <span class=\"hljs-number\">456</span><span class=\"hljs-punctuation\">]</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"repository_ids_to_remove\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span><span class=\"hljs-number\">789</span><span class=\"hljs-punctuation\">]</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>",
+ "descriptionHTML": "<p>Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis operation supports both server-to-server and user-to-server access.\nUnauthorized users will not see the existence of this endpoint.</p>\n</div>\n<p><strong>Example request body:</strong></p>\n<pre><code class=\"hljs language-json\"><span class=\"hljs-punctuation\">{</span>\n <span class=\"hljs-attr\">\"repository_ids_to_add\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span><span class=\"hljs-number\">123</span><span class=\"hljs-punctuation\">,</span> <span class=\"hljs-number\">456</span><span class=\"hljs-punctuation\">]</span><span class=\"hljs-punctuation\">,</span>\n <span class=\"hljs-attr\">\"repository_ids_to_remove\"</span><span class=\"hljs-punctuation\">:</span> <span class=\"hljs-punctuation\">[</span><span class=\"hljs-number\">789</span><span class=\"hljs-punctuation\">]</span>\n<span class=\"hljs-punctuation\">}</span>\n</code></pre>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -266645,7 +266645,7 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis operation supports both server-to-server and user-to-server access.\nSets the default level of repository access Dependabot will have while performing an update. Available values are:</p>\n</div>\n<ul>\n<li>'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.</li>\n<li>'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.</li>\n</ul>\n<p>Unauthorized users will not see the existence of this endpoint.</p>",
+ "descriptionHTML": "<p>Sets the default level of repository access Dependabot will have while performing an update. Available values are:</p>\n<ul>\n<li>'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories.</li>\n<li>'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories.</li>\n</ul>\n<p>Unauthorized users will not see the existence of this endpoint.</p>\n<p>This operation supports both server-to-server and user-to-server access.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -284380,6 +284380,405 @@
}
]
},
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "get",
+ "requestPath": "/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}",
+ "title": "Get a cost center by ID",
+ "category": "enterprise-admin",
+ "subcategory": "billing",
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "<p>The slug version of the enterprise name. You can also substitute this value with the enterprise id.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "cost_center_id",
+ "description": "<p>The ID corresponding to the cost center.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "bodyParameters": [],
+ "progAccess": {
+ "userToServerRest": false,
+ "serverToServer": false,
+ "fineGrainedPat": false,
+ "permissions": []
+ },
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "parameters": {
+ "enterprise": "ENTERPRISE",
+ "cost_center_id": "COST_CENTER_ID"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "<p>Response when getting a cost center</p>",
+ "example": [
+ {
+ "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002",
+ "name": "Cost Center Name",
+ "resources": [
+ {
+ "type": "User",
+ "name": "Monalisa"
+ },
+ {
+ "type": "Repo",
+ "name": "octocat/hello-world"
+ }
+ ]
+ }
+ ],
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "ID of the cost center."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the cost center."
+ },
+ "resources": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Type of the resource."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the resource."
+ }
+ },
+ "required": [
+ "type",
+ "name"
+ ]
+ }
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "resources"
+ ]
+ }
+ }
+ }
+ ],
+ "previews": [],
+ "descriptionHTML": "<p>Gets a cost center by ID. The authenticated user must be an enterprise admin.</p>",
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "<p>Response when getting a cost center</p>"
+ },
+ {
+ "httpStatusCode": "400",
+ "description": "<p>Bad Request</p>"
+ },
+ {
+ "httpStatusCode": "403",
+ "description": "<p>Forbidden</p>"
+ },
+ {
+ "httpStatusCode": "500",
+ "description": "<p>Internal Error</p>"
+ },
+ {
+ "httpStatusCode": "503",
+ "description": "<p>Service unavailable</p>"
+ }
+ ]
+ },
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "patch",
+ "requestPath": "/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}",
+ "title": "Update a cost center name",
+ "category": "enterprise-admin",
+ "subcategory": "billing",
+ "parameters": [
+ {
+ "name": "enterprise",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "<p>The slug version of the enterprise name</p>"
+ },
+ {
+ "name": "cost_center_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "description": "<p>The unique identifier of the cost center</p>"
+ }
+ ],
+ "bodyParameters": [
+ {
+ "type": "string",
+ "name": "name",
+ "in": "body",
+ "description": "<p>The new name for the cost center</p>",
+ "isRequired": true
+ }
+ ],
+ "progAccess": {
+ "userToServerRest": false,
+ "serverToServer": false,
+ "fineGrainedPat": false,
+ "permissions": []
+ },
+ "codeExamples": [
+ {
+ "key": "update-cost-center",
+ "request": {
+ "contentType": "application/json",
+ "description": "Update cost center name example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "bodyParameters": {
+ "name": "New Cost Center Name"
+ },
+ "parameters": {
+ "enterprise": "ENTERPRISE",
+ "cost_center_id": "COST_CENTER_ID"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "<p>Response when updating a cost center</p>",
+ "example": [
+ {
+ "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002",
+ "name": "Cost Center Name",
+ "resources": [
+ {
+ "type": "User",
+ "name": "Monalisa"
+ },
+ {
+ "type": "Repo",
+ "name": "octocat/hello-world"
+ }
+ ]
+ }
+ ],
+ "schema": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "ID of the cost center."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the cost center."
+ },
+ "resources": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Type of the resource."
+ },
+ "name": {
+ "type": "string",
+ "description": "Name of the resource."
+ }
+ },
+ "required": [
+ "type",
+ "name"
+ ]
+ }
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "resources"
+ ]
+ }
+ }
+ }
+ ],
+ "previews": [],
+ "descriptionHTML": "<p>Updates an existing cost center name.</p>",
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "<p>Response when updating a cost center</p>"
+ },
+ {
+ "httpStatusCode": "400",
+ "description": "<p>Bad Request</p>"
+ },
+ {
+ "httpStatusCode": "403",
+ "description": "<p>Forbidden</p>"
+ },
+ {
+ "httpStatusCode": "404",
+ "description": "<p>Resource not found</p>"
+ },
+ {
+ "httpStatusCode": "409",
+ "description": "<p>Conflict</p>"
+ },
+ {
+ "httpStatusCode": "500",
+ "description": "<p>Internal Error</p>"
+ },
+ {
+ "httpStatusCode": "503",
+ "description": "<p>Service unavailable</p>"
+ }
+ ]
+ },
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "delete",
+ "requestPath": "/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}",
+ "title": "Delete a cost center",
+ "category": "enterprise-admin",
+ "subcategory": "billing",
+ "parameters": [
+ {
+ "name": "enterprise",
+ "description": "<p>The slug version of the enterprise name. You can also substitute this value with the enterprise id.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "cost_center_id",
+ "description": "<p>The ID corresponding to the cost center.</p>",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "bodyParameters": [],
+ "progAccess": {
+ "userToServerRest": false,
+ "serverToServer": false,
+ "fineGrainedPat": false,
+ "permissions": []
+ },
+ "codeExamples": [
+ {
+ "key": "default",
+ "request": {
+ "description": "Example",
+ "acceptHeader": "application/vnd.github.v3+json",
+ "parameters": {
+ "enterprise": "ENTERPRISE",
+ "cost_center_id": "COST_CENTER_ID"
+ }
+ },
+ "response": {
+ "statusCode": "200",
+ "contentType": "application/json",
+ "description": "<p>Response when deleting a cost center</p>",
+ "example": {
+ "message": "Cost center successfully deleted.",
+ "id": "2066deda-923f-43f9-88d2-62395a28c0cdd",
+ "name": "cc3",
+ "costCenterState": "CostCenterArchived"
+ },
+ "schema": {
+ "type": "object",
+ "properties": {
+ "message": {
+ "type": "string",
+ "description": "A message indicating the result of the deletion operation"
+ },
+ "id": {
+ "type": "string",
+ "description": "The unique identifier of the deleted cost center"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name of the deleted cost center"
+ },
+ "costCenterState": {
+ "type": "string",
+ "enum": [
+ "CostCenterArchived"
+ ],
+ "description": "The state of the cost center after deletion"
+ }
+ },
+ "required": [
+ "message",
+ "id",
+ "name",
+ "costCenterState"
+ ]
+ }
+ }
+ }
+ ],
+ "previews": [],
+ "descriptionHTML": "<p>Archieves a cost center by ID. The authenticated user must be an enterprise admin.</p>",
+ "statusCodes": [
+ {
+ "httpStatusCode": "200",
+ "description": "<p>Response when deleting a cost center</p>"
+ },
+ {
+ "httpStatusCode": "400",
+ "description": "<p>Bad Request</p>"
+ },
+ {
+ "httpStatusCode": "403",
+ "description": "<p>Forbidden</p>"
+ },
+ {
+ "httpStatusCode": "404",
+ "description": "<p>Resource not found</p>"
+ },
+ {
+ "httpStatusCode": "500",
+ "description": "<p>Internal Error</p>"
+ },
+ {
+ "httpStatusCode": "503",
+ "description": "<p>Service unavailable</p>"
+ }
+ ]
+ },
{
"serverUrl": "https://api.github.com",
"verb": "post",
diff --git a/src/rest/data/ghes-3.13-2022-11-28/schema.json b/src/rest/data/ghes-3.13-2022-11-28/schema.json
index 6156ead9bfc2..3f2889daee5e 100644
--- a/src/rest/data/ghes-3.13-2022-11-28/schema.json
+++ b/src/rest/data/ghes-3.13-2022-11-28/schema.json
@@ -1846,13 +1846,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists the GitHub Actions caches for a repository.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists the GitHub Actions caches for a repository.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2168,13 +2168,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the customization template for an OpenID Connect (OIDC) subject claim.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>A JSON serialized template for OIDC subject claim customization</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets the customization template for an OpenID Connect (OIDC) subject claim.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2634,13 +2634,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2961,13 +2961,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -4668,13 +4668,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5032,13 +5032,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>If the organization belongs to an enterprise that has <code>selected</code> actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.</p>\n<p>To use the <code>patterns_allowed</code> setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the <code>patterns_allowed</code> setting only applies to public repositories in the organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>If the organization belongs to an enterprise that has <code>selected</code> actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.</p>\n<p>To use the <code>patterns_allowed</code> setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the <code>patterns_allowed</code> setting only applies to public repositories in the organization.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5287,13 +5287,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration</code> repository permission to use this API.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.</p>\n<p>You must authenticate using an access token with the <code>repo</code> scope to use this endpoint. GitHub Apps must have the <code>administration</code> repository permission to use this API.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5375,13 +5375,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.</p>\n<p>If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as <code>allowed_actions</code> to <code>selected</code> actions, then you cannot override them for the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.</p>\n<p>If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as <code>allowed_actions</code> to <code>selected</code> actions, then you cannot override them for the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -6066,13 +6066,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -6174,13 +6174,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>The authenticated user must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>The authenticated user must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -6499,13 +6499,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10070,13 +10070,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10140,13 +10140,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10664,13 +10664,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -11462,13 +11462,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a self-hosted runner group for an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Deletes a self-hosted runner group for an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -14974,13 +14974,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>Example using registration token:</p>\n<p>Configure your self-hosted runner, replacing <code>TOKEN</code> with the registration token provided by this endpoint.</p>\n<pre><code>./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n</code></pre>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -20402,7 +20402,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -20416,7 +20415,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -24695,13 +24695,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists all organization variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists all organization variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -24934,13 +24934,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets a specific variable in an organization.</p>\n<p>The authenticated user must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets a specific variable in an organization.</p>\n<p>The authenticated user must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -26168,7 +26168,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their <code>visibility</code> field set to <code>selected</code>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -26178,7 +26177,8 @@
"httpStatusCode": "409",
"description": "<p>Response when the visibility of the variable is not set to <code>selected</code></p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Replaces all repositories for an organization variable that is available\nto selected repositories. Organization variables that are available to selected\nrepositories have their <code>visibility</code> field set to <code>selected</code>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -26326,7 +26326,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their <code>visibility</code> field set to <code>selected</code>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -26336,7 +26335,8 @@
"httpStatusCode": "409",
"description": "<p>Response when the visibility of the variable is not set to <code>selected</code></p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Removes a repository from an organization variable that is\navailable to selected repositories. Organization variables that are available to\nselected repositories have their <code>visibility</code> field set to <code>selected</code>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -55267,13 +55267,13 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -82132,13 +82132,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists all notifications for the current user in the specified repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists all notifications for the current user in the specified repository.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -101996,13 +101996,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Enables an authenticated GitHub App to find the user’s installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Enables an authenticated GitHub App to find the user’s installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.13/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
}
],
"installations": [
@@ -118401,7 +118401,6 @@
}
],
"previews": [],
- "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "201",
@@ -118427,7 +118426,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ]
+ ],
+ "descriptionHTML": ""
}
],
"branch-protection": [
@@ -185565,13 +185565,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -187649,13 +187649,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a secret in a repository using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Deletes a secret in a repository using the secret name.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}
]
},
@@ -201037,13 +201037,13 @@
}
],
"previews": [],
- "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -201236,13 +201236,13 @@
}
],
"previews": [],
- "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -202269,13 +202269,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the GitHub Advanced Security active committers for an enterprise per repository.</p>\n<p>Each distinct user login across all repositories is counted as a single Advanced Security seat, so the <code>total_advanced_security_committers</code> is not the sum of active_users for each repository.</p>\n<p>The total number of repositories with committer information is tracked by the <code>total_count</code> field.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>Success</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets the GitHub Advanced Security active committers for an enterprise per repository.</p>\n<p>Each distinct user login across all repositories is counted as a single Advanced Security seat, so the <code>total_advanced_security_committers</code> is not the sum of active_users for each repository.</p>\n<p>The total number of repositories with committer information is tracked by the <code>total_count</code> field.</p>"
}
],
"code-security-and-analysis": [
@@ -208705,13 +208705,13 @@
}
],
"previews": [],
- "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "202",
"description": "<p>Accepted</p>"
}
- ]
+ ],
+ "descriptionHTML": ""
}
],
"pre-receive-environments": [
@@ -209702,13 +209702,13 @@
}
],
"previews": [],
- "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -293365,13 +293365,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists labels for issues in a milestone.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists labels for issues in a milestone.</p>"
}
],
"milestones": [
@@ -293853,7 +293853,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists milestones for a repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -293863,7 +293862,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists milestones for a repository.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -313599,13 +313599,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Get the octocat as ASCII art</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Get the octocat as ASCII art</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -324558,7 +324558,6 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.13/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n</div>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -324580,7 +324579,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ]
+ ],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.13/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n</div>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -338443,13 +338443,13 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> This operation is closing down and will be removed in the future. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization\">List custom repository roles</a>\" endpoint instead.</p>\n</div>\n<p>List the custom repository roles available in this organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>Response - list of custom role names</p>"
}
- ]
+ ],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> This operation is closing down and will be removed in the future. Use the \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization\">List custom repository roles</a>\" endpoint instead.</p>\n</div>\n<p>List the custom repository roles available in this organization. For more information on custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> or <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -341706,13 +341706,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Members of an organization can choose to have their membership publicized or not.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Members of an organization can choose to have their membership publicized or not.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -341771,7 +341771,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Check if the provided user is a public member of the organization.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -341781,7 +341780,8 @@
"httpStatusCode": "404",
"description": "<p>Not Found if user is not a public member</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Check if the provided user is a public member of the organization.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -343774,7 +343774,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Removing a user from this list will remove them from all the organization's repositories.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -343784,7 +343783,8 @@
"httpStatusCode": "422",
"description": "<p>Unprocessable Entity if user is a member of the organization</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Removing a user from this list will remove them from all the organization's repositories.</p>"
}
],
"personal-access-tokens": [
@@ -355471,13 +355471,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Returns the webhook configuration for an organization. To get more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#get-an-organization-webhook\">Get an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -372731,7 +372731,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists the projects in an organization. Returns a <code>404 Not Found</code> status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a <code>401 Unauthorized</code> or <code>410 Gone</code> status is returned.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -372741,7 +372740,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists the projects in an organization. Returns a <code>404 Not Found</code> status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a <code>401 Unauthorized</code> or <code>410 Gone</code> status is returned.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -400888,13 +400888,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -402970,13 +402970,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists all review comments for a specified pull request. By default, review comments\nare in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -415353,7 +415353,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Creates a review on a specified pull request.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\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 <code>application/vnd.github.v3.diff</code> media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#get-a-pull-request\">Get a pull request</a> endpoint.</p>\n</div>\n<p>The <code>position</code> 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.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -415367,7 +415366,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Creates a review on a specified pull request.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.13/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/pulls/reviews#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\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 <code>application/vnd.github.v3.diff</code> media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#get-a-pull-request\">Get a pull request</a> endpoint.</p>\n</div>\n<p>The <code>position</code> 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.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -416666,7 +416666,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -416680,7 +416679,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -423015,13 +423015,13 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a repository by <code>repository_id</code> using the route <code>DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to an <a href=\"https://docs.github.com/enterprise-server@3.13/rest/issues/comments#get-an-issue-comment\">issue comment</a>.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -424474,7 +424474,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -424484,7 +424483,8 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.13/rest/pulls/comments#get-a-review-comment-for-a-pull-request\">pull request review comment</a>.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -426174,7 +426174,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -426188,7 +426187,8 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.13/rest/releases/releases#get-a-release\">release</a>. A response with a <code>Status: 200 OK</code> means that you already added the reaction type to this release.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -432399,13 +432399,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Users with push access to the repository can edit a release.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Users with push access to the repository can edit a release.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -432473,13 +432473,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Users with push access to the repository can delete a release.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Users with push access to the repository can delete a release.</p>"
}
],
"assets": [
@@ -465782,13 +465782,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets all autolinks that are configured for a repository.</p>\n<p>Information about autolinks are only available to repository administrators.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets all autolinks that are configured for a repository.</p>\n<p>Information about autolinks are only available to repository administrators.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -488979,7 +488979,6 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -488989,7 +488988,8 @@
"httpStatusCode": "304",
"description": "<p>Not modified</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Find commits via various criteria on the default branch (usually <code>main</code>). This method returns up to 100 results <a href=\"https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api\">per page</a>.</p>\n<p>When searching for commits, you can get text match metadata for the <strong>message</strong> field when you provide the <code>text-match</code> media type. For more details about how to receive highlighted search results, see <a href=\"https://docs.github.com/enterprise-server@3.13/rest/search/search#text-match-metadata\">Text match\nmetadata</a>.</p>\n<p>For example, if you want to find commits related to CSS in the <a href=\"https://github.com/octocat/Spoon-Knife\">octocat/Spoon-Knife</a> repository. Your query would look something like this:</p>\n<p><code>q=repo:octocat/Spoon-Knife+css</code></p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json
index df759579e103..238716b15cbd 100644
--- a/src/rest/data/ghes-3.14-2022-11-28/schema.json
+++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json
@@ -553,13 +553,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Deletes an artifact for a workflow run.\nOAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2168,13 +2168,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets the customization template for an OpenID Connect (OIDC) subject claim.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>A JSON serialized template for OIDC subject claim customization</p>"
}
- ],
- "descriptionHTML": "<p>Gets the customization template for an OpenID Connect (OIDC) subject claim.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -2961,13 +2961,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for <code>enabled_organizations</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -3178,13 +3178,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for <code>allowed_actions</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-enterprise\">Set GitHub Actions permissions for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:enterprise</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -4737,13 +4737,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for <code>enabled_repositories</code> must be configured to <code>selected</code>. For more information, see \"<a href=\"#set-github-actions-permissions-for-an-organization\">Set GitHub Actions permissions for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -5904,6 +5904,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Sets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository\">Setting the permissions of the GITHUB_TOKEN for your repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -5913,8 +5914,7 @@
"httpStatusCode": "409",
"description": "<p>Conflict response when changing a setting is prevented by the owning organization or enterprise</p>"
}
- ],
- "descriptionHTML": "<p>Sets the default workflow permissions granted to the <code>GITHUB_TOKEN</code> when running workflows in a repository, and sets if GitHub Actions\ncan submit approving pull request reviews.\nFor more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository\">Setting the permissions of the GITHUB_TOKEN for your repository</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
}
],
"secrets": [
@@ -6499,13 +6499,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Deletes a secret in an organization using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the<code>admin:org</code> scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -7561,13 +7561,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code>\nfor repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-organization-secret\">Create\nor update an organization secret</a>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code>\nfor repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#create-or-update-an-organization-secret\">Create\nor update an organization secret</a>.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -8224,13 +8224,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a single repository secret without revealing its encrypted value.</p>\n<p>The authenticated user must have collaborator access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a single repository secret without revealing its encrypted value.</p>\n<p>The authenticated user must have collaborator access to the repository to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -9044,13 +9044,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Deletes a secret in an environment using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>Default response</p>"
}
- ],
- "descriptionHTML": "<p>Deletes a secret in an environment using the secret name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read secrets.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
}
],
"self-hosted-runner-groups": [
@@ -10070,13 +10070,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -10140,13 +10140,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-enterprise\">Create a self-hosted runner group for an enterprise</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -11462,13 +11462,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Deletes a self-hosted runner group for an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Deletes a self-hosted runner group for an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -12847,13 +12847,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-organization\">Create a self-hosted runner group for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have <code>visibility</code> set to <code>selected</code>. For more information, see \"<a href=\"#create-a-self-hosted-runner-group-for-an-organization\">Create a self-hosted runner group for an organization</a>.\"</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -13169,13 +13169,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an organization runner group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Replaces the list of self-hosted runners that are part of an organization runner group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -13243,13 +13243,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Adds a self-hosted runner to a runner group configured in an organization.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -16034,13 +16034,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>Example using remove token:</p>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ],
- "descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>Example using remove token:</p>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -19899,13 +19899,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a specific self-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a specific self-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -26737,13 +26737,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Creates a repository variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ],
- "descriptionHTML": "<p>Creates a repository variable that you can reference in a GitHub Actions workflow.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -27026,13 +27026,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Deletes a repository variable using the variable name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Deletes a repository variable using the variable name.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -29260,13 +29260,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see <a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information\nabout using parameters, see <a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#parameters\">Parameters</a>.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
+ ]
}
],
"workflow-runs": [
@@ -34955,13 +34955,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a specific workflow run.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a specific workflow run.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -35402,13 +35402,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -38250,13 +38250,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for <code>Location:</code> in the response header to find the URL for the download.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "302",
"description": "<p>Found</p>"
}
- ],
- "descriptionHTML": "<p>Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for <code>Location:</code> in the response header to find the URL for the download.</p>\n<p>Anyone with read access to the repository can use this endpoint.</p>\n<p>If the repository is private, OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -38333,6 +38333,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Cancels a workflow run using its <code>id</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -38342,8 +38343,7 @@
"httpStatusCode": "409",
"description": "<p>Conflict</p>"
}
- ],
- "descriptionHTML": "<p>Cancels a workflow run using its <code>id</code>.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -40330,13 +40330,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Re-run all of the failed jobs and their dependent jobs in a workflow run using the <code>id</code> of the workflow run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ],
- "descriptionHTML": "<p>Re-run all of the failed jobs and their dependent jobs in a workflow run using the <code>id</code> of the workflow run.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -55267,13 +55267,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -62859,13 +62859,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. <em>Optional</em>: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. <em>Optional</em>: use the fine-grained token with following permission set to view private events: \"Events\" user permissions (read).</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.</p>\n</div>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -78406,13 +78406,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>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.</p>\n<ul>\n<li><strong>Timeline</strong>: The GitHub Enterprise Server global public timeline</li>\n<li><strong>User</strong>: The public timeline for any user, using <code>uri_template</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia\">Hypermedia</a>.\"</li>\n<li><strong>Current user public</strong>: The public timeline for the authenticated user</li>\n<li><strong>Current user</strong>: The private timeline for the authenticated user</li>\n<li><strong>Current user actor</strong>: The private timeline for activity created by the authenticated user</li>\n<li><strong>Current user organizations</strong>: The private timeline for the organizations the authenticated user is a member of.</li>\n<li><strong>Security advisories</strong>: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.</li>\n</ul>\n<p>By default, timeline resources are returned in JSON. You can specify the <code>application/atom+xml</code> type in the <code>Accept</code> header to return timeline resources in Atom format. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPrivate feeds are only returned when <a href=\"https://docs.github.com/enterprise-server@3.14/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication\">authenticating via Basic Auth</a> since current feed URIs use the older, non revocable auth tokens.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>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.</p>\n<ul>\n<li><strong>Timeline</strong>: The GitHub Enterprise Server global public timeline</li>\n<li><strong>User</strong>: The public timeline for any user, using <code>uri_template</code>. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia\">Hypermedia</a>.\"</li>\n<li><strong>Current user public</strong>: The public timeline for the authenticated user</li>\n<li><strong>Current user</strong>: The private timeline for the authenticated user</li>\n<li><strong>Current user actor</strong>: The private timeline for activity created by the authenticated user</li>\n<li><strong>Current user organizations</strong>: The private timeline for the organizations the authenticated user is a member of.</li>\n<li><strong>Security advisories</strong>: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server.</li>\n</ul>\n<p>By default, timeline resources are returned in JSON. You can specify the <code>application/atom+xml</code> type in the <code>Accept</code> header to return timeline resources in Atom format. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPrivate feeds are only returned when <a href=\"https://docs.github.com/enterprise-server@3.14/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication\">authenticating via Basic Auth</a> since current feed URIs use the older, non revocable auth tokens.</p>\n</div>"
+ ]
}
],
"notifications": [
@@ -99824,13 +99824,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Enables an authenticated GitHub App to find the organization's installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -101996,13 +101996,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Enables an authenticated GitHub App to find the user’s installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Enables an authenticated GitHub App to find the user’s installation information.</p>\n<p>You must use a <a href=\"https://docs.github.com/enterprise-server@3.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app\">JWT</a> to access this endpoint.</p>"
+ ]
}
],
"installations": [
@@ -123586,13 +123586,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -136754,13 +136754,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Creates a new check run for a specific commit in a repository.</p>\n<p>To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.</p>\n<p>In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe 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 <code>pull_requests</code> array.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ],
- "descriptionHTML": "<p>Creates a new check run for a specific commit in a repository.</p>\n<p>To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.</p>\n<p>In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe 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 <code>pull_requests</code> array.</p>\n</div>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -139729,13 +139729,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Updates a check run for a specific commit in a repository.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array.</p>\n</div>\n<p>OAuth apps and personal access tokens (classic) cannot use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Updates a check run for a specific commit in a repository.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array.</p>\n</div>\n<p>OAuth apps and personal access tokens (classic) cannot use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -147933,13 +147933,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>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 <a href=\"https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite\">Create a check suite</a>.\nYou must have admin permissions in the repository to set preferences for check suites.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>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 <a href=\"https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite\">Create a check suite</a>.\nYou must have admin permissions in the repository to set preferences for check suites.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -149869,13 +149869,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a single check suite using its <code>id</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe 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 <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a single check suite using its <code>id</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe 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 <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -151824,13 +151824,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists check suites for a commit <code>ref</code>. The <code>ref</code> can be a SHA, branch name, or a tag name.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists check suites for a commit <code>ref</code>. The <code>ref</code> can be a SHA, branch name, or a tag name.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty <code>pull_requests</code> array and a <code>null</code> value for <code>head_branch</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint on a private repository.</p>"
+ ]
}
]
},
@@ -159927,6 +159927,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method\">HTTP method</a>.\"</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>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 <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -159940,8 +159941,7 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ],
- "descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<p>Adding an outside collaborator may be restricted by enterprise administrators. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories\">Enforcing repository management policies in your enterprise</a>.\"</p>\n<p>For more information on permission levels, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization\">Repository permission levels for an organization</a>\". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with:</p>\n<pre><code>Cannot assign {member} permission of {role name}\n</code></pre>\n<p>Note that, if you choose not to pass any parameters, you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method\">HTTP method</a>.\"</p>\n<p><strong>Updating an existing collaborator's permission level</strong></p>\n<p>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 <code>permission</code> parameter. The response will be a <code>204</code>, with no other indication that the permission level changed.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -160009,6 +160009,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Removes a collaborator from a repository.</p>\n<p>To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.</p>\n<p>This endpoint also:</p>\n<ul>\n<li>Cancels any outstanding invitations sent by the collaborator</li>\n<li>Unassigns the user from any issues</li>\n<li>Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.</li>\n<li>Unstars the repository</li>\n<li>Updates access permissions to packages</li>\n</ul>\n<p>Removing a user as a collaborator has the following effects on forks:</p>\n<ul>\n<li>If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.</li>\n<li>If the user had their own fork of the repository, the fork will be deleted.</li>\n<li>If the user still has read access to the repository, open pull requests by this user from a fork will be denied.</li>\n</ul>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nA user can still have access to the repository through organization permissions like base repository permissions.</p>\n</div>\n<p>Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.</p>\n<p>For more information on fork permissions, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks\">About permissions and visibility of forks</a>\".</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -160022,8 +160023,7 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ],
- "descriptionHTML": "<p>Removes a collaborator from a repository.</p>\n<p>To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal.</p>\n<p>This endpoint also:</p>\n<ul>\n<li>Cancels any outstanding invitations sent by the collaborator</li>\n<li>Unassigns the user from any issues</li>\n<li>Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories.</li>\n<li>Unstars the repository</li>\n<li>Updates access permissions to packages</li>\n</ul>\n<p>Removing a user as a collaborator has the following effects on forks:</p>\n<ul>\n<li>If the user had access to a fork through their membership to this repository, the user will also be removed from the fork.</li>\n<li>If the user had their own fork of the repository, the fork will be deleted.</li>\n<li>If the user still has read access to the repository, open pull requests by this user from a fork will be denied.</li>\n</ul>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nA user can still have access to the repository through organization permissions like base repository permissions.</p>\n</div>\n<p>Although the API responds immediately, the additional permission updates might take some extra time to complete in the background.</p>\n<p>For more information on fork permissions, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks\">About permissions and visibility of forks</a>\".</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -185481,13 +185481,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists all secrets available in an organization without revealing their\nencrypted values.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -185565,13 +185565,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets your public key, which you need to encrypt secrets. You need to\nencrypt a secret before you can create or update secrets.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -185681,13 +185681,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a single organization secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a single organization secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -186950,13 +186950,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code>\nfor repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret\">Create\nor update an organization secret</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Replaces all repositories for an organization secret when the <code>visibility</code>\nfor repository access is set to <code>selected</code>. The visibility is set when you <a href=\"https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#create-or-update-an-organization-secret\">Create\nor update an organization secret</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -187449,13 +187449,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets a single repository secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets a single repository secret without revealing its encrypted value.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -188229,13 +188229,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Create a new snapshot of a repository's dependencies.</p>\n<p>The authenticated user must have access to the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ],
- "descriptionHTML": "<p>Create a new snapshot of a repository's dependencies.</p>\n<p>The authenticated user must have access to the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
}
],
"sboms": [
@@ -192601,13 +192601,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Deletes a deployment branch or tag policy for an environment.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Deletes a deployment branch or tag policy for an environment.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
}
],
"environments": [
@@ -195242,13 +195242,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>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 \"<a href=\"https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>List of deployment protection rules</p>"
}
- ],
- "descriptionHTML": "<p>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 \"<a href=\"https://docs.github.com/enterprise-server@3.14/actions/deployment/targeting-different-environments/using-environments-for-deployment\">Using environments for deployment</a>.\"</p>\n<p>For more information about the app that is providing this custom deployment rule, see the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app\">documentation for the <code>GET /apps/{app_slug}</code> endpoint</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint with a private repository.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -200649,13 +200649,13 @@
}
],
"previews": [],
+ "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": ""
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -200843,13 +200843,13 @@
}
],
"previews": [],
+ "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": ""
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -200969,13 +200969,13 @@
}
],
"previews": [],
+ "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": ""
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -201037,13 +201037,13 @@
}
],
"previews": [],
+ "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": ""
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -201342,13 +201342,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets the statistics about security products for a GitHub Enterprise Server instance.</p>\n<p>To use this endpoint, you must be a site admin.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets the statistics about security products for a GitHub Enterprise Server instance.</p>\n<p>To use this endpoint, you must be a site admin.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -208153,13 +208153,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -220009,13 +220009,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Note that you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method\">HTTP method</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Note that you'll need to set <code>Content-Length</code> to zero when calling out to this endpoint. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method\">HTTP method</a>.\"</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -231248,6 +231248,7 @@
}
],
"previews": [],
+ "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -231265,8 +231266,7 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ],
- "descriptionHTML": ""
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -315987,13 +315987,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).</p>\n<p>A list of <code>repositories</code> is only returned for export migrations.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API).</p>\n<p>A list of <code>repositories</code> is only returned for export migrations.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -319177,6 +319177,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Unlocks a repository that was locked for migration. You should unlock each migrated repository and <a href=\"https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository\">delete them</a> when the migration is complete and you no longer need the source data.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -319186,8 +319187,7 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ],
- "descriptionHTML": "<p>Unlocks a repository that was locked for migration. You should unlock each migrated repository and <a href=\"https://docs.github.com/enterprise-server@3.14/rest/repos/repos#delete-a-repository\">delete them</a> when the migration is complete and you no longer need the source data.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -324558,6 +324558,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.14/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n</div>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -324579,8 +324580,7 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Closing down notice:</strong> GitHub Enterprise Server will discontinue the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations/\">OAuth Authorizations API</a>, which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our <a href=\"https://docs.github.com/enterprise-server@3.14/developers/apps/authorizing-oauth-apps#web-application-flow\">web application flow</a>. The <a href=\"https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations\">OAuth Authorizations API</a> will be removed on November 13, 2020. For more information, including scheduled brownouts, see the <a href=\"https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/\">blog post</a>.</p>\n</div>\n<p>You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the <a href=\"https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations\">list your authorizations</a> API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on <a href=\"https://github.com/settings/applications#authorized\">the application authorizations settings screen within GitHub</a>. The <code>scopes</code> returned are the union of scopes authorized for the application. For example, if an application has one token with <code>repo</code> scope and another token with <code>user</code> scope, the grant will return <code>[\"repo\", \"user\"]</code>.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -336354,13 +336354,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists all GitHub Apps in an organization. The installation count includes\nall GitHub Apps installed on repositories in the organization.</p>\n<p>The authenticated user must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:read</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -339927,13 +339927,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Deletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles\">About custom repository roles</a>.\"</p>\n<p>The authenticated user must be an administrator for the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -341718,13 +341718,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Members of an organization can choose to have their membership publicized or not.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Members of an organization can choose to have their membership publicized or not.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -341919,13 +341919,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<p>Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -347125,6 +347125,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists requests from organization members to access organization resources with a fine-grained personal access token.</p>\n<p>Only GitHub Apps can use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -347146,8 +347147,7 @@
"httpStatusCode": "500",
"description": "<p>Internal Error</p>"
}
- ],
- "descriptionHTML": "<p>Lists requests from organization members to access organization resources with a fine-grained personal access token.</p>\n<p>Only GitHub Apps can use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -357258,6 +357258,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Delete a ruleset for an organization.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -357271,8 +357272,7 @@
"httpStatusCode": "500",
"description": "<p>Internal Error</p>"
}
- ],
- "descriptionHTML": "<p>Delete a ruleset for an organization.</p>"
+ ]
}
],
"security-managers": [
@@ -358866,13 +358866,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Updates the webhook configuration for an organization. To update more information about the webhook, including the <code>active</code> state and <code>events</code>, use \"<a href=\"/rest/orgs/webhooks#update-an-organization-webhook\">Update an organization webhook </a>.\"</p>\n<p>You must be an organization owner to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need <code>admin:org_hook</code> scope. OAuth apps cannot list, view, or edit\nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -374001,6 +374001,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Updates information for a GitHub Enterprise Server Pages site. For more information, see \"<a href=\"/github/working-with-github-pages/about-github-pages\">About GitHub Pages</a>.</p>\n<p>The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -374018,8 +374019,7 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ],
- "descriptionHTML": "<p>Updates information for a GitHub Enterprise Server Pages site. For more information, see \"<a href=\"/github/working-with-github-pages/about-github-pages\">About GitHub Pages</a>.</p>\n<p>The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -404137,13 +404137,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists review comments for all pull requests in a repository. By default,\nreview comments are in ascending order by ID.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github-commitcomment.raw+json</code></strong>: Returns the raw markdown body. Response will include <code>body</code>. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github-commitcomment.text+json</code></strong>: Returns a text only representation of the markdown body. Response will include <code>body_text</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.html+json</code></strong>: Returns HTML rendered from the body's markdown. Response will include <code>body_html</code>.</li>\n<li><strong><code>application/vnd.github-commitcomment.full+json</code></strong>: Returns raw, text, and HTML representations. Response will include <code>body</code>, <code>body_text</code>, and <code>body_html</code>.</li>\n</ul>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -422934,6 +422934,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<p>A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -422943,8 +422944,7 @@
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ],
- "descriptionHTML": "<p>Create a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<p>A response with an HTTP <code>200</code> status means that you already added the reaction type to this team discussion comment.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -423032,13 +423032,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment\">team discussion comment</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -460830,13 +460830,13 @@
}
}
],
+ "descriptionHTML": "<p>Creates a new repository using a repository template. Use the <code>template_owner</code> and <code>template_repo</code> 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 <a href=\"https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository\">Get a repository</a> endpoint and check that the <code>is_template</code> key is <code>true</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>public_repo</code> or <code>repo</code> scope to create a public repository, and <code>repo</code> scope to create a private repository.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
],
- "descriptionHTML": "<p>Creates a new repository using a repository template. Use the <code>template_owner</code> and <code>template_repo</code> 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 <a href=\"https://docs.github.com/enterprise-server@3.14/rest/repos/repos#get-a-repository\">Get a repository</a> endpoint and check that the <code>is_template</code> key is <code>true</code>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>public_repo</code> or <code>repo</code> scope to create a public repository, and <code>repo</code> scope to create a private repository.</p>",
"previews": [
"<p>Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom <a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.baptiste-preview+json\n</code></pre>"
]
@@ -469031,13 +469031,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Gets all autolinks that are configured for a repository.</p>\n<p>Information about autolinks are only available to repository administrators.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Gets all autolinks that are configured for a repository.</p>\n<p>Information about autolinks are only available to repository administrators.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -469295,6 +469295,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>This returns a single autolink reference by ID that was configured for the given repository.</p>\n<p>Information about autolinks are only available to repository administrators.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -469304,8 +469305,7 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ],
- "descriptionHTML": "<p>This returns a single autolink reference by ID that was configured for the given repository.</p>\n<p>Information about autolinks are only available to repository administrators.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -489938,6 +489938,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Redeliver a webhook delivery for a webhook configured in a repository.</p>",
"statusCodes": [
{
"httpStatusCode": "202",
@@ -489951,8 +489952,7 @@
"httpStatusCode": "422",
"description": "<p>Validation failed, or the endpoint has been spammed.</p>"
}
- ],
- "descriptionHTML": "<p>Redeliver a webhook delivery for a webhook configured in a repository.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -490098,6 +490098,7 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>This will trigger the hook with the latest push to the current repository if the hook is subscribed to <code>push</code> events. If the hook is not subscribed to <code>push</code> events, the server will respond with 204 but no test POST will be generated.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPreviously <code>/repos/:owner/:repo/hooks/:hook_id/test</code></p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "204",
@@ -490107,8 +490108,7 @@
"httpStatusCode": "404",
"description": "<p>Resource not found</p>"
}
- ],
- "descriptionHTML": "<p>This will trigger the hook with the latest push to the current repository if the hook is subscribed to <code>push</code> events. If the hook is not subscribed to <code>push</code> events, the server will respond with 204 but no test POST will be generated.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nPreviously <code>/repos/:owner/:repo/hooks/:hook_id/test</code></p>\n</div>"
+ ]
}
]
},
@@ -509964,13 +509964,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists a team's repositories visible to the authenticated user.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/repos</code>.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>Lists a team's repositories visible to the authenticated user.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/repos</code>.</p>\n</div>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -511541,13 +511541,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Lists the child teams of the team specified by <code>{team_slug}</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/teams</code>.</p>\n</div>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>if child teams exist</p>"
}
- ],
- "descriptionHTML": "<p>Lists the child teams of the team specified by <code>{team_slug}</code>.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/teams</code>.</p>\n</div>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -522771,13 +522771,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/{org_id}/team/{team_id}/discussions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ],
- "descriptionHTML": "<p>Creates a new discussion post on a team's page.</p>\n<p>This endpoint triggers <a href=\"https://docs.github.com/enterprise-server@3.14/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits\">Rate limits for the API</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api\">Best practices for using the REST API</a>.\"</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>POST /organizations/{org_id}/team/{team_id}/discussions</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -526013,13 +526013,13 @@
}
],
"previews": [],
+ "descriptionHTML": "<p>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.</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ],
- "descriptionHTML": "<p>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.</p>\n<p>You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see \"<a href=\"https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products\">GitHub's products</a>\" in the GitHub Help documentation.</p>"
+ ]
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
diff --git a/src/rest/data/ghes-3.16-2022-11-28/schema.json b/src/rest/data/ghes-3.16-2022-11-28/schema.json
index 48a9084232f3..ae30d837807f 100644
--- a/src/rest/data/ghes-3.16-2022-11-28/schema.json
+++ b/src/rest/data/ghes-3.16-2022-11-28/schema.json
@@ -1228,13 +1228,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets the total GitHub Actions cache usage for an organization.\nThe data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>read:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -1554,13 +1554,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets GitHub Actions cache usage policy for a repository.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets GitHub Actions cache usage policy for a repository.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -13114,13 +13114,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists self-hosted runners that are in a specific organization group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists self-hosted runners that are in a specific organization group.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -16058,13 +16058,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>Example using remove token:</p>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script to remove a self-hosted runner from an enterprise. The token expires after one hour.</p>\n<p>Example using remove token:</p>\n<p>To remove your self-hosted runner from an enterprise, replace <code>TOKEN</code> with the remove token provided by this\nendpoint.</p>\n<pre><code>./config.sh remove --token TOKEN\n</code></pre>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>manage_runners:enterprise</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -19923,13 +19923,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Gets a specific self-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Gets a specific self-hosted runner configured in an organization.</p>\n<p>Authenticated users must have admin access to the organization to use this endpoint.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -22428,13 +22428,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to configure your self-hosted runner:</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Returns a token that you can pass to the <code>config</code> script. The token expires after one hour.</p>\n<p>For example, you can replace <code>TOKEN</code> in the following example with the registration token provided by this endpoint to configure your self-hosted runner:</p>\n<pre><code>./config.sh --url https://github.com/octo-org --token TOKEN\n</code></pre>\n<p>Authenticated users must have admin access to the repository to use this endpoint.</p>\n<p>OAuth tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -24719,13 +24719,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists all organization variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists all organization variables.</p>\n<p>Authenticated users must have collaborator access to a repository to create, update, or read variables.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>admin:org</code> scope to use this endpoint. If the repository is private, the <code>repo</code> scope is also required.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -80978,13 +80978,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: <a href=\"https://github.com/notifications\">https://github.com/notifications</a>.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Marks a thread as \"done.\" Marking a thread as \"done\" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Server as done: <a href=\"https://github.com/notifications\">https://github.com/notifications</a>.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -126176,13 +126176,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see <a href=\"https://docs.github.com/enterprise-server@3.16/github/getting-started-with-github/githubs-products\">GitHub's products</a> in the GitHub Help documentation.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -196284,13 +196284,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Create a new snapshot of a repository's dependencies.</p>\n<p>The authenticated user must have access to the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Create a new snapshot of a repository's dependencies.</p>\n<p>The authenticated user must have access to the repository.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> scope to use this endpoint.</p>"
}
],
"sboms": [
@@ -196786,13 +196786,13 @@
}
],
"previews": [],
- "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -198058,13 +198058,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Simple filtering of deployments is available via query parameters:</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Simple filtering of deployments is available via query parameters:</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -212426,13 +212426,13 @@
}
],
"previews": [],
- "descriptionHTML": "",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": ""
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -212891,13 +212891,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Note that this API call does not automatically initiate an LDAP sync. Rather, if a <code>201</code> is returned, the sync job is queued successfully, and is performed when the instance is ready.</p>",
"statusCodes": [
{
"httpStatusCode": "201",
"description": "<p>Created</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Note that this API call does not automatically initiate an LDAP sync. Rather, if a <code>201</code> is returned, the sync job is queued successfully, and is performed when the instance is ready.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -418020,13 +418020,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>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 <a href=\"https://docs.github.com/enterprise-server@3.16/rest/pulls/reviews#list-reviews-for-a-pull-request\">List reviews for a pull request</a> operation.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>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 <a href=\"https://docs.github.com/enterprise-server@3.16/rest/pulls/reviews#list-reviews-for-a-pull-request\">List reviews for a pull request</a> operation.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -433971,13 +433971,13 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#get-a-discussion\">team discussion</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "204",
"description": "<p>No Content</p>"
}
- ]
+ ],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team or organization with <code>team_id</code> and <code>org_id</code> using the route <code>DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id</code>.</p>\n</div>\n<p>Delete a reaction to a <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#get-a-discussion\">team discussion</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -440439,13 +440439,13 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n</div>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#get-a-discussion\">team discussion</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/reactions/reactions#list-reactions-for-a-team-discussion\"><code>List reactions for a team discussion</code></a> endpoint.</p>\n</div>\n<p>List the reactions to a <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#get-a-discussion\">team discussion</a>.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -443218,13 +443218,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>View the latest published full release for the repository.</p>\n<p>The latest release is the most recent non-prerelease, non-draft release, sorted by the <code>created_at</code> attribute. The <code>created_at</code> attribute is the date of the commit used for the release, and not the date when the release was drafted or published.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>View the latest published full release for the repository.</p>\n<p>The latest release is the most recent non-prerelease, non-draft release, sorted by the <code>created_at</code> attribute. The <code>created_at</code> attribute is the date of the commit used for the release, and not the date when the release was drafted or published.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -463915,13 +463915,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -531654,13 +531654,13 @@
}
],
"previews": [],
- "descriptionHTML": "<p>Get a specific comment on a team discussion.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<p>Get a specific comment on a team discussion.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nYou can also specify a team by <code>org_id</code> and <code>team_id</code> using the route <code>GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}</code>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>read:discussion</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
@@ -537954,13 +537954,13 @@
}
],
"previews": [],
- "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#update-a-discussion\">Update a discussion</a> endpoint.</p>\n</div>\n<p>Edits the title and body text of a discussion post. Only the parameters you provide are updated.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
"description": "<p>OK</p>"
}
- ]
+ ],
+ "descriptionHTML": "<div class=\"ghd-alert ghd-alert-attention\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z\"></path></svg>Warning</p>\n<p>\n<strong>Endpoint closing down notice:</strong> This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new <a href=\"https://docs.github.com/enterprise-server@3.16/rest/teams/discussions#update-a-discussion\">Update a discussion</a> endpoint.</p>\n</div>\n<p>Edits the title and body text of a discussion post. Only the parameters you provide are updated.</p>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>write:discussion</code> scope to use this endpoint.</p>"
},
{
"serverUrl": "http(s)://HOSTNAME/api/v3",
diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json
index 2a20f0a9855c..6cade8b556c3 100644
--- a/src/rest/lib/config.json
+++ b/src/rest/lib/config.json
@@ -47,5 +47,5 @@
]
}
},
- "sha": "042ebdf85f1f5234751ac9603b977c9929e72c66"
+ "sha": "c52348cd88be16e613e49c26b39d2653e20b817d"
}
\ No newline at end of file
diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json
index 85e55a87ecc7..d6a740c0786c 100644
--- a/src/webhooks/lib/config.json
+++ b/src/webhooks/lib/config.json
@@ -1,3 +1,3 @@
{
- "sha": "042ebdf85f1f5234751ac9603b977c9929e72c66"
+ "sha": "c52348cd88be16e613e49c26b39d2653e20b817d"
}
\ No newline at end of file
From 9de26352ab51ccac6587c6cb3908f8daaa1a9ec9 Mon Sep 17 00:00:00 2001
From: Kevin Heis <heiskr@users.noreply.github.com>
Date: Mon, 30 Jun 2025 13:34:55 -0700
Subject: [PATCH 11/12] Consolidate octicon frontmatter property references
into single file (#56342)
Co-authored-by: Robert Sese <734194+rsese@users.noreply.github.com>
---
.../components/CookBookArticleCard.tsx | 40 +----
src/landings/lib/octicons.ts | 66 ++++++++
src/landings/tests/octicons.test.ts | 148 ++++++++++++++++++
src/landings/types.ts | 42 +----
4 files changed, 223 insertions(+), 73 deletions(-)
create mode 100644 src/landings/lib/octicons.ts
create mode 100644 src/landings/tests/octicons.test.ts
diff --git a/src/landings/components/CookBookArticleCard.tsx b/src/landings/components/CookBookArticleCard.tsx
index 51823f00f015..629382593343 100644
--- a/src/landings/components/CookBookArticleCard.tsx
+++ b/src/landings/components/CookBookArticleCard.tsx
@@ -1,37 +1,7 @@
import { Label, LabelGroup, Link } from '@primer/react'
-import {
- BugIcon,
- LightBulbIcon,
- CodeIcon,
- GearIcon,
- RocketIcon,
- BeakerIcon,
- CopilotIcon,
- HubotIcon,
- LogIcon,
- TerminalIcon,
- BookIcon,
- ShieldLockIcon,
- LockIcon,
-} from '@primer/octicons-react'
+import { ValidOcticon, getOcticonComponent } from '../lib/octicons'
-const Icons = {
- bug: BugIcon,
- lightbulb: LightBulbIcon,
- code: CodeIcon,
- gear: GearIcon,
- rocket: RocketIcon,
- beaker: BeakerIcon,
- copilot: CopilotIcon,
- hubot: HubotIcon,
- log: LogIcon,
- terminal: TerminalIcon,
- book: BookIcon,
- 'shield-lock': ShieldLockIcon,
- lock: LockIcon,
-}
-
-type IconType = keyof typeof Icons
+type IconType = ValidOcticon
type Props = {
title: string
@@ -69,11 +39,7 @@ export const CookBookArticleCard = ({
url,
spotlight = false,
}: Props) => {
- const setIcon = (icon: keyof typeof Icons) => {
- return Icons[icon] || CopilotIcon
- }
-
- const IconComponent = setIcon(icon as keyof typeof Icons)
+ const IconComponent = getOcticonComponent(icon)
return (
<div className="m-2">
<div
diff --git a/src/landings/lib/octicons.ts b/src/landings/lib/octicons.ts
new file mode 100644
index 000000000000..c43d4b0d8e9a
--- /dev/null
+++ b/src/landings/lib/octicons.ts
@@ -0,0 +1,66 @@
+import {
+ BugIcon,
+ LightBulbIcon,
+ CodeIcon,
+ GearIcon,
+ RocketIcon,
+ BeakerIcon,
+ CopilotIcon,
+ HubotIcon,
+ LogIcon,
+ TerminalIcon,
+ BookIcon,
+ ShieldLockIcon,
+ LockIcon,
+} from '@primer/octicons-react'
+
+/**
+ * Mapping of octicon names to their React components
+ * This is the single source of truth for all supported octicons
+ */
+export const OCTICON_COMPONENTS = {
+ bug: BugIcon,
+ lightbulb: LightBulbIcon,
+ code: CodeIcon,
+ gear: GearIcon,
+ rocket: RocketIcon,
+ beaker: BeakerIcon,
+ copilot: CopilotIcon,
+ hubot: HubotIcon,
+ log: LogIcon,
+ terminal: TerminalIcon,
+ book: BookIcon,
+ 'shield-lock': ShieldLockIcon,
+ lock: LockIcon,
+} as const
+
+/**
+ * Valid octicon types derived from the component mapping
+ */
+export type ValidOcticon = keyof typeof OCTICON_COMPONENTS
+
+/**
+ * Array of all valid octicon names for validation, derived from component mapping
+ */
+export const VALID_OCTICONS = Object.keys(OCTICON_COMPONENTS) as ValidOcticon[]
+
+/**
+ * Helper function to validate and cast octicon values
+ * @param octicon - The octicon string to validate
+ * @returns True if the octicon is valid, false otherwise
+ */
+export function isValidOcticon(octicon: string | null): octicon is ValidOcticon {
+ return octicon !== null && (octicon as ValidOcticon) in OCTICON_COMPONENTS
+}
+
+/**
+ * Get the React component for a given octicon name
+ * @param octicon - The octicon name
+ * @returns The corresponding React component, or CopilotIcon as fallback
+ */
+export function getOcticonComponent(octicon: ValidOcticon | undefined) {
+ if (!octicon || !isValidOcticon(octicon)) {
+ return CopilotIcon
+ }
+ return OCTICON_COMPONENTS[octicon] || CopilotIcon
+}
diff --git a/src/landings/tests/octicons.test.ts b/src/landings/tests/octicons.test.ts
new file mode 100644
index 000000000000..0ea8baa126f8
--- /dev/null
+++ b/src/landings/tests/octicons.test.ts
@@ -0,0 +1,148 @@
+import { describe, expect, test } from 'vitest'
+import {
+ ValidOcticon,
+ VALID_OCTICONS,
+ OCTICON_COMPONENTS,
+ isValidOcticon,
+ getOcticonComponent,
+} from '../lib/octicons'
+import { CopilotIcon, BugIcon, RocketIcon } from '@primer/octicons-react'
+
+describe('octicons reference', () => {
+ describe('VALID_OCTICONS', () => {
+ test('contains expected octicon names', () => {
+ // Test that we have the expected number of octicons and they're all defined
+ expect(VALID_OCTICONS.length).toBeGreaterThan(0)
+ expect(VALID_OCTICONS).toEqual(expect.arrayContaining(['bug', 'rocket', 'copilot']))
+ })
+
+ test('all octicons are strings', () => {
+ VALID_OCTICONS.forEach((octicon) => {
+ expect(typeof octicon).toBe('string')
+ })
+ })
+ })
+
+ describe('OCTICON_COMPONENTS', () => {
+ test('has components for all valid octicons', () => {
+ VALID_OCTICONS.forEach((octicon) => {
+ expect(OCTICON_COMPONENTS[octicon]).toBeDefined()
+ expect(typeof OCTICON_COMPONENTS[octicon]).toBe('object')
+ })
+ })
+
+ test('maps specific octicons to correct components', () => {
+ expect(OCTICON_COMPONENTS.bug).toBe(BugIcon)
+ expect(OCTICON_COMPONENTS.rocket).toBe(RocketIcon)
+ expect(OCTICON_COMPONENTS.copilot).toBe(CopilotIcon)
+ })
+ })
+
+ describe('isValidOcticon', () => {
+ test('returns true for valid octicons', () => {
+ expect(isValidOcticon('bug')).toBe(true)
+ expect(isValidOcticon('rocket')).toBe(true)
+ expect(isValidOcticon('shield-lock')).toBe(true)
+ })
+
+ test('returns false for invalid octicons', () => {
+ expect(isValidOcticon('invalid-octicon')).toBe(false)
+ expect(isValidOcticon('pizza')).toBe(false)
+ expect(isValidOcticon('')).toBe(false)
+ })
+
+ test('returns false for null or undefined', () => {
+ expect(isValidOcticon(null)).toBe(false)
+ expect(isValidOcticon(undefined as any)).toBe(false)
+ })
+
+ test('provides correct type narrowing', () => {
+ const testOcticon: string | null = 'bug'
+
+ if (isValidOcticon(testOcticon)) {
+ // This should compile without type errors
+ const validOcticon: ValidOcticon = testOcticon
+ expect(validOcticon).toBe('bug')
+ }
+ })
+ })
+
+ describe('getOcticonComponent', () => {
+ test('returns correct component for valid octicons', () => {
+ expect(getOcticonComponent('bug')).toBe(BugIcon)
+ expect(getOcticonComponent('rocket')).toBe(RocketIcon)
+ expect(getOcticonComponent('copilot')).toBe(CopilotIcon)
+ })
+
+ test('returns CopilotIcon as fallback for undefined', () => {
+ expect(getOcticonComponent(undefined)).toBe(CopilotIcon)
+ })
+
+ test('returns CopilotIcon as fallback for invalid octicons', () => {
+ // TypeScript should prevent this, but test runtime behavior
+ expect(getOcticonComponent('invalid' as ValidOcticon)).toBe(CopilotIcon)
+ })
+ })
+
+ describe('type safety', () => {
+ test('ValidOcticon type includes all expected values', () => {
+ // This test ensures the type system prevents invalid octicons at compile time
+ // Test a few key octicons to verify the type works correctly
+ const testOcticons: ValidOcticon[] = ['bug', 'rocket', 'copilot']
+
+ testOcticons.forEach((octicon) => {
+ expect(VALID_OCTICONS.includes(octicon)).toBe(true)
+ })
+ })
+ })
+
+ describe('consistency checks', () => {
+ test('OCTICON_COMPONENTS keys match VALID_OCTICONS', () => {
+ const componentKeys = Object.keys(OCTICON_COMPONENTS)
+ const validOcticonsSet = new Set(VALID_OCTICONS)
+
+ componentKeys.forEach((key) => {
+ expect(validOcticonsSet.has(key as ValidOcticon)).toBe(true)
+ })
+
+ expect(componentKeys).toHaveLength(VALID_OCTICONS.length)
+ })
+
+ test('no duplicate octicons in VALID_OCTICONS', () => {
+ const octiconsSet = new Set(VALID_OCTICONS)
+ expect(octiconsSet.size).toBe(VALID_OCTICONS.length)
+ })
+ })
+
+ describe('single source of truth', () => {
+ test('VALID_OCTICONS is derived from OCTICON_COMPONENTS', () => {
+ const componentKeys = Object.keys(OCTICON_COMPONENTS).sort()
+ const validOcticons = [...VALID_OCTICONS].sort()
+
+ expect(validOcticons).toEqual(componentKeys)
+ })
+
+ test('ValidOcticon type matches OCTICON_COMPONENTS keys', () => {
+ // This test ensures the type system is correctly derived from the object
+ const testOcticon: ValidOcticon = 'bug'
+ expect(OCTICON_COMPONENTS[testOcticon]).toBeDefined()
+
+ // Type check - this should compile without errors
+ const allKeys: ValidOcticon[] = Object.keys(OCTICON_COMPONENTS) as ValidOcticon[]
+ expect(allKeys.length).toBeGreaterThan(0)
+ })
+
+ test('adding new octicon only requires updating OCTICON_COMPONENTS', () => {
+ // This test documents the single source of truth approach
+ // If you add a new octicon to OCTICON_COMPONENTS:
+ // 1. ValidOcticon type automatically includes it
+ // 2. VALID_OCTICONS array automatically includes it
+ // 3. All validation functions work with it
+
+ const componentCount = Object.keys(OCTICON_COMPONENTS).length
+ const validOcticonsCount = VALID_OCTICONS.length
+
+ expect(componentCount).toBe(validOcticonsCount)
+ })
+ })
+})
diff --git a/src/landings/types.ts b/src/landings/types.ts
index 36f849c0b7cf..e468cc891134 100644
--- a/src/landings/types.ts
+++ b/src/landings/types.ts
@@ -1,3 +1,9 @@
+import { ValidOcticon, isValidOcticon } from './lib/octicons'
+
+// Re-export ValidOcticon and isValidOcticon for compatibility with existing imports
+export type { ValidOcticon }
+export { isValidOcticon }
+
// Base type for all TOC items with core properties
export type BaseTocItem = {
fullPath: string
@@ -5,22 +11,6 @@ export type BaseTocItem = {
intro?: string | null
}
-// Valid octicon types that match the CookBookArticleCard component
-export type ValidOcticon =
- | 'code'
- | 'log'
- | 'terminal'
- | 'bug'
- | 'lightbulb'
- | 'gear'
- | 'rocket'
- | 'beaker'
- | 'copilot'
- | 'hubot'
- | 'book'
- | 'shield-lock'
- | 'lock'
-
// Extended type for child TOC items with additional metadata
export type ChildTocItem = BaseTocItem & {
octicon?: ValidOcticon | null
@@ -54,26 +44,6 @@ export type RawTocItem = {
childTocItems: RawTocItem[]
}
-// Helper function to validate and cast octicon values
-export function isValidOcticon(octicon: string | null): octicon is ValidOcticon {
- const validOcticons: ValidOcticon[] = [
- 'code',
- 'log',
- 'terminal',
- 'bug',
- 'lightbulb',
- 'gear',
- 'rocket',
- 'beaker',
- 'copilot',
- 'hubot',
- 'book',
- 'shield-lock',
- 'lock',
- ]
- return octicon !== null && validOcticons.includes(octicon as ValidOcticon)
-}
-
// Simplified TOC item type for basic landing pages that don't need extended metadata
export type SimpleTocItem = {
fullPath: string
From a006fa0f832419b2dea4034fbce97e0045c857ce Mon Sep 17 00:00:00 2001
From: docs-bot <77750099+docs-bot@users.noreply.github.com>
Date: Mon, 30 Jun 2025 14:09:32 -0700
Subject: [PATCH 12/12] Delete orphaned files (2025-06-30-16-29) (#56386)
---
.../code-review/vscode-review-button@2x.png | Bin 20176 -> 0 bytes
.../code-scanning/codeql-query-tables/rust.md | 15 ---------------
data/reusables/emus/oauth-app-note.md | 6 ------
3 files changed, 21 deletions(-)
delete mode 100644 assets/images/help/copilot/code-review/vscode-review-button@2x.png
delete mode 100644 data/reusables/code-scanning/codeql-query-tables/rust.md
delete mode 100644 data/reusables/emus/oauth-app-note.md
diff --git a/assets/images/help/copilot/code-review/vscode-review-button@2x.png b/assets/images/help/copilot/code-review/vscode-review-button@2x.png
deleted file mode 100644
index 3760819de4d3e853c72db4261e724f2603cac2c3..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 20176
zcmbTd1yEeUvpz}!K^6$QcpzACCrGd$!Cis|SX_g<%L2h6!QI{6VQ~)*!9BRU{ZD@P
z-g>WIy?RymZLzhx!#OiO-93H2?)m12qPzq;hzJA+2Zt^tDW(hu2VV{c_v$P1YoKN4
zle#M$oP2_mn6RqrtHb$MK~P29{&mg8h%o<aoX-fa{NsPezD6(zU0*>TNkr;KXbmg4
z@j~SxS=)VyS;dBflZ3#*tpwmA!oks@!TJ98C!8_?99%BzfBiQa1_$>Z`U>td2>yS6
zL8qzGU1a2D<6;5OrGEOZ;`DfzC!gF@pijQ}kov6C^36Ap9z5KwyB0H5AAv{+lwW=u
z-!^@>nvpI~M`W@7EULH|Rxxbdc=FI(-fy>5F9%4WQx-l>r`FBZCovg!e*jkI$(wfi
zh72JH()q*fVcKQXQ1v*0fxnYDJTd|?kq=*IOiW5javOan?jE^#^IX7x<(;Rzs<u^y
z*Sfen(H`SS9dR5H>F%!8;&QUXiK==#%Doyc)8e>S?Q){4zCLvOaMIE7e1C90&h7Jf
z)*nI4?frbW`#b&ite>po<@w>dslw;^E*Oc2ONnOH?(uw>MaPlZ%a)|yP6x_Y0`j@v
zD@dJ&$Kd}xJ&j9myf>NWvg+m1ity&i`Eb5!@Fz{p>oY_Dsd8AufrHKjO}eYW>5J?2
zg6YBje#m36R_1U-L`05w#N@qb@LR8!ryGS-9xOCHudA6b?xKo{1_f1?wo7H5X6r?+
zx)P<|Fs$$MmFtsvGFgOg-+k&4jeTq06N1HGSf*JcKB;+nr^)qwiGWe+0sC@mD2{<f
zK6PMd1B$OZ-|WO-pQ@eI=SrpHuRq`9V5%b>e4ww(*!BGMU{m0skRd2wJcP^acwIU;
z+w6R##cGDHU2laFxyd8n4^wlUDOQ^hHfB+)G94!s<T61?*lP$1LYx&&L!oK`(b!)f
zYD!tZoj%&1DQUW5qrZ!OvpU-JP7oKr4Nw=CSTQ<2lUD9^7qnEP3g$hwo8hyvbiXw<
zus7`ae7H~(K<=hzyFC<#g7aZMZicC;^4|XqYVCCKR<-f)21U7+Ro607g8p)|llgMk
z>Uf4whyKrZe9l{36BJx%qiZ~X`+=rHta|h#8g18MiEM@hV%8b-vIzU>9>?q9RA_3#
zg)!j}LAU$Mz53PA%_$6_$J2&Y?*sbOSe1;h3xTU?l?6P56Y_4rR_2UBzII{7teF8#
z64@J9yr}4ZX^L#`+Y{HMD)4MX(9+8bi(opau=27ZSiMIRCnui6>6)-Qq~DIDAQx2P
zIp1ivsWDxq-Edg;6JkO1aCH!j-oOpcckIrI5*%7@d%9lCvLJx${3PULCX<`fXS9@0
z`&4IG%vzL$B5Xr(ZT3BhhM3{A5t=FVWTQ9i+$4Q+`gx4+M8A)Rq&&VRkHd6KH5;a}
zN5;+T^UNPq=Imdpb+^>y(3JT>;R^yg;eo_~r8x7<K*011p(H*^(3V$>YIL2E{UQqS
zW`Cf^gbs0790*k~i9tCN_9$81|1!cc-UGgskg88(Q5LzWCTB7jOXW>q(cAfD*e-TW
z9(rL9b|&dJuW+)MGA9S`9CsfDT}zO<ZA}-ckaq))&TYH)dBOHU3G#iF1RJR@=3rI_
zJVMzFESo#qD?}^<`S=3@#y*Al)AonsoR&|SAcbVkAGnz3Jfh}!%sP@$(IZ;<(;202
z*hZ!4qxc3GBzq<rOEb1rJ&u=}v_3iPjDS?<L#BysTC=_YW)rn~JggZ%yuVMPyV<Op
z(`|XDB(sR$k!0n0bANR}-o4%(T=%QrpajPC`@7ow`4B@z5BTq0G<lha)YaFVeV+aE
zGlJs0T%Hz?3l&NKnYlx9y;>8<VTwxEkiW4rXi*nxr-#Nvsw^{onZ|9S`|B{eXG%e6
zbVqC!kQ}Gc*xSI3Shv-c&8zDtf>dV~9LM!&c<+vh*8&_(mheHHj*vMS8PFkz@FZe-
zocHG*EiRVCp+2QoMUtLBroJ$l>n%(}>n!IG;m6Um{C=0JLF~2$V)oS<#crzckL2Ic
zB8OVyq^IdX7m<L4SFED_iYW^=(oA={mWs}i|A$mHaghW`)EQwjFH70+Vduh-%kXtL
zSIu2XMf;x#RgHB~5M4qQ#E}axiBgqR`txXT7olPsA%}@AVd<W~_zK&yB5JIvtVR_D
zm<tKBE?n5H>~Y281Zr=F6Kn5GXpw*-^9O%I$FiAXcj#A8H0Xd+I3Z{x0#6OH*yafR
z_>Elss}{7Ra+4=gMI5>*Td~sSp^{dUsc*@MCw^Nrs+RamBr<TpKABjBm+gu|ydC?!
zY24_;^^x}aVP_%2M+LXlb}z;^&&Y^e5Ycp_0meeBKP2BSGPqhj@9aUgYh4=ZcdsYN
zd>-u_raCH_tv)gc^hQ$4z~}p{w1X~)z~u;-w$x!u7KC(27Dh%{tss1TpLmpq>T$%6
zDh)rDEZ-EDNkQX23Ojyfi0<sXDprIt?CC~IzdoWr1SCdOhn(y6N4}FW%n<ZyJi>Ej
z{o37DZ4Zur6NlE=_u8~sr2)Z?i&U*Z1Y33~6bDoEOAlehXV&t3nV!5yEHo?ZgzJ;l
z4kGYZCSztF2d<Ir^-mLTlDEG;d-w)f2&VpC;^9r5gil88FjW1csJAr4AepH{q(JUo
z=G=FqtqR4tzFH3^v%q=q7?zXnwkrcM*a$bLmcme$hcV8D6q4YYX6^p1G&^bel+71=
z${H?4j7Wom0j)avM<8Bem(%~0?-XDgGof@O(889FZ##{Setcb;*f9~KMi5CRB)`mK
z*<GSu5syS8L||8ybl*1z!&_Ij`)Pn;*ea?W^F^x+WQnW0cX0-@oTxRQ65*}3n{`6e
zCg3sFGa1tyRaa89gvs*_7qKP;l}}kr9#DbhPjuOPMVaQsBo6*ZgUiN27-XcuS2YVi
z&{QYqb0jd@Zj0=}Ci6I11}qCn{CFe+MEe)xLaUP%Kk{(qvE1I0qu{d1?;TX4VEYRW
zEwHL%VH^W)qvp00=$GV?@J>AHs8vWL;^VHoGMPGqS!f(*<e*Xg_Ym|?e{^(X&Gr=U
zGQ63Z;@GbA*VJpzKeQ4cUdZFu<$AHjsH99ka*ZT^lwpW&uvXJ}mq+T$36?+5W!g9g
z?<%Os!PIUe`|L<ExPp!A^Fbx|-prjYmwzXO0}$!dGPS^X2XhrsHu;q{I4XEZ+`_Yj
zTvmzxbxcTAlGk4*CZiE1WV!lZed=Z4s)T&_CQiH~veCuQo9D(lJL8H&*WuqIoutT_
zunZ3T!d84JGiUK9U3zi<$X`qBUcyf@rZBn85sUrw8N##y9}pd)j$0!;kKa*#Sn_~t
z^HnQKOod~n6m&rC6IWtuck`#3T=txS0IBm~F$%;7toxn;(&jIfyR)hgI*F#feFrF=
z_mE#qoh;liDcmc;_{oS?1m;@)CGmxKA16ex&&-;#TtMKU{QM7-!j+J}3pJ+pv2{EA
z<n7Yt18p+?$aYp+Pn}B3zZRv7<sO?cC#EUPvp+l*rO}Xzj1f8h=I39_0f~Wv$Fy>O
zX_31#DMzwP^yb9jDOvJ<n~uFUrrb`f&E88D{GnKHRH3$RwU;!c*4XHw_NZa|k#~W|
z5mTl6jhc-P^j*JQsy%(GJd}Rqsa(B6mqgpk%j-K<g<yV~MLmJK8TdErN{rte^&u8{
zR`VO)Q8Y>yJTRi}%}kx8dh93;|NKtz(9Hh+ej<HAybhRE*?guPa<&u(y|Tcd?l5Ia
z>cBEUF{n2Zu993&u%MYFVXy3;XD*XC%P|eJ0$J626$)z(Q&{T_C5J@#CmV}}I4Cnb
zFe*aQ@hW#!|GBa;O-U&+zCc2y@Kr3_wtJ#FIpV*E_Rk_#wXZKjm}ow6IrQMKJ;4)B
z{L1E`pDUx_^S@2GY9X1N_j;mzDH`q^qLhd<5<Ms7TMA3iCOr&|BwpgrP2b{LA1u=M
zQeL(uVyiB9L`9`98u5FrZkSf;ZJgmj+gOs^h&Ro2<NL7@(*g-mX21Q{Cxe)YVq`}@
zP|1c^F{r?WCAoYlDmnUtaABh-1_RBA9ZCNlBfXWGnc2YDI~a}`qZE|Bl%l@}&rpPw
zvNMs5X%<O~oRx&;BBsf`<YSc7cPXhYTkvcTAITUV&U>Mc1O|~TpUmPS2ePqskI;BU
zI%1iiswg6h5@cn*xLh}%IJri61?WIcHTo{DTzZTTciTsLREIK(s6kT=583Qtxl@Q{
zKzL%+%Y-2;AMw{O9_p53@%CK11?>f(G2$M=GE+Cl{DFtSMK8YIG^dtGYqDrXAN#4_
zOuG^<UiF&%=+mbmTA$#0U#aUYNn1E0vw<SeMpuX!ntlyLvQJIpOn#>v!j-FwNy(@(
zk_35!*m85cEQ9@KF30E&TQ*tK{g7D|U5I|t_|_9di5bczbz|Mi(icSFlNI~}2Z#SF
z%_^O3<Rgba5*1>2VO2I=!x1K6$zU=6bNeElm04kWMvVMl8pMbn2TiD$c>2EHot$m<
zOUT*agvj=CyJKQ8Nc!is7+e`oYpSe#`{%bn)ICN6i|_miKstzPJ1gWN_;T<E<R7jy
zWM>daz}xpD$yNb3R#i$liLlvJi4ie@#eDl;MEs|NIVS8(CpFhj-&aRH0UwD&2hZFq
zBo;+7JWsojaG|u4i94ehLnDs=3GF2PO&rnVV2?^s3u+vXM9lHhc8%L4>}J_8z1G{8
zg(`S-H5hATcY-qy+bhiXB7ceO%QNA>UV}gy`tY^Q0lra~g&;F-gWxX<CVEb9tm92~
z-5$?g>B4*Om{)0R<xv7j9Q~gzAmj7hbNq8~<;eO!Y2N>Q{!0e`SLt5oiS&By(2KxH
zO@D(BMuqz52=HQLXE$IklTL)$)gp6oaB$Qt2Jn;(#lvDw?c86%!L3%m+&;dXlS&an
zG^=qVy%T`^a!I2*fvlTaW}Qb1$nR`(WYnYqQKZHHzf#Vnv_YduGtNIp*Pen2FklLq
z^v*5c+H_w$W-aRE3x49p10Bb)5=Bt>r;M5uO#P6MmIBEDlb8PM+@jRky>81&(37)z
zvg!o1M)n(i;v;$c<}r8Mo|iOg?!c+b%cpO_DqeZ$q7|;O&!lFsy7X&_b;Bad^;maa
z6jkV^4+KO#*n#Pek_Cm!64UbiEQyKr>VYowUGEAOacC&GE7YJD1iJBKxzTW*eHx8$
zG2Plh9XLLGkaN2*+2ONUDK9B0QC!Do(M?TFMKHlHI=#K+;qW#!-90<A6JC#t15?H5
zX=`7wP#8Em))p3qlxfo^BT*h7A2TyCSzB4@=;%25gghP|S^<GnQ&Uq<FT?V$qn;@<
z?fpy6ZpgubB_p~gfUXFSS`r(L%K7;CmcCnA{k;ZWcg0l=4GAAc#>X8-2h_r@Z*Jr=
z+uG772p)7EC@Cl?HoAi`ey@@VdH=m0PGDK`e!Bn2+9C;Eha_LF8{NhJuGZ`DmU0CG
z5XVbMO$`T~+;A(z#U%k6@7O&sAi3XAnkMB3fT03s#@`3oI=?%*J_e^@U|=XHC<qPi
z_+`({&5^~)<iftIKgaX%@F>>p?(EcdO&#_2_Fm+{h?dLB%5*rc<FeZRmZAG%=b*0Q
zU}0ftYik1n1>UxM+#H{uEB}y?kYLekr#idX9XB9a2~nM2SH2TW937Q2q5!`Qv6e7Y
zQ&TIt92%0Iw7apF|1&W`-upp8#_l~GmJcgZ5ipcaLv3y2a)0(iKm6bQeNZ{C5RJpo
z(@9)@P_UX{`e6=t<ale#`JUgDsz7;7Oi>ZtvWQfMZbX*;rZf(Z=+s@5)~`<r2YY+u
zRk^ua&(DH1B_Sape|PkoZ!h<7?65Yvif*=Som;)1k|mHohae#$zHT^+0qu794G8Pz
z!XTEdCE8Z1d$--cVD@IJpA!=k-{&<qYc(`V_PQ@02dM2%lPj->tfqoee12gvekWvX
zZfj}rX#X@vNK}&G$z_4{_6-iJO_fZ{KZBt)b|b$D+IhVZ@FOf*hzELc;h>u?`Z?BS
zrM0VU?VDsSj5K(!{_D01gn)FlnUA0U66KsvK;TPbCf^n?_YCQ-C-l2$Vz>L&9`VFi
zaa%BnFQxsgTKk{n8m}ZGeZu(T#vsAUnO;jD&>K2Bga|)Y)z<bf8LpA#!fH{~GMnL^
zaer^Zv9&HIPHh&k(i>9>?{#72agqd_RWWA=@RUkmN4O=UyHT9X9_{P|IX=5PV`g5e
z8c*BlJX)&qw62?hJ@l2|B1?AS4<Er`{@+pKMV6N)<eJeKJHDk~D4d=u9WJb`>C6AZ
z)fY>--~na~dy|W2@c<MjnwvlEG<ZVtEd?36BxWy*>N>t@<id_+t$m|`>DDUHP#arV
zT9OMS5hnl@3Dloz(Z0k?{jou!Uk(C&6R0`nW9De;_K~;3X~40+28%WAquDsQxpO!p
zv2lN-#F}nW2U&Ewpi*C{+sMhGchIx2xR6PG!<9Co!U_~qq<w~*v4pg*h40dtl1&m!
zba$yHrsWNAijfHXg;UR5qM8Wi*baX8aKn=}Ou2&jXK_&!LuZ%qaXv`9ylEDVR&0Uj
zce?BV4(F`<tX6PLOKs4vsw%drxFS@dOGO#GR|b9`!sE>nbbLn?rL@`gGBvA7V|e4(
zHVY2GVyJC>*s=NYa*~elHmt<s<&Kyuw#a%zR0CbXmXm>7W43N?nhi;_VXQNiD1nIC
z8iWceDnGHQlkUc7QGbZ%`3Y~mwNNqaJjF6Pnil5xK}GnHj%|Uw$@se!pk9g|OCTA0
zxY$+5?+292vjcIh@fHbXp#XpQs>a~~EXJMe0hPAbFzGdAhz_MzlJff)i6VGmspiDg
zR9Sn)vI^$R31kA-MTNcZ6Gc2ic$J}{AoW<h3FarNI{vW6#?wcdVAp4z52n7{f01X%
z{vy0+vVz6c`!beBvTzFr_|=kLzY=)6j-wWb0+^A+DG7adRYtnAbu(#xWo68=Lt-4Z
zGf_FLs`J~Wk!m?U7CuU6hHiQV`k3jj)Hxz@hxcj~+ir^7S)4n<k9=<-?k$YCJPbE;
zK(O5urAAM>_jS`Os=(->dqbXc;f5i94<-3pF`ND^vQ;pn_FE*XJ}$Z$XD;5sdI>Qx
zvD{A1^Zgly!m`dA3eKNfNRp=%@5*sj*(t#B6<9Cm_?=ERn4PAAh6y0icOw^KA7uYF
zA~sb*IR=?DSmMT73|O%TD2CG|u`R>XJ}fe9A)qLd%@Tx~n6u5r9C=&4^A}&M*uY}e
zb+~?Sh`9=8>fQ}y{i2;sAFY#O-D{iy7u9vHQESz-{ebbt$<oi4<W_JiMGWIqq}VT8
z)ie|*SMBc`g>~xEjmdG!qRP+dR$x|w)S?}ghEudjNZudb-$v!He!LR+ekqx3gzv}i
z$h$jFlsK;25KmrL7iC`Q0=rT8j%zJ25aS|jT7V_pOd!D+=Vxs2?YRAmUe`~(jC7dE
zC086_qI-|^-pB|Vi~#Q2&kbz??3w!Z&YKfu$X)E-dv<b$JPo-*c$IW?k{a=Z?rmpd
zK;iOw`e>?A<l-)g4AV5#@jIC$=p^L}<@`o%JZ6JG*T+ev=uGqr{r{Y!h{)vjTXR?u
ziTY+tVfj?M2=XeE$dR;>zK>^&fwOz%Oh(-EmYk=rLHvBk<+Dzw_ApXa2FW=`v7U=8
zU4eV^_K(%#f`aDaa|N~5@bK`*=cg9E$<b;ed{Qz!p46oBJnmP<OUQ5b5-h^SbFeCV
zI-h~;4k#4jJ2))pP!sI1zFolz!Y9JzBD(F5BI6y_W0n%60sR!5npsUjIM<TEqBn<M
zpLm6wX;j(QGGwmPdA8VKLlQK4iv2if!~L^fx%8W`Sw3zGit&hPcBRV9w5*Aj{YPz<
z{EnNP&-e@^Lul9?saUEp^(2(&jwTwfuV#@Fk8RGjr~<U(6Gq**zM1iA<pf`v;&DSp
zixGH><d36Aq^#F<C;ZZe20U^u9!Yj7vHsY2l^!~+q`+C|m!r~_Fzv5++ESeuHEwIH
zL;Z&nQh4HxdW;u5_PhzrehsRTygxfcO>1S2Mpw-?os9`+t|m$#%Sf|d@KqQ!<0Q%p
zjCMI$@oV+15VibS<n?%~6nqwn2))yZah~sRpWp+39~u{fSO<-j@i#ecFp|#}>JdkZ
z7V`U8{`g|7s39zklQoI!M@dWzsT%Ift0h-`+s;uxUZh|^&KwGhIHfLN8V}JOXy^Zp
zF2q#Zn2I}7=MTHi`1w;XI{MXWMB$9%t53SGB{0X8tS_U@^_-aI0^WOTPPV=hao^{U
z><aI2Ar;5v!lQT>Ea)Pogt@Oo+p2tOW`MzEdgn)b*f<wgL}=lE`X@Qgpg&sx!dYy$
zex^C}d1(&7gG9VuLo(f?@yiDAZ`*I0kf0w)iNN?_i57y28kR_{&!ijr>!0Cse8Omv
zJ2^E~u*(iM5GVx64dLzO1WY$2UHwCL@0-?P$!u8s!os+-hQZZ}brQJE4nBfU$}5lC
zt+0;tn7=mERI4p#;G>z-DUq;YsZS$#N*Xj~t|!<(?iYMuhN&C#3!Y<4RBP<t4`nQt
z-E-NE6V2_!AoyNHB4xyaKj);CB(hGmy4;M;*Y+`{JC$e;MUx${K1p&Jx>{TrNs}NF
zw33}-dLX9PmG(jVO_`2}(nFprC(Jm{(SwK+EA{z#S~uvKH!yupGi?(c3S6A{-hhZ%
zf1?_%mVyIxu7upa?Fz)S8+oQaS{j}<F6zLjK?n8big15cG&B|FC2<x_tv-91a2pW3
zzx4+jkiFbW1akj+h<L$%MTpr!z`$6rQ|~MQVySHu2vuG}g+jkQ`IB2nDIO=79tCoE
zE~2llCC#=hB{;r<zBB#-yT6T+SRcmK8Q{Z)9<}+w-uk)YA|CT9FjpQZxgMP@(5cv-
zdM~;?0>;6@M0+JFog23X?~}era<o01U^NJ--C8EX{qR>2Kg^^LI{pK891`?QM*n(E
zl+a@xBP>0a!CHpNmr>kNG>;K(QWJXPUQ?g8v6gmDlg;`@HYyUf1_pWT<tv^BmLxcr
z34|uuRTyk-%deNWP=G4xZmAUsIIR@t(Tty*8>5h*NYFCz1drJweMJ)#0vSClXj$G9
z2Tjg|S<gdpEc#Ej2#nni(W@Ok<31Aw3K`ew?urCM)AR&22iR3&kjDB*qz61Mp3VjH
z?A5*uq!0%o0`j@2xf}he5Z@`zZiGAi`Er%<AG!IJ^RhWD+ULm{U#4XjRD%0L_3fI1
zUw^P@+2VdouyFC4u2Xa^>%|a*@NeH>MC<3)a#S(DvD!d@!+&)n6a+hX(_xK^w}B!M
zyBTrUL;<?kVKZC<^mi3IJ5t$){pp#XP~vQB@aLx;pq}$5Sv&x?`0K>B_&{Dhr_%Jd
z38R!xdiY|+_w`U^K8on~0q?#*@JaVn@siOES($k$bFU~^25J!pS7&n<WFIsju5I5@
zP@g(!883~(^oXE@AKtZFjbTZCKrbCJ4oR<Xbw7+(n)l%GURWB<seFp(xK$($@cx3k
zV}jR;@=tRzn^y;OHmmI)&*p*xggkHI5MEAf&enn4!Gog|9V8RM>^Eso1sb+($`96C
z{|u8g2&%gzAkfFX(LH9%XY-ZhLF<B=YhEeK^f`HdnM5fN{sK{~Hp?6#{{F=~5{2<1
zo)*o)i2b7jsS541X~XZHop_R!RzF%q^S_tiKRv=VxI$<kJ|*T7rrKKprNmXzblFi(
zx5i-Z!RbWiitmansDE6@3+An}ZMlqduKZW|K`pOcr_3w-Ve)Rq^v%G!(u%JA%!BY<
z|MX^Wsvr}2L$s{?;qlI)<=srC?Uoy+0x>S)4l4$!Eb%FNq;589xUJJ@>Ti@7ed8+8
zo^*HKQV~cABPx3Lt1E4^Vy^CoOYFz^4Z~}lcp4C2iaxvN_On`cCE_F%whq1!Aq`Ro
z+AduG&915OT$IBv--?82_$8a90u<dF8ItTeV&uByQ3<CfXK~IRf2IVF%NB=V&Yowy
z4jRy+@+D{SH{VTqME6N<4StzzR-T29-k_9%#$Lp4Vc+2|c|O|N7oc2AL8AN6c|2dI
znI|kttmo6I0Pf_5>n!3c@k4&N77l7Zm0_91x;f~n86loCQN7aY27eVVq_Mv(dKWYS
z6p5b?Khhp9YQj%tR%*Us-}cx2RLP!$rToZ{=1GUFhS5PPm{+u@fv>4^lV}Q`KCt`&
zbn~~gVZ_2bS6E<h^fgH=>!k{XnP{oHtrV9YWoV_<@RbGeRO{~zOIkG9{=VS}UePhG
zOBkKTQ7o*Zz5VPQJ*QI6ttleGh7kG`l)+sQR+3q{XX$AHNcT6J_7T|W5?;qi(bT`T
zpF`=k#es5Y;LN2xgXKQ-39g>-@NtI>3Y;2`5$`8_$)~`>`zF1;Fht~sD$cuz!qqZs
z*U$(Ri#|{K0Smo%Wcl<Ii3XpW$Jbk5{vpN;Zxf$+*ZizrnOFA{x79@l-I@C)k*qfJ
z4OKbYhxI-*bqzB+EmMU)L}Lsi5P+|h#;r%J97Q|Pt&WVzFs}~3@toAOoTD=<V-3B_
zlKbmyDrNbBeD9|hr)=-qZ|0g_-n7^luI$PMbsZV$>(w;5qPL8V+0%%3r6osgZzB*K
zDLWi4gh*-m%5I4t+P-`&7ZhwO6+prU7M0@!97_9^Uh=T;dO#i}4h_Sk-6DZjDrX4B
zlOq>1+fJA8;B)gWU6n%wC8ne3-ssF>(j14%i@{fvEZzD0NIs#xaTPGdWX;Ecv6*-9
z{JEt9$Cw5h)@M$3-^N<$T6koxvfHoS*Yb_`c;#=npDMYGGyDI5ZIn^v?vO#G81E>p
z^#s*%G2}12HGTtuN9t|ho0nFrNTIv)Gv*XxKNVLsLk?3Fx)$ue`bi0++d6>ATdj(1
zznIxZ2qMHqySItcjVy9}9DWj-e@1?flOr2Ktnd5Lfao53&dGzTfsQajoU(7X)tPx0
zn-us8BR2_)=$LPTkGKYET$|ii9lk<;>HWLl5NO|jhI4-P3f@*f`t&Ucsw{$0ASYGM
zU*EsN8($_?e)4+?w&P>cJX$Ew6h{SZ{y8ZL_+t~v(03n}ai3@7OEz}EP5wIEqGegW
zU~154gN#MpQyZw{^ct{bjJK2@Jb2eEJYE<4>}F+57*-zIm7`z#l>JM&?fFCjE)ggo
z>4SEW;CumY1YADAhxo4+fCoXBN(Qu?b{$q312wA7<13~Q#%RMvDz~|dNx)sThif%q
zyNSQp7=OyGAGAd2p`D~rNyXy+WDhcqr_(80Pdr7e0vfJ~yVyP~y4ZH(j$y#T$pSU6
ze{WWxP}lj7ilG9~F#dlw3~)njPBL`i;4;0$KP1Bv4uW$oQeFzwUm_pKsHI}5dc(un
z2!FD#;zqLE+tyzrYsXSaDa#HK#1H1%%DO6)3;esLa)cAQS!r0>f(-m>`Zd4_4KTeP
z`~EH(4leLBoXm?;d(1b^KwIPhD1kN{-0@dHT-E=1^I*XF-dGmewgc)YtOS&l38M!X
zCZG~Pjr67e?~R|eYFysR##+e{Jgcm_0E~v&dh12tkFVZ3WjXF9BE^ouy`-2o-A#eN
zWU2tS(CZV8f(g>u(4|C}f+;_D6N|t{@<2ss5iAh%{ACd1drw^0z#vU;R@!==d6aJA
zJ*Ll|oM%1Hqq+Oc=5%osUeKPbO#r3{I3I)~GElDVMlm_R@oX&TxF*r%#jQ6=S7B|}
zgns9uI@1u8r_RFnvk2Awlal7gdmW5e2B&;=VdN~33KWIhXsn78iw%vift&6$$6E*d
z#tDywlDy)rodM&)gqTS&X!t2tdK^ijkN|Bp=666w<o^uW$z)f?EGjmuJM#9iP;XA$
zl1f8DOX;b1KsiuerZ{DEaQ}W*0S|iPkAT8I7mNxU86*r=xq5Z8G<H%HCH~)|Z<QEh
zVSdHp#lh1FwKb2Rui$KGw!=<S4YF3~%=Nyf%>!|?fr?ql1L<YK9|A95uOwek71Sz;
z!8nQo{+!is=;S|gBickXu(;Z+sGt*Wy5Q#9mVQ0k4VoWBipBc&mNjZ4WjiLvnYx{8
zvr0h0a4DTC?PiqEAtQV><+AIMb(p`tM{YhLe3efR(1q&yoT(sb6~|vIhSnS1)ca_9
zS!8nZ*Ei5tVaQel@+8w$guUqd{_|G5)}u3t?B8lGOwxPJR8S9k4GDsJjOJRO4h1~h
zsYHYXo(s($BKXI1w;EIbG?)kpPc-CUpsF=GO@C}cw2GYS1`E)))M81s5k1cOd3h_^
z%Egx3IPc|(H*$X)?P?vYuAzT=t==buvBH2^P<7;9UQQE;fU0&Yr4_emEz9={`<DFP
z;uF5E2>30Q2(qwvV2CPrt%bYj8b9|o`IZ`z=d?sBys(~cVVP-dW7YzbJUk&j5h+)M
z=5CEN(P0>*fqQfK=t5HO+38!j8}{f_VX5Vek=gjf277$T&Y!;G3(XzEQ<t=!fVGTh
zn+Nv?_17ZEYCMJL#J4M?jp!`AX<0U0t>21ZS)Y-~515U^kP+;D$KUElsY%VyT2(Uf
zV@A#xUN9spLd#b3=i6M)&qTOyRu(F<|Acm)k{uXw=?<Qu!Ec`MkX#@iCkwAGqJZ(h
zvvz{nxi9%VrKRRp;3zwWb`rMDDv#LM^MjGZDsHg&-}{q@DonjJu`S{kgb?L}d(8KN
ztm=&~JB>j*zE-XiMUGfSg_d_+8(pdp5oDA~B@*x13dpis|CC502-{f=K?QUW@Ch>s
z+g)Ett!AZ|P-vF%%}4n#(B@aj$d19I5JZddxQAmUJkH&|1!U6{Zz(UL?Ud(L^FEZ~
z0Bq;s3_i}(0eV&=So;#pon=GZXO1p<>h#nSM@st7IWcqbNSgIrd5fn{q_;3Q>po**
zDWEHDa(?i$``FA_>kPh*u%!KzMV98RWu>&9S}opx8SbtvOEgHDd}65tX&{e}GwE$`
z*%iD>l~CtRd$Bi1P)o#|Orl47{zIU>x-}Do)yj%SS7LtW{Dq1^k{_NtFw>J|5-f%g
zzhk)2kJ=p_TcY`j=oamjWLAjT@{i27(<DJbCJl!C+HdfAvGKt54{fs?eX|0?{ISd=
zY6KgWnm<$xM=`2KM0>8X8$bOUY>*yJQLA8VFvye)iiE1WcJEv*@^5ORB%OS?-^fYu
zGnX`^h2PD-r@NjZ%)0S=@bU@|eeaLsM`k?4%sFl6SImDMsi8{XZlMl|+ksOfxBzS+
z8KnsE>YwEjH0<Vx%56sPYH-(UN&Oe+?CFYC#iE0K8DF>jSdl9Ijah{E8$F5JM1X7f
zV{OHM!jmfGbg`Mh>Qs#w@w;efNpi>K(SPjgmy7pR1j%?Rj$~K@=@?vSW+AZ5mAyF3
zdRoJ8V~N@3tNGfo4p~sxA6UYBE%a!o<$cdc^Q@iU*H|3k;eok|JbvBsqZPqZG8jqK
zab^F8N?90JpN5J>4Xp2z!?IE0eVM<>P5qOOA3oh$J1px!tJIWC|KR_#|6}V1qF##g
zA>s*pNz+1L9@u81)l1dlano6gn==4wr?HLM4~FV4KgwUv^7)lMR?V2`Y43D%14!Xd
zhLx8yUm#|&?XKuQ#X73W50p%0Hx)Jo9O2(SEL6r`w}lRsNBR%tYf7jH>0ky8XT2*7
z&3}72VQW?8$I~A)yf9GlxdoKQ87AWB1LjH**%W6MkIxq9=W|#v`1d?GCjA$+^jM<A
zv?`r<dQPwiXISLD=8x5d-F;ojg2>IVOnG}GHjSrqK09rZX2Ft~M*D{UNyM!Nc(<l4
z`?8gipL5qc^)9(ZH4VhqZDtaOuE-SqA<tU5yj%reZ6-<G1kM@<>=9{84J-Kgi*i7Q
zE7i(2nZ5b2#(3T7kr8cgE)~<?+2an|Hw-xj)s`dWPJA}X|B0{1xq!O-KVk1uN@J2A
z|3!Ujq_;TR3lF#f=?4Zh^jXqzuf7**1fsw#b^VPwYa@+6pM>$JOYXbiZ+x{7f{-rO
zW-X*aOwue4BRG~=lu+3b>5|Ih-__@&A&dfhXYfLIj_1@B@X8v%Gy6R>4|rVvZ@&Kg
zzwaRud<F^Woh&{<IN;!By}Iq^D{PHYtlz=G#RxD$qdqmXF*dx0^R=$X855>^ELk6L
zraJ>*l?ztP6J+i!YYtL2T%-^8-Jg<Q*RQQBlmxn0-XqO(Fv2l?MxgwPAclbO3y&KA
zuZpj-=DU&82e<j<wDnidiHz@3g#ZARY5Q+i^B-{gf9`H(ke%#qu5a({T-rJ{zv#{K
z>-HN|=`uELLjla?czSSQEoQooBU22q2OwYPoomSNQUik-bbCM*pZSFfsiB7d{X_U9
zz@?RV<-IzfDKUeuoQoA}tBc>^;Dj8ezE8^ljmiYT`0t@H0NVNQuY=~_=FF3WAd+-W
z-{!o-FwQ=Dhj(oF;xZ!v*9`&$+4hsgcN-cc@vs?qI65otcw;HLI{Z)uJ0;K@2rjpB
znV`SwDWH)V`pP#<YCYfl*!kArgz?vsWIWeB;|s^5AF-9j&byQH1w#`PlXfFyVEdJW
zV~U+<pY8a^U?U+YPW*e3guTo~+M5RHvSK{Vf|{CYfcNNdIL~%{6YP1r9*p#s1o;XE
zr0z#aUww3jLnKkseyc?kRbq-Dljp*GYH6w8Ek52|EY_M|*u9=F1Mr#0^<h;x9*eH5
zOpEi8@}J6g4&thfayV+F(?2ODMb#Z?!R3U3!0kn+04;T~mew)xaeiJ1LgKjD7ZF#v
z9+iBW0_;=q0^R(gQ*poAzq;Ga;O6AKJXy`~J6>*4PoO914VV%MR$fmQMkWu81{r4W
z<m{c5(`Ugdfvw3)E*&xG$x_o4K%C<mWi=Tg*a@C#2Neur$j5Lqg1s#}fqL+RM~dsy
zy%VO0Di(R5YGYn3!hlg>DyTd8qh)f<Iu4C|uF`srM3fd$AHZ4cr`0*w{g|ae@Vy^X
zETrjR(WWD>O;DAftV4_KFF&vkIxh4Aa4L8IPUJ{A*;rX^y>OU}%(uE-1R!CE^Z<Bu
z9;wu<=D!ri#-Lu#Xx8oZaLuF*ZLnFD4|ZfX9ZLmx!+c_oj~C;>PAfNY-^KoCsEjn0
zpyOXmLdvvHPFl5QO0eAZ_uzKtBcci|LypsAX($xvF&dOm90VALn^@5Mu~E*e#(PKw
zLi}d7OdCHrnA4yJV&GX<4#PW=ALw{_I(c~^<G(2x)DQVu2HPFaa5<nR7(pQ^`2Oev
z3q)Cw*YYw^)A)}@r+8dX_48w(B#EDAEA%>mJ?U0aa1gajye+;kHxMaxp;BURvFxno
z*{KKU#{lJKFuClE5SpMTBXr!Xcu*Iyiq`6acTx-qu`2bu{975<rwSB2YHtCGvGO_^
z1z>&paJ{z#tiCPn0FinrV+Yb5H1UsRY<2stn03DGFkTnB`6FO-VW8vrip4n{;8q?L
zvnm`}u)E(JTVu--cmpJ6U=&ux9o5^LRUaX@b0b<T>_M4g><0HMi=SHMl(?SY?<=k5
zd?V=sEg_(bcOI92vF0dOl4AhSOk+V#csQ688ln7HXYhfn<~@%5<|gZa-wwG=TVD@{
z`}H9qUx)h@Ju*3a5T-JuhI*r`_8)C~u0juk_wjZ!>X)W1@pn7$jwG6Qg&g{VGk~WT
z+KfwByVjymCsJvanw`R`fL=6P=pVZ=gmmP@qeullIsUcX8o;U_R)io9rGhXB*#qg~
zf&F+?@eOwGseC!qAL~?;xz_-xIE(P_@9TA9a0zP>?h24jd|2!yq;cH}LMQg*9_~rx
zb2+Z)cqX#vaoYd295&6~lPMhF>9aECKjG2iKA9^O!OQydR}K-cJ=G!_)``L^SRaWi
zk6v7K!0^-M-V_t<u_<Z-^EZ%4$jJLZRe~C-OJWaOY-0Hem@_|HdGDSYkFgY-{V$=r
zt)G9?)`Ky~bmjW;<x-gS+DF9Q=tn*$sX&xnn=qr7f{Ly?wa)=k4^;+=q{cK=MWX=6
z1GXlDpfYfoMQ8*TKu{lb(&_ot5O_`CD0E{fCE^wH-LKPOU>zu`l@|vIy^HjVNa8Tv
znb~4!6pC;YxM=usMA+?s0fZJYF4aWNrGbEyI*2#PREh0U09FArt}3K38HDqrJ4f(#
z4Zi#=-lDm;YS8DD{gqnDyH|kz;f>kUZ-MF%inZ&(Y*{Orp7))xRMUESx|p&kT_dO)
zsF04Q@%7Ig_C)~v=BS1~wUV!QW7B3eeMKq-8#i0T(YM0Q(2ubb*kl-(v&P)8D}KuG
zSt69F`>~FvYvK>qN54?l36QPG_+6um|IGfSKNLBEn21b&xUtee#X4AWXCO7t7nO%2
z2>XF7Ry~?xj`D9Rh^mQ>8VnV~<CZa=DpZNfiC?eA9H0|Z#YL=k%zYc2?|+4)c)2To
zeOyB;_ylNJQx&on%AYa4!DaR4`gBd12JZMz-EiQ^e3jvL5$kb^M{@wB7OT@n&yS`O
zF@t!jG7tKww8A9K^Y6X%;hS1I3pmc^Z0Hdf=^&_^n~dkWA$W(iG=?)d8s2h6gO5;>
zd0`e-<g7c$+nTW}^6dC8FtG#l?sJMpPH*5q!MrUNMjuYdV;w!XzDFrF*IDhBUiAx<
zJcl05$Q!q69pKWhb&U`(8TMLRoF`pixiKjKi`5IkY*{m`#%h860AXrW1#%z7v3<mx
zVc%f8E<!x;ZE3xPw1kxmISdkvJiPk83}*aiDx}PTJP?y2g&u9ms29|*?oWD{embU>
zNcOZ}$ZF_xI3H7$_(Qd%38oAQ-lW{)tA|kJ>~tADA?7gVP}^j+BHgPq&mJ@;!Y7^o
zGI;-5fgL`Mxiuu^WRG6<@gsrKVf>@MWfc!wZxredViU+CZ1<Z^Xy#7#=+^Ls$@>C-
z2WePm@%#Uhz-o@;2f7{pc|r@^B0$ME1L$;>b%xq;piMX~&1fu31!&xRtblj1xEYq+
zjDdbgJ{P0h*LTeD@i7dB^crW)Fj@U@wL~#(?MliIU)NpTNup<>OJMvx-(xAkp!KPp
zR(>bL*Zf=I8@sbDr_ICvHEaOAm5M<j<3a2iete75fk{U(SPfDmIuHU{#CADaY-m{1
z`l_ZewWB=Gy4IDtn@8vEH{Z0SCJz;8=-Mo8<))&~Rf4dpQ3sQYHPW_#I7G*SiQhq{
zcIIuti0MRGmKCi#(GFI-3IBZ1S#>^tmdZ*t4`#ehKjNIH=Gq$y<|3JM3Q#)folY&q
zSCPR`BNBW#<gg;3&9xfRAdRnDbJwDJ<r}@f@`08>rx^5e%!XS^WNqyU)w~GTTs6_n
zHJ;%RBPy(?3G~2W{F`06%63b3%z@a%y8As4;f-XWVL#u2Kg6r^g7bsoB6`JbwYq>f
zGn+6kiQ!fPoLB)Dov99@7bShPjNg0rb6$iTQ?6pgcP_pdmiuN=ZZi4en#!0W0;IxC
z$=q);dyv##4in^#^#5*dvG|4ZD=}a>Wk@*$k45`|op4X>)>x^y0)`u0=a)@i<<xd+
zFBXKSJ0_@W^-3N%A>&b5F=Az^o>$EJO0{JW^xkd#=obohVBrtWmXz3Ix#VdeBr#o4
ze1%kpqT;C-Iy#HqxMh+dW{~dV=r!3>+dMV3R$I=915Za)9)C}`RX;L`lCt>d{R*yr
zF1pq@#dQE}{Gqi%DD(nfhh3=47)=){6`lesw&Fu~F;GtiBl1r!$5h}9QXn(;Nu6O~
zRNNO28`DT)s^)_b(tZoQSyPrzVGtyY?2c4V5jAQvd1H=U$ial*P8V_Lf8en5m{^1t
z3~>ld<+v?@+;OV?N0P)ldTR<DwzD+=7B$el`BaJl-jP@e(x?3Vu87s<U<TBUS*8U&
zYu&;7bS-PZF#9zK)MC*;lE_Ax2ZHxo1WrFp9b-NjyS)v~-!85!acE7gu9&e}nCy*e
zx?cdQAOOIVvbS9hC@Q!HAYQb;^e$)$rS?{tsFR}lm4zO3YA!}nk1rcsRN3Y45HFX4
z3Q-+l*EOBLaBOqU5~UE+k&R%jq~>s)jt}2;RS>D1#V!zbaJ8d03>Nobc~WGeA2}bh
z%dcYrDACLul)nY$$>(67?0#Dk0ZA8f3>&!5%MfF%6yyVNBbf?eJ!_>7T(75dKn{NQ
z7QLAcMU^<n{nbl-T>(f*$KvdwVG_4LhVy-T+qhft3{+^oTAvfCE1f~zNI8Y&&Ku&R
zT&Dx?n*Vhy3_b>s=V4cwFchUka~v?53K%gvP@Tc|4Vk4f^o?=1mz&Xr>Wkx8hS2J9
zbz%o_lhP_ZiHGgB>TOi@fZBSL;5{<&+oFYLC(FeT^T;#3`!=6#*?E1KpRAf>ODa#p
z-&V8ijHSs0{f?!UnZM>lD}w^wn*FRcFVG0<H<4+Ki%7^8fhKjN3sRVn%1)Y?y<1yl
zO5~JPchp#<XOzTB=dm*|Bu7TmCjEySmHO$!v8u)3NOjT-yMtC)P;c~EG2}5y^w<dL
zYClBJ;r&3L`r&3fT2lG`c-V+9luRYcU%IpOy_^$j2@)f)7N;{n2lEIh?K7ho@gP({
z6cPGVLWD2KLz3}p<aEXOlK%md<lr$hn1uuNNQh)rWRU7VD2S=NE=y5J{s5quN?c}P
zJ-n%pH^u=eoc8#9ftUYt7oG_Hzd?|Jq(B++uk+lwQLS5U<O${fYPZYmewhhHawrrI
z*`R+szw%kA>u(K#vHIp{%b*T^M`?Pug&uga@Ev1e7TdjgG>P}*q-Wyl31iG#@@6|k
zFBTE*w_bWWEgi|v`}@{^XA%YV+v~WLlzBeP+>3yGh~e}Nt$i{n4qjYrWsPKuub{Zk
zCUBWSyV{ly!&5KoyFrGr1~7y3|BK)HFDI2;{#Q|_^F)HvcX+5RYVxu*WB1n6St%+m
z9`u3qe91Aak>c1qNa<I<poXe&0vTjq->!qb{rUNMxrM8_aYcQ3*6sR06QNz*%JW18
z|I+!s_bm;b=SLM~9w(qspLvnmR-^wtRkQh2?=jIFIB}SiMA$vZZd8M7vIFfjzDHeE
zv6&Oto}6#)D~p&aR-v=xj}?zK6x!#Vx@c4exN_l9GR3z5*jp+XUor72g`(nT^(0>Q
zkCy@a(5v;<{gZjaU(2-GEN@m0=1v^1!g)Y^pcWnGgyC&_FbDz1=|#B6j0cgBOpu<N
zsNC(G-UavgFVUY`^Wjw7;g}p6@qV9e+C$n@GOvtBLr>^+WY^DvvH19z$I6$_qzD&{
z-3@gaQDj1LEDFgIyRtGv#fyAMY8sdJO~4Qb4qgD)E;yb^J00{n3j)W9NQj=CwO+iB
z-;~KJv=oNNWTI|4TTaP1%5pw;(m_m^^4(&OoL)9CvEgflrc6^#WsdE&b82uD{cPDP
zkRiN2=JatnS#Wt66D{N}ZFN3!->>w%U((9FmX&|GTexUgtUsxZ5*+S}NEu7(kQI`N
z)EM!JeD>?eXIp;zvh_9N;O8=y%}TS+W6xd)vtHBLU%TGmD5g*E{wbr$n^eG6<1K9L
z$2S6TyeQb;v1JMIZgAXqwdneOa>8tESVB2<#Oy>6JQ9WqWHh<1)fqRvi1xAF!SiZ6
znc%4TK`YKf+{dfD*?TI&6m>kltXaov4RUl4zh1fsKLLX}C^Pa8=83J}*Y}wAGpO58
zoEgvVACgA8Aud-rxG<AB)<1R8jyUY6P7nVJ2M&>+`B^WQncGRfozu1l%yT^H&=0n_
zM$*_TCY?%ITAv8nZH)XhwNX8P7UgidO_`81O&<NKlhNUJNu!{*Sp08F$;mBQ<A6s@
zvV7ua2fL{w{@}I|$_of@_%2il+hwuf_yT#-iU0Mr-)Ef|os8Gsb0_<>p`ydx(_&^B
z-hnhj=j{BsC^32bgd{I==27r$kwSP~eYE?<d&@gKKE0wcSuNw?`QmRtB`p2H=0pBV
zYL)idw>CjjgaEfK*#6k+Xi7uz<6%=6mSbnFu9ogk4N2q$dJGU>wX%a{MPn*H39|Cm
z!Y_P!8r4)88sq}cjjg0+40g#!WZe8SgeJMhwD<a;I?RCaZLI9}s_yHHt)h80o9wQ`
zq+p!5t#8|41wu#Jf<S5DM64VNs*)!|7gFCoG)#SJ)mr^V(uhXt4YP{raJ+T>KH!e!
zIsNkIqk5WGI@IJy9iCT$UPi5U7tB!YhVSEVp;dJG7arDjoI1T6xX}Lo_HT>VH`pbE
z<Bn#WReu_6I+(F>kBJ}TdJA-?Mia`!8&Jo76`i_mzMn~U?;u8c8UG<+S|TW9P11Ol
z4ehL)=}?@CUik8IPwXI8Ng`;^KY4Pxe}yzb^X+bZ$4vr4RB69Wzleb#enI=o_Y3Ci
z%5sw>2K5`2XC;CFiCj-t$D!s3D_-Zr+?-13vGf+P!B8**O~K2rkDv?c@@2f&P!y5*
z8aXdfq!MQJiGgic>@c^_JkrClS5DJAR<=IM%}4#Jb4Ep;rNxFHLb>)-%6F672fcnU
zCpGS$5|`2}_{5-K3*to1+HZDM^yl%kcjr^$VDFSi95%zv%|Y4bKP-Ap<_*p>`ycf>
zUIa^j|DHAnUmpow!Yke$xAj+}{}p0=O;#HSdgFd5D%y=Re~J`LGbsk4h!m?H+<M(_
z8VIW<3kgC|FSy6(x%<7$*SELp4-=*Q$qCkTT~SIr<~ZVIp&dz@<#zVI%a_lvQoNl%
zQ?aste%yv-Renj+D+#Nl-2!Z;D7=OAZPml~10lIVw4GfjHR>-af>cNKBE`lsLtjy=
z<@z=r#oO!lm-NWzV+Yh{Plub1aSPla-=i{y@#Ipm@*fv7S7uu&Sk_v~++OPAX2qX+
z^vWX964WbJs>iUjjWG#I)?brC3@hgn<+=qnMIzs4iomRo;MwF2N<{Hc!CII1f9e(?
zUL~FvvjTCS^LC^{rgJMy@6N%k)WnEPfsQI!tm8cvl}wkk!jptqtj#VRfgq`r%MIhS
zw~#rKO=%fzy};b=-s)u3S(H15P8*$JmET*d)l*bXR#T*EYiD~S3#dAUVh0@G@yI=9
zX&JZuVM}scZfC_~N<5T648`vt^32<WCPH)<f2`tE0jETz>@r#R&3{~9yKuG^cz(^X
zwO%Z2yVC0?<u5%V$xx(XH}p$6Gl9R_<mPfAhyHb?s73Fkl`;?SEM5=6Qf@Rw>?B;#
z<W~!qAz*LceuCHYc<3|N2y~Gejs`)c>a($<hl5t39Df5*55d9^JKM?oaJrs>7%ULw
z1l5H`@#*xQLs9IUzGFPnd-HdBoV(1!@Hm=@6a(d+o+Y)&IbgwtO5w)n3w{aQ=i4GE
zgF;^_CY0PYsIh8jcWb{+JA9cF=ZlztmtkK~EeDn^A*%hu7<}tM@LMtlrjngSCVyD*
z-NrVb?8T$Y;j+hC->8QpsxtGLqeSb%+bWmUS42VB8L#f|JAMxf^GUrKFWb@(+osFF
z0(>Q196f()7m;X(JE20Ffo3b0bx0v3wl;$6q9nmwENG`U?7M<xhqS>j3Ec8_JnGue
zFl|#lP|j3bhU@U<YCjpNtLj6u6V*38F*pa%LOx4YrGMn*^3S~y(A^6}t?jP5d(v;L
z7~w*b_g5w|ZOKBDr@a_Nt0a?7f+i0!MqP_JBs|kr)Ube}Ki-}|o`Q<8XKRT=1j1Ei
zO`OvFOGNlD${come>r-RCi%lJpX5FjKM@aqQ}Ez%wg87Ee?!pIuQ(y4x6$f0f<4sv
z1dn~?TvqdDrWPJwcYVbX0(>vwKF=r?iEB^((NRp4<fZQXjsP7`ZOX)Q(t3YVv{sVj
z%4-9h)|aQgcEnn6UT(gcvsnUz4k$+j)g*?mh+P~_6Bsp#zAADIcwv3*ydRMieEE^~
zPjCDqG#^xIL_C`xFi3)UeB^OI$X*X)9Ph|-|BB;fL0w9v1Q|xWj|*)3P!>q<NtjUy
zt9Bs%e)yQM5C;3JxtW<1kVn1Cuu^Yw%^;(zO(^RiyzW|I`?AK(P#_^##P>R*Brdv1
z<mj%8wzQKAAz$RODN8^MLdctG%Ge5t!bar~H3@{lq=V?SQ10;U_`3WXqeacWKJu(E
zpruzMT{|4zANAOO*27InQ`gw-%?n8kLdmfgJ3qmF4Yekh9lj!`@LubLFiez1DV`+N
z;H!yHkd~my;^aW%2Ad42v2aan{xCg*1d{-WR3FP-mr*tr95uScNY1XpOb&0n@%yWM
zG3Hz8j~o5seZ*XU4O!uVz{AhwdHNgcVGxHMbmc9A`(d`5oB*PSK)dvKT-5gbxKTy#
zS=eL=wa!=>vB3R`^!;1^{8=>yS{x3hy4Su;2jTCmjXJ0(1c3lbisDQ6TH`eE$j`SB
zv@QSEv?!W`M*{c%)N-!zOt5_%m*g<yu$j>+HnTZ1(lBAh;&$5YkXU6B$}vRBY1SMv
z=hLEF#2q3{KB+~?CTA0(k(}j_JI4}A_n!Ond7d}V+vj=le|f#SuK(|IUEk05`h&+*
zzdn4@FAAtBycPFN7oL2-fu9}&XFo`z=+(YSzI`D%zX^+N8U~KO&<X%GzC}|ud6b+T
z0$G@YkleD~_^fx*l!m@dPygki?DIx{r9}xpO%=&Z=t<p94ApTvt{2sO214=;Cjk|A
ztHXWD5Vc%9KTY2E)7en(k1r&li4t4-A2lQZj&?uxcQfK=zP{vax=wTVfBh*WT2iz>
zBuOBPHR<lWt3BmzXP9bGd?3jGoreXHQTD()m<4AK1l|S!(<GC(-!R<5@nq6BH<3(&
zL<N9Wf52TV@({FLX4EtJ@X<a|T69)^$H|ya%DQ&ynPV@6v08joSYEV0JVYQf>0Y|i
zR}%9S0|`8I0BEEmVG(nua&q{@l&X#a0O<LX|8N%4%isytK~jKwFuF-}S(7h9hNJCH
zPld(t?)J92z_E8fGL4Sq)}o1Ew{!eUEfLeg7U|sA`?@|)5<>MZr!{p1T`R509WH59
z^^E=b9a_^MPtzGOSczW)TcNE2TQ&y`FR$32#3R!Lc|<2rd%xoPY0)<~_Bvc83!dO6
z(pM<K!QO$gEBOSFFEoF+x+<pV-E|ev2q~|&T?a3%kDJa#_9t-xPu}p66;jX+NTUUe
zPlm>LenIuZ+rAxbf|*o^Bp{DZs7nL%g|x<@*z~r5d!~>7y!ASChFZY7<~&alCqg=O
z8z%HcCdzYc!(6*b*{Xnpqu9Lx*^+R~QS0w#FZB&9@>?~79i4surh%iyGnn}_<x8;V
zrC=ksd*i&28qQB@gCb4JtghkNL$hr}K?v(B%o(IAPEmc2LIL2PGP4M{FQQ5Ah>-(n
zK~g+r7f9}CLf>XOyWa&FnD6915aEz~&dSF|#hgcXVi;%p9aPdpo9SO$(>HHlD%U+f
zjrX|Z3Hbx*%QfX6UhxgJ-yaxiK@(rcQ<C~<#X#=K1xuf#415#hNKqGN{O)=-zwh`W
zW~&DpM~>;8W*QO5g+2LEMt}f8EEp$M3zh`H$7O0~@*v0ef<sJ=>+f!yO=qh(?`2-_
zE#7O%&0KwT`SI%h*!aoy=XIaWsvM_NJ0>gl@5b$#8cBMG#lNlLN~7AmN^6OX7{QIx
z0yZ*RE+G3&GmQhdsxK1*ExQWZ)lN3DF0czByTYlV;cf0!q5w|m64EAxK(>lMF^~!<
zv(c!Syr9+}v1LGHG=sYx2^%7|DoPk6=rDuP;1zmo+d;lT8r6$og>F)lGd4!nXDeO3
zOOo5Z9C}hl%-M=jFkz&yA-cWbK*{IV_D)Sc5{jzMIt<Vd>|@6<(Lk36BElDLmot0j
zyPKf2Vb>mUw=@ab=L-cX34d7)eOMmNU@uw(RZ>FmcAY;|IV!RYNn9;`O3iEm?34#I
zI82j!FX5ExR2Qu>m+{(E0cV3*u^Xh|%&0Ov3YF*pn<?IB8ZGMk;!c$@ol5Zfta4qk
zp1fCuYd&+*<E2YpirWy7Fe~T0qw18{y+pJH*=lR(kIJG3Z6QGNVG)Xs0@0wl#KI5u
zGYy}=syXvm8u0#AO=0!P6w^u?yVx+K9(6)a)=w`26v-m(<d-wU$V<r5PA5q3C07{s
zN9@eA20>aAA@1q=u0EbSHCKzpTzg&-JW8`&lh1bl3%`@hEnBklWJ_?C-^K0UH=OgD
zcNB=9m6TmB5nVu>IUfvHAD2;d2Pfve7=v#bs~<0bb*y<~JPAHG#QO%J$!yz1u+sHd
zO9I2reuzoydY6(yP2m43U*~V&a5DRnj+-XQ{IVuWFF-6A3`pKy-&)$t))UI6UlZ)B
zKuPEU_mRpTgG<5`RvWKb0e1|mDc*tUew7miI_#Hu(|NC}`%b>4jiDy2IHFy0unJM2
z|FQvndNDT;G2#lV5d-n5xY)sD+V+>iq=iM)N*D`D+eD-{#*=>Ux<b6K`;gU0K>b+x
zCS!XWKns`G4=5cckkorL6{-c$?8|Gnl*@h3We~{rSqF9o?4{t=NufEyl&Gg!Qp&@c
z&mU4bka)o#9lR5r?&0pt=IA}OoFIEn<C>T5RO-@tTkB=JdOdX^BvC-9S0zY^_)yKT
zlU1f>cwP2S^cgxBN2%TbP?;n!u-;QvOhYBaMXRz!v0CNGI0&trMZ)c6mg+9lAceG*
zO29W&reFbwvF!UU)Kmp3BZ7A~MiGiwpQt`1*?yH==B5tG3pg)jyD0tE@{p7k&76$b
zMqCxTZhMnCH)f{*IRX-w3a=Z$GA0Z={(AkDoMBuA^3EvLZS~SnUJj8$l43+LTL8G>
zvmiN&8{>|}O}9>Yly)KZ2JN3PX6!r)Om6minnHYD`ILwnpB$Y=k+RML#1LGYm*&{g
z^Sw-?0SH#!p_z{RrP0=Y_2O&P15>mtp50|`GpLX-WI-Oi!m&bXfJQ(N^1RX{(+Lw?
zmT0cN;V+|&AF>2l)2qah=i5cg0*={)wpzeZ5~awOQC_iw(8vgQg)v;wxs)94<coo(
z=d_7;#-ZkfX$s1kqfD?pPZ`v>YVz7+^>+T9qi{Sq!K7Z{TlJ?IBv%*tE)v8|<MWGh
zCOWI2;62mB0M+XgMg&>6?26ZbCQLAy!_u^RI}BjK;+DFl_d$0B>hZXl)M5|X+hAoU
z=lB~HI+hC2vmY#>?;fnBYch#`+o9@1TBEYESD|f%OW?GiTb*TdS*NC(+lG)*3E#|T
zIn}Z7AAKca5agZPFn52XJhT~pkcwkYyIYPTH3jXb&Nh09o|t*6q}UxyV=s^T8O!D$
zu>;O7*mk#<wmqYN_|4d{f3tA4N{#N&Y>x}2pbxCtg&T+c0Y?RDADVeC1NsCl_Pn7x
zd;64Hi2t%}4C=`<(Xbk)84d?yIH09^vCi!3mS|*V>`uDm8z6Vk2A7Ki2|vD^vq-Y`
zAwk)}M+OP@|73VMlqRP$RN-QFjF#q{!4^CecD)tBlbTEEbYaS4WY<@&fLda6MD;5b
z>f2uehAoyOc7d~Yen74u-g$&Z7vfx<xh}T|bj)1{9SJjr68m}{LmqXqwxwdyLoywX
zM=tCliz_eYSto5HdRa1?;G3V=NhTewY^%52_ym8OGutU|o!KVjvT;Vw8_$oX<%aLA
z={%$1?^ypcdMC>Kj0`HK2h<d+!}v(2o0!2~&T)NzkI#|T=rR`G-noi^f+!ZL2>9jg
z^u?WzkN(9-@*bxikMPI9Wm-CqBJ?);eqK`c?O2wwCVw6c2XU=4*uCfIv2L+Hi_RFW
zhOt7;H0<$l{ADEVK?b*r+;u7CNcnU+HD7;X9);x`gHbC2qYHXya;+s}^RK)90d1EV
z_rC7j(P35I@PZ)`9@mTj{VICmdPZD_5^N6-?sl#&aX0jIymC}X<ZgWA=LA9igf=ht
zUn7}UA>w)h=6q@6NEP3w`L9~zyRu`C4yp+VKvHn~%|J-U%L||&x9|MHYc_lk>BPsE
s|F8OwulsLr7b1{=mE)7r|3M{)z*-*qYYtEG^&bHN8!HEV9nLH9Z>LhhSO5S3
diff --git a/data/reusables/code-scanning/codeql-query-tables/rust.md b/data/reusables/code-scanning/codeql-query-tables/rust.md
deleted file mode 100644
index bc104ad62bc0..000000000000
--- a/data/reusables/code-scanning/codeql-query-tables/rust.md
+++ /dev/null
@@ -1,15 +0,0 @@
-{% rowheaders %}
-
-| Query name | Related CWEs | Default | Extended | {% data variables.copilot.copilot_autofix_short %} |
-| --- | --- | --- | --- | --- |
-| [Access of invalid pointer](https://codeql.github.com/codeql-query-help/rust/rust-access-invalid-pointer/) | 476, 825 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} |
-| [Cleartext logging of sensitive information](https://codeql.github.com/codeql-query-help/rust/rust-cleartext-logging/) | 312, 359, 532 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} |
-| [Cleartext transmission of sensitive information](https://codeql.github.com/codeql-query-help/rust/rust-cleartext-transmission/) | 319 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} |
-| [Database query built from user-controlled sources](https://codeql.github.com/codeql-query-help/rust/rust-sql-injection/) | 089 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} |
-| [Regular expression injection](https://codeql.github.com/codeql-query-help/rust/rust-regex-injection/) | 020, 074 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} |
-| [Uncontrolled allocation size](https://codeql.github.com/codeql-query-help/rust/rust-uncontrolled-allocation-size/) | 770, 789 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} |
-| [Uncontrolled data used in path expression](https://codeql.github.com/codeql-query-help/rust/rust-path-injection/) | 022, 023, 036, 073, 099 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} |
-| [Use of a broken or weak cryptographic algorithm](https://codeql.github.com/codeql-query-help/rust/rust-weak-cryptographic-algorithm/) | 327 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} |
-| [Use of a broken or weak cryptographic hashing algorithm on sensitive data](https://codeql.github.com/codeql-query-help/rust/rust-weak-sensitive-data-hashing/) | 327, 328, 916 | {% octicon "check" aria-label="Included" %} | {% octicon "check" aria-label="Included" %} | {% octicon "x" aria-label="Not included" %} |
-
-{% endrowheaders %}
diff --git a/data/reusables/emus/oauth-app-note.md b/data/reusables/emus/oauth-app-note.md
deleted file mode 100644
index 71ccd1691dc0..000000000000
--- a/data/reusables/emus/oauth-app-note.md
+++ /dev/null
@@ -1,6 +0,0 @@
-{% ifversion ghec %}
-
-> [!NOTE]
-> On {% data variables.product.prodname_dotcom_the_website %}, even an {% data variables.product.prodname_oauth_app %} created by a {% data variables.enterprise.prodname_managed_user %} or {% data variables.enterprise.prodname_emu_org %} can be accessed by users outside the enterprise.
-
-{% endif %}