-
-
- Personal Access Tokens -
- OAuth Access Tokens -
- GitHub App User-to-Server Tokens -
- GitHub App Server-to-Server Tokens -
- Refresh Tokens -
If you use any of these tokens, we encourage you to reset them now. This will give you additional security benefits and allow Secret Scanning to detect the tokens.
-Notably, the token formats now include the following updates:
--
-
- The character set changed from
[a-f0-9]to[A-Za-z0-9_]
- - The format now includes a prefix for each token type:
-
-
-
ghp_for Personal Access Tokens
-gho_for OAuth Access tokens
-ghu_for GitHub App user-to-server tokens
-ghs_for GitHub App server-to-server tokens
-ghr_for GitHub App refresh tokens
-
-
The length of our tokens is remaining the same for now. However, GitHub tokens will likely increase in length in future updates, so integrators should plan to support tokens up to 255 characters after June 1, 2021.
-]]>To learn more, see the compare two commits API reference or the guide for using pagination.
-]]>For questions or feedback, visit GitHub Discussions feedback.
-]]>
-
- )
-}
diff --git a/src/landings/components/FeaturedArticles.tsx b/src/landings/components/FeaturedArticles.tsx
deleted file mode 100644
index 9981defd5ae9..000000000000
--- a/src/landings/components/FeaturedArticles.tsx
+++ /dev/null
@@ -1,50 +0,0 @@
-import cx from 'classnames'
-
-import { useProductLandingContext } from '@/landings/components/ProductLandingContext'
-import { useTranslation } from '@/languages/components/useTranslation'
-import { ArticleList } from '@/landings/components/ArticleList'
-
-export const FeaturedArticles = () => {
- const { featuredArticles = [], whatsNewChangelog, changelogUrl } = useProductLandingContext()
- const hasWhatsNewChangelog = whatsNewChangelog && whatsNewChangelog.length > 0
- const { t } = useTranslation('toc')
-
- return (
-
- {productCommunityExamples.map((repo) => {
- return (
-
-
-
- )
- })}
-
- {featuredArticles.map((section, i) => {
- const viewAllTitleText = `'${section.label}'`
-
- return (
-
- )
-}
diff --git a/src/landings/components/GuideCard.tsx b/src/landings/components/GuideCard.tsx
deleted file mode 100644
index a57d080c466f..000000000000
--- a/src/landings/components/GuideCard.tsx
+++ /dev/null
@@ -1,32 +0,0 @@
-import type { FeaturedLink } from '@/landings/components/ProductLandingContext'
-import cx from 'classnames'
-import styles from './Landings.module.scss'
-
-const { hoverShadowLarge } = styles
-
-type Props = {
- guide: FeaturedLink
-}
-export const GuideCard = ({ guide }: Props) => {
- const authors = guide.authors && guide.authors.length > 0 ? guide.authors : ['GitHub']
- const authorString = `@${authors.join(', @')}`
-
- return (
-
-
- )
- })}
-
- {hasWhatsNewChangelog && (
-
- {
- return {
- title: link.title,
- date: link.date,
- href: link.href,
- }
- })}
- />
-
- )}
- {guide.title}
-{guide.intro || ''}
- - - -
-
- )
-}
diff --git a/src/landings/components/LandingHero.tsx b/src/landings/components/LandingHero.tsx
deleted file mode 100644
index e727bb51b62c..000000000000
--- a/src/landings/components/LandingHero.tsx
+++ /dev/null
@@ -1,84 +0,0 @@
-import React from 'react'
-import cx from 'classnames'
-import { useRouter } from 'next/router'
-import { LinkExternalIcon } from '@primer/octicons-react'
-
-import { Link } from '@/frame/components/Link'
-import { useProductLandingContext } from '@/landings/components/ProductLandingContext'
-import { useTranslation } from '@/languages/components/useTranslation'
-import { useVersion } from '@/versions/components/useVersion'
-import { Lead } from '@/frame/components/ui/Lead'
-
-export const LandingHero = () => {
- const { title, beta_product, intro, introLinks } = useProductLandingContext()
- const { t } = useTranslation(['product_landing'])
-
- return (
-
-
-
- {!currentCategory && hasGuidesPage && (
-
- {t('explore_guides')} -
- {(featuredLinks.guideCards || []).map((guide) => {
- return
- {intro} }
-
-
- - {title}{' '} - {beta_product && Beta} -
- - {intro &&
- {introLinks &&
- Object.entries(introLinks)
- .filter(([key, link]) => {
- return link && !key.includes('raw')
- })
- .map(([key, link], i) => {
- if (!link) {
- return null
- }
- return (
-
- {t(key)}
-
- )
- })}
-
-
- {currentProductTree.childPages
- .filter((treeNode) => treeNode.childPages.length)
- .map((treeNode) => {
- return
- )
-}
-
-const ProductTreeNodeList = ({ treeNode }: { treeNode: ProductTreeNode }) => {
- return (
-
-
- {treeNode.childPages.map((childNode, index) => {
- return (
-
- {childNode.title}
- {childNode.childPages.length > 0 ? (
-
- • {countArticles(childNode)} articles
-
- ) : null}
-
- )
- })}
-
-
- )
-}
diff --git a/src/landings/components/ProductGuidesContext.tsx b/src/landings/components/ProductGuidesContext.tsx
deleted file mode 100644
index 0a9df2552a5a..000000000000
--- a/src/landings/components/ProductGuidesContext.tsx
+++ /dev/null
@@ -1,20 +0,0 @@
-import { createContext, useContext } from 'react'
-
-export type ProductGuidesContextT = {
- title: string
- intro: string
-}
-
-export const ProductGuidesContext = createContext- - {treeNode.title} - -
- -
- {router.query.productId === 'rest' &&
-
-
-
-
-
-
-
- {productCommunityExamples.length > 0 && (
-
-
- )}
-
- {productUserExamples.length > 0 && (
-
-
- )}
-
- {router.query.productId === 'admin' && isEnterpriseServer && (
-
-
- )}
-
- {featuredLinks.guideCards?.length > 0 && (
-
-
-
-
-
-
-
- )}
-
-
-
- )
-}
diff --git a/src/landings/components/RepoCard.tsx b/src/landings/components/RepoCard.tsx
deleted file mode 100644
index b3ab9c07dd1d..000000000000
--- a/src/landings/components/RepoCard.tsx
+++ /dev/null
@@ -1,34 +0,0 @@
-import cx from 'classnames'
-import styles from './Landings.module.scss'
-const { hoverShadowLarge } = styles
-
-type Props = {
- repo: {
- repo: string
- description: string
- }
- href?: string
-}
-export const RepoCard = ({ repo, href }: Props) => {
- return (
-
-
- {ghesReleases.slice(0, 4).map((release) => {
- const releaseNumber = release.version
- if (!enterpriseServerReleases.supported.includes(releaseNumber)) {
- return null
- }
- const releaseVersion = `enterprise-server@${releaseNumber}`
- const latestPatch = release.patches[0]
- const firstPreviousVersion = `enterprise-server@${release.firstPreviousRelease}`
- const secondPreviousVersion = `enterprise-server@${release.secondPreviousRelease}`
- return (
-
-
-
- {t('explore_release_notes')}
-
- )
- })}
-
-
- {allVersions[releaseVersion].versionTitle}
-
-
-
-
- [0]}.png`})
-
-
-
-
-
- )
-}
diff --git a/src/landings/components/SponsorsExamples.tsx b/src/landings/components/SponsorsExamples.tsx
deleted file mode 100644
index 5061b53b253d..000000000000
--- a/src/landings/components/SponsorsExamples.tsx
+++ /dev/null
@@ -1,24 +0,0 @@
-import { useProductLandingContext } from '@/landings/components/ProductLandingContext'
-import { UserCard } from '@/landings/components/UserCard'
-
-export const SponsorsExamples = () => {
- const { productUserExamples } = useProductLandingContext()
-
- if (!productUserExamples) {
- return null
- }
-
- return (
- {repo.repo}
-{repo.description}
-
-
- )
-}
diff --git a/src/landings/components/UserCard.tsx b/src/landings/components/UserCard.tsx
deleted file mode 100644
index f291a66d5db0..000000000000
--- a/src/landings/components/UserCard.tsx
+++ /dev/null
@@ -1,34 +0,0 @@
-import cx from 'classnames'
-import styles from './Landings.module.scss'
-const { hoverShadowLarge } = styles
-
-type Props = {
- user: {
- username: string
- description: string
- }
- href?: string
-}
-export const UserCard = ({ user, href }: Props) => {
- return (
-
-
- {productUserExamples.map((user) => {
- return (
-
-
-
- )
- })}
-
- 
-
-
-
-
-
- )
-}
diff --git a/src/landings/components/discovery/DiscoveryLanding.tsx b/src/landings/components/discovery/DiscoveryLanding.tsx
index fe18a1e88c88..bb45b45c56be 100644
--- a/src/landings/components/discovery/DiscoveryLanding.tsx
+++ b/src/landings/components/discovery/DiscoveryLanding.tsx
@@ -1,12 +1,16 @@
+import { useRouter } from 'next/router'
+
import { DefaultLayout } from '@/frame/components/DefaultLayout'
import { useLandingContext } from '@/landings/context/LandingContext'
import { LandingHero } from '@/landings/components/shared/LandingHero'
import { ArticleGrid } from '@/landings/components/shared/LandingArticleGridWithFilter'
import { LandingCarousel } from '@/landings/components/shared/LandingCarousel'
import { UtmPreserver } from '@/frame/components/UtmPreserver'
+import { RestRedirect } from '@/rest/components/RestRedirect'
import { useMultiQueryParams } from '@/search/components/hooks/useMultiQueryParams'
export const DiscoveryLanding = () => {
+ const router = useRouter()
const {
title,
intro,
@@ -25,6 +29,7 @@ export const DiscoveryLanding = () => {
return (
{user.username}
-{user.description}
-
diff --git a/src/landings/components/shared/LandingArticleGridWithFilter.tsx b/src/landings/components/shared/LandingArticleGridWithFilter.tsx
index d3f08647f627..48d4cf4b8a5f 100644
--- a/src/landings/components/shared/LandingArticleGridWithFilter.tsx
+++ b/src/landings/components/shared/LandingArticleGridWithFilter.tsx
@@ -272,6 +272,7 @@ export const ArticleGrid = ({
) => {
diff --git a/src/landings/context/LandingContext.tsx b/src/landings/context/LandingContext.tsx
index 7f4258c2a910..a74647f0d07a 100644
--- a/src/landings/context/LandingContext.tsx
+++ b/src/landings/context/LandingContext.tsx
@@ -1,10 +1,9 @@
import { createContext, useContext } from 'react'
-import { getFeaturedLinksFromReq } from '@/landings/components/ProductLandingContext'
+import { getFeaturedLinksFromReq } from '@/landings/lib/featured-links'
import { mapRawTocItemToTocItem } from '@/landings/types'
-import type { TocItem } from '@/landings/types'
+import type { TocItem, FeaturedLink } from '@/landings/types'
import type { ExtendedRequest, Context } from '@/types'
import type { JourneyTrack } from '@/journeys/lib/journey-path-resolver'
-import type { FeaturedLink } from '@/landings/components/ProductLandingContext'
export type LandingType = 'bespoke' | 'discovery' | 'journey'
diff --git a/src/landings/lib/featured-links.ts b/src/landings/lib/featured-links.ts
new file mode 100644
index 000000000000..d024a02ce482
--- /dev/null
+++ b/src/landings/lib/featured-links.ts
@@ -0,0 +1,36 @@
+import type { FeaturedLink } from '@/landings/types'
+
+type FeaturedLinkEntry = {
+ href: string
+ title: string
+ intro?: string | null
+ fullTitle?: string | null
+ page?: { authors?: string[] }
+}
+
+type ReqWithFeaturedLinks = {
+ context: {
+ featuredLinks?: Record
+ }
+}
+
+// Helper that reshapes the resolved featured-link data placed on the request
+// by the `featuredLinks` middleware into the FeaturedLink shape consumed by
+// landing page contexts (toc, category, discovery, journey, bespoke).
+export const getFeaturedLinksFromReq = (req: unknown): Record> => {
+ const { context } = req as ReqWithFeaturedLinks
+ return Object.fromEntries(
+ Object.entries(context.featuredLinks || {}).map(([key, entries]) => {
+ return [
+ key,
+ (entries || []).map((entry) => ({
+ href: entry.href,
+ title: entry.title,
+ intro: entry.intro || undefined,
+ authors: entry.page?.authors || [],
+ fullTitle: entry.fullTitle || undefined,
+ })),
+ ]
+ }),
+ )
+}
diff --git a/src/landings/middleware/featured-links.ts b/src/landings/middleware/featured-links.ts
index 5b392600fd1e..d8eae6d4097b 100644
--- a/src/landings/middleware/featured-links.ts
+++ b/src/landings/middleware/featured-links.ts
@@ -5,7 +5,7 @@ import getLinkData from '@/frame/lib/get-link-data'
/**
* This is the max. number of featured links, by any category, that we
- * display on the product landing pages.
+ * display on index landing pages (homepage and TOC landings).
* The reason it's variable is that some featured links are conditional.
* For example:
*
@@ -20,12 +20,15 @@ import getLinkData from '@/frame/lib/get-link-data'
* would end up being blank and thus omitted.
*
* The reason we don't want to display too many is because it might
- * make the product landing page columns that lists links far too
+ * make the landing page columns that lists links far too
* long ("high").
*/
const MAX_FEATURED_LINKS = 4
-// this middleware adds properties to the context object
+// This middleware resolves `featuredLinks` from the page's frontmatter into
+// a `req.context.featuredLinks` object consumed by the homepage and toc
+// landing renderers. It runs for any `index.md` page that defines
+// `featuredLinks` in frontmatter.
export default async function featuredLinks(
req: ExtendedRequest,
res: Response,
@@ -34,13 +37,7 @@ export default async function featuredLinks(
if (!req.context) throw new Error('request is not contextualized')
if (!req.context.page) return next()
- if (
- !(
- req.context.page.relativePath.endsWith('index.md') ||
- req.context.page.layout === 'product-landing'
- )
- )
- return next()
+ if (!req.context.page.relativePath.endsWith('index.md')) return next()
if (!req.context.page.featuredLinks) return next()
diff --git a/src/landings/pages/home.tsx b/src/landings/pages/home.tsx
index f3ccf36fe38f..ee1c8af94287 100644
--- a/src/landings/pages/home.tsx
+++ b/src/landings/pages/home.tsx
@@ -1,5 +1,6 @@
import React from 'react'
import type { GetServerSideProps } from 'next'
+import type { Response } from 'express'
import {
MainContextT,
@@ -14,6 +15,7 @@ import { ArticleList } from '@/landings/components/ArticleList'
import { HomePageHero } from '@/landings/components/HomePageHero'
import type { ProductGroupT } from '@/landings/components/ProductSelections'
import { ProductSelections } from '@/landings/components/ProductSelections'
+import type { ExtendedRequest, FeaturedLinkExpanded } from '@/types'
type FeaturedLink = {
href: string
@@ -78,8 +80,8 @@ function HomePage(props: HomePageProps) {
}
export const getServerSideProps: GetServerSideProps = async (context) => {
- const req = context.req as any
- const res = context.res as any
+ const req = context.req as unknown as ExtendedRequest
+ const res = context.res as unknown as Response
const mainContext = await getMainContext(req, res)
addUINamespaces(req, mainContext.data.ui, ['homepage', 'product_landing'])
@@ -87,15 +89,13 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
return {
props: {
mainContext,
- productGroups: req.context.productGroups,
- gettingStartedLinks: req.context.featuredLinks.gettingStarted.map(
- ({ title, href, intro }: any) => ({ title, href, intro }),
+ productGroups: (req.context!.productGroups || []) as unknown as ProductGroupT[],
+ gettingStartedLinks: (req.context!.featuredLinks?.gettingStarted || []).map(
+ ({ title, href, intro }: FeaturedLinkExpanded) => ({ title, href, intro: intro || '' }),
+ ),
+ popularLinks: (req.context!.featuredLinks?.popular || []).map(
+ ({ title, href, intro }: FeaturedLinkExpanded) => ({ title, href, intro: intro || '' }),
),
- popularLinks: req.context.featuredLinks.popular.map(({ title, href, intro }: any) => ({
- title,
- href,
- intro,
- })),
},
}
}
diff --git a/src/landings/pages/product.tsx b/src/landings/pages/product.tsx
index 038c7b2b8c03..5f4eb31f8b84 100644
--- a/src/landings/pages/product.tsx
+++ b/src/landings/pages/product.tsx
@@ -15,12 +15,6 @@ import {
addUINamespaces,
} from '@/frame/components/context/MainContext'
-import {
- getProductLandingContextFromRequest,
- ProductLandingContextT,
- ProductLandingContext,
-} from '@/landings/components/ProductLandingContext'
-
import {
getArticleContextFromRequest,
ArticleContextT,
@@ -28,7 +22,6 @@ import {
} from '@/frame/components/context/ArticleContext'
import { ArticlePage } from '@/frame/components/article/ArticlePage'
-import { ProductLanding } from '@/landings/components/ProductLanding'
import { TocLanding } from '@/landings/components/TocLanding'
import { CategoryLanding } from '@/landings/components/CategoryLanding'
import {
@@ -58,7 +51,6 @@ function initiateArticleScripts() {
type Props = {
mainContext: MainContextT
- productLandingContext?: ProductLandingContextT
tocLandingContext?: TocLandingContextT
articleContext?: ArticleContextT
categoryLandingContext?: CategoryLandingContextT
@@ -68,7 +60,6 @@ type Props = {
}
const GlobalPage = ({
mainContext,
- productLandingContext,
tocLandingContext,
articleContext,
categoryLandingContext,
@@ -106,12 +97,6 @@ const GlobalPage = ({
-
- )
} else if (categoryLandingContext) {
content = (
@@ -174,9 +159,6 @@ export const getServerSideProps: GetServerSideProps = async (context) =>
} else if (currentLayoutName === 'discovery-landing') {
props.discoveryContext = await getLandingContextFromRequest(req, 'discovery')
additionalUINamespaces.push('product_landing', 'carousels')
- } else if (currentLayoutName === 'product-landing') {
- props.productLandingContext = await getProductLandingContextFromRequest(req)
- additionalUINamespaces.push('product_landing')
} else if (relativePath?.endsWith('index.md')) {
if (currentLayoutName === 'category-landing') {
props.categoryLandingContext = getCategoryLandingContextFromRequest(req)
diff --git a/src/landings/tests/featured-links.ts b/src/landings/tests/featured-links.ts
index 02f638790138..75ee4203a7ba 100644
--- a/src/landings/tests/featured-links.ts
+++ b/src/landings/tests/featured-links.ts
@@ -1,7 +1,6 @@
import { describe, expect, test, vi } from 'vitest'
import { getDOM } from '@/tests/helpers/e2etest'
-import enterpriseServerReleases from '@/versions/lib/enterprise-server-releases'
describe('featuredLinks', () => {
vi.setConfig({ testTimeout: 60 * 1000 })
@@ -24,21 +23,10 @@ describe('featuredLinks', () => {
)
})
- test('Enterprise intro links have expected values', async () => {
+ test('Enterprise get-started landing renders', async () => {
const $ = await getDOM('/en/enterprise-server@latest/get-started')
- const $featuredLinks = $('[data-testid=article-list] a')
- expect($featuredLinks.length).toBeGreaterThan(0)
-
- // Fixture content expectations (CI environment)
- expect($featuredLinks.eq(0).attr('href')).toBe(
- `/en/enterprise-server@${enterpriseServerReleases.latestStable}/get-started/foo/bar`,
- )
- expect($featuredLinks.eq(0).find('[data-testid=link-with-intro-title]').text()).toMatch(
- 'Bar Usually Comes After Foo',
- )
- expect($featuredLinks.eq(0).find('[data-testid=link-with-intro-intro]').text()).toMatch(
- "This page doesn't really have an intro",
- )
+ // get-started uses discovery-landing, so it has hero/spotlight, not article-list.
+ expect($('h1').text()).toMatch(/Getting started/)
})
// This is an important test because one of the popular links,
diff --git a/src/landings/types.ts b/src/landings/types.ts
index f6e0ddcfb763..8fa25ec196e7 100644
--- a/src/landings/types.ts
+++ b/src/landings/types.ts
@@ -4,6 +4,15 @@ import { ValidOcticon, isValidOcticon } from './lib/octicons'
export type { ValidOcticon }
export { isValidOcticon }
+export type FeaturedLink = {
+ title: string
+ href: string
+ intro?: string
+ authors?: Array
+ date?: string
+ fullTitle?: string
+}
+
// Base type for all TOC items with core properties
export type BaseTocItem = {
fullPath: string
diff --git a/src/languages/lib/correct-translation-content.ts b/src/languages/lib/correct-translation-content.ts
index 1df23bd1acd9..1a0376a00a74 100644
--- a/src/languages/lib/correct-translation-content.ts
+++ b/src/languages/lib/correct-translation-content.ts
@@ -183,6 +183,23 @@ export function correctTranslatedContentStrings(
/\{%-?(\s+(?:ifversion|elsif|if)\s+(?:not\s+)?(?:fpt|ghec|ghes|ghae)(?:\s+(?:or|and)\s+(?:not\s+)?(?:fpt|ghec|ghes|ghae))*)\}/g,
'{%$1 %}',
)
+
+ // [SCRAPE-6548] Per-file fix for the Spanish reusable
+ // `data/reusables/dependency-graph/deduplication.md`. The translation
+ // dropped the `{% endif %}` after the Dependabot graph jobs item (the
+ // English source has it, scoped to fpt/ghec). Restore it so the outer
+ // `{% ifversion fpt or ghec %}` block balances. Scoped by both
+ // `dottedPath` (production reusable rendering via get-data.ts) and
+ // `relativePath` (count-translation-corruptions.ts validation path).
+ if (
+ context.dottedPath === 'reusables.dependency-graph.deduplication' ||
+ context.relativePath?.endsWith('data/reusables/dependency-graph/deduplication.md')
+ ) {
+ content = content.replace(
+ 'tienen prioridad sobre el envío automático de dependencias.\n',
+ 'tienen prioridad sobre el envío automático de dependencias.{% endif %}\n',
+ )
+ }
}
if (context.code === 'ja') {
@@ -385,6 +402,58 @@ export function correctTranslatedContentStrings(
content = content.replaceAll('{% Windows ターミナル %}', '{% windows %}')
// `{% indented_data_reference 再利用可能.X.Y spaces=N %}` — translated path
content = content.replace(/(\{%-?\s*indented_data_reference\s+)再利用可能\./g, '$1reusables.')
+
+ // [SCRAPE-6548] Per-file fixes for ja pages whose intro/title/shortTitle
+ // Liquid was structurally scrambled (orphan endif, swapped tag order,
+ // unclosed ifversion). Each replacement is scoped by the unique broken
+ // substring in the source field and rewrites only the broken Liquid; the
+ // Japanese prose is preserved exactly. These run only when context.code is
+ // 'ja' so they cannot affect other languages.
+
+ // admin/managing-iam/iam-configuration-reference/index.md (intro): orphan
+ // `{% endif %}` injected before `{% ifversion ghec %}` — drop it.
+ content = content.replaceAll(
+ '{% data variables.location.product_location %}{% endif %} の認証 {% ifversion ghec %} および Enterprise {% elsif ghes %} のプロビジョニングの構成についての参照情報を表示できます。',
+ '{% data variables.location.product_location %} の認証 {% ifversion ghec %} および Enterprise {% elsif ghes %} のプロビジョニングの構成{% endif %} についての参照情報を表示できます。',
+ )
+
+ // admin/managing-iam/configuring-authentication-for-enterprise-managed-users/configuring-saml-single-sign-on-with-okta-for-enterprise-managed-users.md
+ // (intro): `{% ifversion ghec %}` opens but never closes. Append `{% endif %}`.
+ content = content.replaceAll(
+ '{% ifversion ghec %}{% data variables.product.prodname_dotcom_the_website %} または {% data variables.enterprise.data_residency_site %} で、{% data variables.product.prodname_emus %} の Okta を構成する方法を説明します。',
+ '{% ifversion ghec %}{% data variables.product.prodname_dotcom_the_website %} または {% data variables.enterprise.data_residency_site %} で、{% data variables.product.prodname_emus %} の Okta を構成する方法を説明します。{% endif %}',
+ )
+
+ // admin/managing-iam/provisioning-user-accounts-with-scim/index.md
+ // (title, shortTitle, intro): all three fields have endif/else/elsif/ifversion
+ // tags reordered so they don't parse. Replace each with a clean version.
+ content = content.replaceAll(
+ 'SCIM{% endif %} を使用したエンタープライズ マネージド ユーザー{% else %} 向けのプロビジョニング アカウント{% ifversion ghec %}',
+ '{% ifversion ghec %} SCIM を使用したエンタープライズ マネージド ユーザー{% else %} SCIM 向けのプロビジョニング アカウント{% endif %}',
+ )
+ content = content.replaceAll(
+ 'SCIM{% endif %} を使用して{% ifversion ghec %} マネージド ユーザー アカウント{% else %} アカウントをプロビジョニングする',
+ '{% ifversion ghec %} SCIM を使用して マネージド ユーザー アカウント{% else %} SCIM アカウントをプロビジョニングする{% endif %}',
+ )
+ content = content.replaceAll(
+ '{% data variables.location.product_location %}{% endif %} の {% data variables.enterprise.prodname_emu_enterprise %}{% elsif ghes %} のユーザー{% ifversion ghec %} に対してアカウントをプロビジョニングし、組織とチームのメンバーシップを管理する方法について説明します。',
+ '{% ifversion ghec %} {% data variables.enterprise.prodname_emu_enterprise %}{% elsif ghes %} {% data variables.location.product_location %} のユーザー{% endif %} に対してアカウントをプロビジョニングし、組織とチームのメンバーシップを管理する方法について説明します。',
+ )
+
+ // admin/managing-iam/provisioning-user-accounts-with-scim/configuring-scim-provisioning-for-users.md
+ // (title): tags reordered. Rewrite to a clean structure.
+ content = content.replaceAll(
+ 'ユーザー{% endif %} を管理するためのエンタープライズ マネージド ユーザー{% else %} の SCIM プロビジョニング {% ifversion ghec %} の構成',
+ '{% ifversion ghec %} エンタープライズ マネージド ユーザー{% else %} ユーザー{% endif %} を管理するための SCIM プロビジョニングの構成',
+ )
+
+ // code-security/.../configuring-code-scanning-for-your-appliance.md (intro):
+ // `{% ifversion default-setup-self-hosted-runners-GHEC %}` opens but never
+ // closes within the field. Append a closing `{% endif %}`.
+ content = content.replaceAll(
+ '{% data variables.product.prodname_dotcom %} ホステッド ランナー{% ifversion default-setup-self-hosted-runners-GHEC %}なしのエンタープライズに対して {% data variables.product.prodname_code_scanning %} を有効化、構成、および無効化できます。 {% data variables.product.prodname_code_scanning_caps %} を使用すると、コードの脆弱性やエラーをスキャンできます。',
+ '{% data variables.product.prodname_dotcom %} ホステッド ランナー{% ifversion default-setup-self-hosted-runners-GHEC %}なしのエンタープライズに対して{% endif %} {% data variables.product.prodname_code_scanning %} を有効化、構成、および無効化できます。 {% data variables.product.prodname_code_scanning_caps %} を使用すると、コードの脆弱性やエラーをスキャンできます。',
+ )
}
if (context.code === 'pt') {
@@ -399,6 +468,16 @@ export function correctTranslatedContentStrings(
content = content.replaceAll('{%- dadosvariables', '{%- data variables')
content = content.replaceAll('{% datavariables', '{% data variables')
content = content.replaceAll('{%- datavariables', '{%- data variables')
+ // No space between `{%` and `datavariables` (translator dropped both spaces)
+ content = content.replaceAll('{%datavariables', '{% data variables')
+ content = content.replaceAll('{%-datavariables', '{%- data variables')
+ // `{% data variables.product. prodname_X %}` — stray space inside the dotted
+ // path, just after `.product.`. Liquid tokenizes the path as a single ident,
+ // so the extra space breaks the lookup. Restore.
+ content = content.replace(
+ /\{%(-?)\s*data\s+variables\.product\.\s+(prodname_[A-Za-z0-9_]+)/g,
+ '{%$1 data variables.product.$2',
+ )
// Fully translated reusables path: `{% dados reutilizáveis.X.Y %}` → `{% data reusables.X.Y %}`
content = content.replaceAll('{% dados reutilizáveis.', '{% data reusables.')
// Translated path segment inside reusables path: `repositórios` → `repositories`
@@ -538,6 +617,16 @@ export function correctTranslatedContentStrings(
// `{% modelo %}` / `{% modelo` — `template` (alias for `tool`)? Actually "modelo"
// appears as `{% modelo %}` orphaned. Drop unmatched bare `{% modelo %}` is
// risky; instead, leave as-is (Liquid will raise but rare).
+
+ // Per-file targeted fixes for translator-scrambled Liquid that we can't
+ // catch via generic patterns. These are scoped tightly to the originating
+ // file so they're a no-op everywhere else, and they touch only the
+ // already-broken Liquid fragments — translated prose is preserved.
+ //
+ // [SCRAPE-6548] migrating-between-github-products: intro had a stray space
+ // inside `{% data variables.product. prodname_ghe_cloud %}`. The generic
+ // pt regex above already restored it, but here we only need to confirm —
+ // no extra per-file replacement required.
}
if (context.code === 'zh') {
@@ -628,6 +717,39 @@ export function correctTranslatedContentStrings(
/(\{%-?\s*indented_data_reference\s+)可(?:重|复)用(?:项|组件|s)?\./g,
'$1reusables.',
)
+
+ // [SCRAPE-6548] Per-file fixes for zh pages whose Liquid was structurally
+ // scrambled. Each replacement uses the unique broken substring as a
+ // discriminator so it only fires for the right field of the right file.
+
+ // account-and-profile/concepts/username-changes.md (intro): orphan
+ // `{% endif %}` and `{% ifversion ghes %}` swapped — drop both.
+ content = content.replaceAll(
+ '如果实例使用内置身份验证{% endif %}，则可以更改 {% data variables.product.github %} 帐户 {% ifversion ghes %} 的用户名。',
+ '可以更改 {% data variables.product.github %} 帐户的用户名。{% ifversion ghes %} 如果实例使用内置身份验证。{% endif %}',
+ )
+
+ // admin/managing-iam/using-saml-for-enterprise-iam/index.md (intro):
+ // three `{% ifversion %}` opens against one `{% endif %}`. Rebalance.
+ content = content.replaceAll(
+ '可以通过 SAML 单点登录 (SSO){% ifversion ghec %}和跨域身份管理系统 (SCIM){% endif %} 集中管理 {% ifversion ghes %} 帐户以及对 {% ifversion ghes %}{% data variables.location.product_location %}{% elsif ghec %}你的企业资源{% endif %}的访问权限。',
+ '可以通过 SAML 单点登录 (SSO){% ifversion ghec %}和跨域身份管理系统 (SCIM){% endif %} 集中管理帐户以及对 {% ifversion ghes %}{% data variables.location.product_location %}{% elsif ghec %}你的企业资源{% endif %}的访问权限。',
+ )
+
+ // code-security/.../configuring-access-to-private-registries-for-dependabot.md
+ // (intro): `{% ifversion dependabot-on-actions-self-hosted %}` opens but
+ // never closes. Append `{% endif %}`.
+ content = content.replaceAll(
+ '可以将身份验证信息（如密码和访问令牌）存储为加密机密，然后在配置文件中 {% data variables.product.prodname_dependabot %} 引用这些信息。{% ifversion dependabot-on-actions-self-hosted %} 如果您在专用网络上有注册表，您也可以在使用自托管运行程序执行{% data variables.product.prodname_dependabot %}时配置{% data variables.product.prodname_dependabot %}访问权限。',
+ '可以将身份验证信息（如密码和访问令牌）存储为加密机密，然后在配置文件中 {% data variables.product.prodname_dependabot %} 引用这些信息。{% ifversion dependabot-on-actions-self-hosted %} 如果您在专用网络上有注册表，您也可以在使用自托管运行程序执行{% data variables.product.prodname_dependabot %}时配置{% data variables.product.prodname_dependabot %}访问权限。{% endif %}',
+ )
+
+ // authentication/keeping-your-account-and-data-secure/security-log-events.md
+ // (markdown body line 15): the `> *` bullet has a duplicate
+ // `{% ifversion ghes %}` after the outer `{% ifversion ghes %}` block
+ // already opened on the previous line. Drop the inner duplicate so the
+ // outer endif balances correctly.
+ content = content.replaceAll('> * {% ifversion ghes %} 本文包含', '> * 本文包含')
}
if (context.code === 'ru') {
@@ -864,6 +986,36 @@ export function correctTranslatedContentStrings(
content = content.replace(/\{%-?\s+(?:ifversion|elsif|if)\s+[^%]*?\sи\s[^%]*?-?%\}/g, (m) =>
m.replace(/\sи\s/g, ' and '),
)
+
+ // [SCRAPE-6548] Per-file fixes for ru pages whose Liquid was structurally
+ // scrambled. Each replacement is scoped by the unique broken substring.
+
+ // admin/.../viewing-and-managing-a-users-saml-access-to-your-enterprise.md
+ // (intro): `{% ghec ghec` is not a valid tag and `{% ifversion %}` lacks
+ // an expression. Replace with a clean `{% ifversion ghec %}` ... `{% else %}`
+ // ... `{% endif %}` structure that matches the English source.
+ content = content.replaceAll(
+ 'Вы можете просмотреть и отозвать {% ghec ghec для участников предприятия {% ifversion %}linked identity, активные сеансы и авторизованные учетные данные{%else %}активные сеансы SAML{% endif %}.',
+ 'Вы можете просмотреть и отозвать {% ifversion ghec %}связанные удостоверения, активные сеансы и авторизованные учетные данные участников предприятия{% else %}активные сеансы SAML{% endif %}.',
+ )
+
+ // organizations/.../permissions-of-custom-organization-roles.md (intro):
+ // `{% ifversion org-custom-role-with-repo-permissions %}` opens with an
+ // `{% else %}` branch but never closes. Append `{% endif %}`.
+ content = content.replaceAll(
+ 'Вы можете управлять доступом к параметрам и репозиториям организации {% ifversion org-custom-role-with-repo-permissions %}, а также к параметрам организации {% else %}организации с пользовательскими ролями организации.',
+ 'Вы можете управлять доступом к параметрам и репозиториям организации {% ifversion org-custom-role-with-repo-permissions %}, а также к параметрам организации {% else %}организации с пользовательскими ролями организации.{% endif %}',
+ )
+
+ // packages/.../migrating-to-the-container-registry-from-the-docker-registry.md
+ // (intro): after the existing ru Cat A keyword fixes promote `данных`/
+ // `переменных данных` to `data variables`, this intro is left with an
+ // open `{% ifversion ghes %}` ... `{% else %}` and no `{% endif %}`.
+ // Append it.
+ content = content.replaceAll(
+ '{% ifversion ghes %}Владелец предприятия может{%else %}{% data variables.product.company_short %} перенести образы Docker, ранее хранящиеся в реестре Docker на {% data variables.product.github %} на {% data variables.product.prodname_container_registry %}.',
+ '{% ifversion ghes %}Владелец предприятия может{% else %}{% data variables.product.company_short %} может{% endif %} перенести образы Docker, ранее хранящиеся в реестре Docker на {% data variables.product.github %} на {% data variables.product.prodname_container_registry %}.',
+ )
}
if (context.code === 'fr') {
@@ -1002,6 +1154,23 @@ export function correctTranslatedContentStrings(
content = content.replace(/\{%-?\s+(?:ifversion|elsif|if)\s+[^%]*?\set\s[^%]*?-?%\}/g, (m) =>
m.replace(/\set\s/g, ' and '),
)
+
+ // [SCRAPE-6548] `{% ifversion ghes}` / `{% elsif ghec or ghes}` — translator
+ // dropped the closing `%` before `}`. Same shape as the Spanish fix above.
+ // Match plan name (fpt|ghec|ghes|ghae) followed by `}` not `%}`.
+ content = content.replace(
+ /\{%-?(\s+(?:ifversion|elsif|if)\s+(?:not\s+)?(?:fpt|ghec|ghes|ghae)(?:\s+(?:or|and)\s+(?:not\s+)?(?:fpt|ghec|ghes|ghae))*)\}/g,
+ '{%$1 %}',
+ )
+
+ // [SCRAPE-6548] `{% des … variables.X %}` — translator translated `data`
+ // to `des` and inserted French prose before `variables.`. Tighten by
+ // forbidding `%`, `{`, `}`, `\n` inside the tag, and require `variables.`
+ // immediately before the dotted path.
+ content = content.replace(
+ /\{%(-?)\s*des(?:\s+[^{}%\n]+?)?\s+variables\.([A-Za-z0-9._-]+)(\s*-?%\})/g,
+ '{%$1 data variables.$2$3',
+ )
}
if (context.code === 'ko') {
@@ -1114,6 +1283,16 @@ export function correctTranslatedContentStrings(
// `{% Variable.` (capital V) — variant
content = content.replaceAll('{% Variable.', '{% data variables.')
content = content.replaceAll('{%- Variable.', '{%- data variables.')
+
+ // [SCRAPE-6548] Per-file fix:
+ // account-and-profile/concepts/username-changes.md (intro): orphan
+ // `{% endif %}` and `{% ifversion ghes %}` swapped — the conditional
+ // wraps the wrong piece of prose. Rewrite to wrap the
+ // "if you use built-in authentication" clause inside the ghes branch.
+ content = content.replaceAll(
+ '인스턴스에서 기본 제공 인증{% endif %}를 사용하는 경우 {% data variables.product.github %} 계정 {% ifversion ghes %}의 사용자 이름을 변경할 수 있습니다.',
+ '{% data variables.product.github %} 계정의 사용자 이름을 변경할 수 있습니다.{% ifversion ghes %} 인스턴스에서 기본 제공 인증을 사용하는 경우.{% endif %}',
+ )
}
if (context.code === 'de') {
@@ -1280,6 +1459,15 @@ export function correctTranslatedContentStrings(
// Translated tag name `{% eingerucktes_datenverweis ... %}` → `{% indented_data_reference ... %}`
content = content.replaceAll('{% eingerucktes_datenverweis ', '{% indented_data_reference ')
content = content.replaceAll('{%- eingerucktes_datenverweis ', '{%- indented_data_reference ')
+
+ // [SCRAPE-6548] Per-file fix:
+ // organizations/.../permissions-of-custom-organization-roles.md (intro):
+ // `{% ifversion org-custom-role-with-repo-permissions %}` opens with an
+ // `{% else %}` branch but never closes. Append `{% endif %}`.
+ content = content.replaceAll(
+ 'Mit angepassten Organisationsrollen kannst du den Zugriff auf die Einstellungen deiner {% ifversion org-custom-role-with-repo-permissions %}Organisation und die Repositories{% else %}einer Organisation steuern.',
+ 'Mit angepassten Organisationsrollen kannst du den Zugriff auf die Einstellungen deiner {% ifversion org-custom-role-with-repo-permissions %}Organisation und die Repositories{% else %}einer Organisation{% endif %} steuern.',
+ )
}
// --- Generic fixes (all languages) ---
diff --git a/src/languages/tests/correct-translation-content.ts b/src/languages/tests/correct-translation-content.ts
index 3afdf2bcf042..6b82bb0a507d 100644
--- a/src/languages/tests/correct-translation-content.ts
+++ b/src/languages/tests/correct-translation-content.ts
@@ -1693,4 +1693,144 @@ Para más información, consulta "[AUTOTITLE](/path)".
expect(elapsed).toBeLessThan(2000)
})
})
+
+ // ─── SCRAPE-6548: search-scrape failures ─────────────────────────────
+ // Tests for the per-file Liquid corrections added to stop the daily
+ // search-scrape failures reported in github/docs-engineering#6548.
+ describe('SCRAPE-6548 per-file fixes', () => {
+ function fixAt(content: string, code: string, relativePath: string) {
+ return correctTranslatedContentStrings(content, '', {
+ code,
+ relativePath,
+ skipOrphanStripping: true,
+ })
+ }
+
+ test('pt: {%datavariables (no spaces) → {% data variables', () => {
+ expect(fix('{%datavariables.product.github %}', 'pt')).toBe(
+ '{% data variables.product.github %}',
+ )
+ expect(fix('{%-datavariables.product.github %}', 'pt')).toBe(
+ '{%- data variables.product.github %}',
+ )
+ })
+
+ test('pt: stray space after {% data variables.product.', () => {
+ expect(fix('{% data variables.product. prodname_ghe_cloud %}', 'pt')).toBe(
+ '{% data variables.product.prodname_ghe_cloud %}',
+ )
+ expect(fix('{%- data variables.product. prodname_ghe_server %}', 'pt')).toBe(
+ '{%- data variables.product.prodname_ghe_server %}',
+ )
+ })
+
+ test('pt: leaves correct path alone', () => {
+ const ok = '{% data variables.product.prodname_ghe_cloud %}'
+ expect(fix(ok, 'pt')).toBe(ok)
+ })
+
+ test('fr: missing-% in {% ifversion ghes} / {% elsif ghec or ghes}', () => {
+ expect(fix('{% ifversion ghes}', 'fr')).toBe('{% ifversion ghes %}')
+ expect(fix('{% elsif ghec or ghes}', 'fr')).toBe('{% elsif ghec or ghes %}')
+ })
+
+ test('fr: {% des … variables.X %} → {% data variables.X %}', () => {
+ expect(fix('{% des instances de variables.product.prodname_ghe_server %}', 'fr')).toBe(
+ '{% data variables.product.prodname_ghe_server %}',
+ )
+ })
+
+ test('fr: leaves unrelated `des` prose alone', () => {
+ const ok = 'Les métriques des données sont utiles.'
+ expect(fix(ok, 'fr')).toBe(ok)
+ })
+
+ test('ko: username-changes intro orphan-endif fix', () => {
+ const broken =
+ '인스턴스에서 기본 제공 인증{% endif %}를 사용하는 경우 {% data variables.product.github %} 계정 {% ifversion ghes %}의 사용자 이름을 변경할 수 있습니다.'
+ const out = fixAt(broken, 'ko', 'account-and-profile/concepts/username-changes.md')
+ expect(out).not.toContain('{% endif %}를')
+ expect(out).toContain('{% endif %}')
+ expect(out).toContain('{% ifversion ghes %}')
+ })
+
+ test('zh: username-changes intro orphan-endif fix', () => {
+ const broken =
+ '如果实例使用内置身份验证{% endif %}，则可以更改 {% data variables.product.github %} 帐户 {% ifversion ghes %} 的用户名。'
+ const out = fixAt(broken, 'zh', 'account-and-profile/concepts/username-changes.md')
+ expect(out).not.toContain('{% endif %}，')
+ expect(out).toContain('{% endif %}')
+ })
+
+ test('zh: security-log-events markdown duplicate ifversion ghes', () => {
+ const broken = '> * {% ifversion ghes %} 本文包含最新版本'
+ expect(fix(broken, 'zh')).toBe('> * 本文包含最新版本')
+ })
+
+ test('de: permissions-of-custom-organization-roles intro append endif', () => {
+ const broken =
+ 'Mit angepassten Organisationsrollen kannst du den Zugriff auf die Einstellungen deiner {% ifversion org-custom-role-with-repo-permissions %}Organisation und die Repositories{% else %}einer Organisation steuern.'
+ const out = fixAt(
+ broken,
+ 'de',
+ 'organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles.md',
+ )
+ expect(out).toContain('{% endif %} steuern.')
+ })
+
+ test('ru: permissions-of-custom-organization-roles intro append endif', () => {
+ const broken =
+ 'Вы можете управлять доступом к параметрам и репозиториям организации {% ifversion org-custom-role-with-repo-permissions %}, а также к параметрам организации {% else %}организации с пользовательскими ролями организации.'
+ const out = fixAt(
+ broken,
+ 'ru',
+ 'organizations/managing-peoples-access-to-your-organization-with-roles/permissions-of-custom-organization-roles.md',
+ )
+ expect(out).toMatch(/\{% endif %\}$/)
+ })
+
+ test('ja: scim/index title rebalances tags', () => {
+ const broken =
+ 'SCIM{% endif %} を使用したエンタープライズ マネージド ユーザー{% else %} 向けのプロビジョニング アカウント{% ifversion ghec %}'
+ const out = fix(broken, 'ja')
+ // After fix: balanced ifversion/else/endif and starts with ifversion
+ expect(out).toMatch(/^\{% ifversion ghec %\}/)
+ expect(out).toMatch(/\{% endif %\}$/)
+ expect(out.match(/\{% endif %\}/g) || []).toHaveLength(1)
+ })
+
+ test('es: deduplication reusable appends endif when scoped by dottedPath', () => {
+ const broken = 'tienen prioridad sobre el envío automático de dependencias.\n1. Otra cosa.'
+ const out = correctTranslatedContentStrings(broken, '', {
+ code: 'es',
+ dottedPath: 'reusables.dependency-graph.deduplication',
+ skipOrphanStripping: true,
+ })
+ expect(out).toContain(
+ 'tienen prioridad sobre el envío automático de dependencias.{% endif %}\n',
+ )
+ })
+
+ test('es: deduplication reusable also fires when scoped by relativePath', () => {
+ const broken = 'tienen prioridad sobre el envío automático de dependencias.\n1. Otra cosa.'
+ const out = correctTranslatedContentStrings(broken, '', {
+ code: 'es',
+ relativePath: 'data/reusables/dependency-graph/deduplication.md',
+ skipOrphanStripping: true,
+ })
+ expect(out).toContain(
+ 'tienen prioridad sobre el envío automático de dependencias.{% endif %}\n',
+ )
+ })
+
+ test('es: deduplication fix does NOT fire on unrelated paths', () => {
+ const text = 'tienen prioridad sobre el envío automático de dependencias.\n1. Otra.'
+ const out = correctTranslatedContentStrings(text, '', {
+ code: 'es',
+ relativePath: 'some/other/file.md',
+ skipOrphanStripping: true,
+ })
+ expect(out).toBe(text)
+ })
+ })
})
diff --git a/src/links/scripts/update-internal-links.ts b/src/links/scripts/update-internal-links.ts
index 164cf2400cbc..f6c595508cfb 100755
--- a/src/links/scripts/update-internal-links.ts
+++ b/src/links/scripts/update-internal-links.ts
@@ -207,18 +207,18 @@ async function main(files: string[], opts: Options) {
} else if (opts.check) {
console.log(chalk.green('No changes needed or necessary. 🌈'))
}
- } catch (err: any) {
+ } catch (err) {
if (debug) {
throw err
}
- console.error(chalk.red(err.toString()))
+ console.error(chalk.red(err instanceof Error ? err.toString() : String(err)))
process.exit(1)
}
}
function printObjectDifference(
- objFrom: Record,
- objTo: Record,
+ objFrom: Record,
+ objTo: Record,
rawContent: string,
parentKey = '',
) {
@@ -226,94 +226,109 @@ function printObjectDifference(
// an array, and it's different, print that difference.
for (const [key, value] of Object.entries(objFrom)) {
const combinedKey = `${parentKey}.${key}`
- if (Array.isArray(value) && !equalArray(value, objTo[key])) {
- const printedKeys = new Set()
+ const otherValue = objTo[key]
+ if (Array.isArray(value) && Array.isArray(otherValue) && !equalArray(value, otherValue)) {
+ const printedKeys = new Set()
for (let i = 0; i < value.length; i++) {
const entry = value[i]
+ const otherEntry = otherValue[i]
// If it was an array of objects, we need to go deeper!
- if (isObject(entry)) {
- printObjectDifference(entry, objTo[key][i], rawContent, combinedKey)
+ if (isObject(entry) && isObject(otherEntry)) {
+ printObjectDifference(entry, otherEntry, rawContent, combinedKey)
} else {
- if (entry !== objTo[key][i]) {
+ if (entry !== otherEntry) {
if (!printedKeys.has(combinedKey)) {
console.log(`In frontmatter key: ${chalk.bold(combinedKey)}`)
printedKeys.add(combinedKey)
}
console.log(chalk.red(`- ${entry}`))
- console.log(chalk.green(`+ ${objTo[key][i]}`))
+ console.log(chalk.green(`+ ${otherEntry}`))
const needle = new RegExp(`- ${entry}\\b`)
const index = rawContent.split(/\n/g).findIndex((line) => needle.test(line))
console.log(' ', chalk.dim(`line ${(index && index + 1) || 'unknown'}`))
}
}
}
- } else if (typeof value === 'object' && value !== null) {
- printObjectDifference(value, objTo[key], rawContent, combinedKey)
+ } else if (isObject(value) && isObject(otherValue)) {
+ printObjectDifference(value, otherValue, rawContent, combinedKey)
}
}
}
// This assumes them to be the same shape with possibly different node values
-function equalObject(obj1: Record, obj2: Record) {
+function equalObject(obj1: Record, obj2: Record) {
if (!equalSet(new Set(Object.keys(obj1)), new Set(Object.keys(obj2)))) {
return false
}
for (const [key, value] of Object.entries(obj1)) {
+ const otherValue = obj2[key]
if (Array.isArray(value)) {
+ if (!Array.isArray(otherValue)) return false
// Can't easily compare two arrays because the entries might be objects.
- if (value.length !== obj2[key].length) return false
+ if (value.length !== otherValue.length) return false
let i = 0
for (const each of value) {
- if (isObject(each)) {
- if (!equalObject(each, obj2[key][i])) {
+ const otherEach = otherValue[i]
+ if (isObject(each) && isObject(otherEach)) {
+ if (!equalObject(each, otherEach)) {
return false
}
} else {
- if (each !== obj2[key][i]) {
+ if (each !== otherEach) {
return false
}
}
i++
}
} else if (isObject(value)) {
- if (!equalObject(value, obj2[key])) {
+ if (!isObject(otherValue) || !equalObject(value, otherValue)) {
return false
}
- } else if (value !== obj2[key]) {
+ } else if (value !== otherValue) {
return false
}
}
return true
}
-function isObject(thing: any) {
+function isObject(thing: unknown): thing is Record {
return typeof thing === 'object' && thing !== null && !Array.isArray(thing)
}
-function equalSet(set1: Set, set2: Set) {
+function equalSet(set1: Set, set2: Set) {
return set1.size === set2.size && [...set1].every((x) => set2.has(x))
}
-function equalArray(arr1: any[], arr2: any[]) {
+function equalArray(arr1: unknown[], arr2: unknown[]) {
return arr1.length === arr2.length && arr1.every((item, i) => item === arr2[i])
}
-function countByTree(
- results: {
- data: {
- [key: string]: any
- }
- content: string
- rawContent: string
- newContent: string
- replacements: any[]
- warnings: any[]
- newData: {
- [key: string]: any
- }
- file: string
- }[],
-) {
+type Replacement = {
+ asMarkdown: string
+ newAsMarkdown: string
+ line: number
+ column: number
+}
+
+type Warning = {
+ warning: string
+ asMarkdown: string
+ line: number
+ column: number
+}
+
+type UpdateResult = {
+ data: Record
+ content: string
+ rawContent: string
+ newContent: string
+ replacements: Replacement[]
+ warnings: Warning[]
+ newData: Record
+ file: string
+}
+
+function countByTree(results: UpdateResult[]) {
const files: Record = {}
const changes: Record = {}
for (const { file, replacements } of results) {
diff --git a/src/observability/lib/tracing.ts b/src/observability/lib/tracing.ts
index 1e782f262be0..894d4406cf36 100644
--- a/src/observability/lib/tracing.ts
+++ b/src/observability/lib/tracing.ts
@@ -26,14 +26,8 @@ import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express'
import { HttpInstrumentation } from '@opentelemetry/instrumentation-http'
import { UndiciInstrumentation } from '@opentelemetry/instrumentation-undici'
import { NodeSDK } from '@opentelemetry/sdk-node'
-import { diag, DiagConsoleLogger, DiagLogLevel } from '@opentelemetry/api'
-// TEMPORARY: enable OTel diagnostic logging to investigate why traces aren't
-// arriving in the collector. See github/docs-engineering#6046. Revert once
-// the export pipeline is confirmed working.
if (process.env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT) {
- diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.INFO)
-
const sdk = new NodeSDK({
serviceName: process.env.OTEL_SERVICE_NAME || 'docs-internal',
traceExporter: new OTLPTraceExporter({}),
diff --git a/src/redirects/lib/static/redirect-exceptions.txt b/src/redirects/lib/static/redirect-exceptions.txt
index 7bf99b7f62f6..9f7a56931291 100644
--- a/src/redirects/lib/static/redirect-exceptions.txt
+++ b/src/redirects/lib/static/redirect-exceptions.txt
@@ -48,8 +48,3 @@
- /github-ae@latest/admin/overview/about-data-residency
- /github-ae@latest/admin/overview/deploying-github-ae
- /github-ae@latest/admin/overview/initializing-github-ae
-
-# Agent tasks REST API was rolled back before launch
-/rest
-- /rest/agent-tasks
-- /rest/agent-tasks/agent-tasks
diff --git a/src/rest/data/fpt-2022-11-28/actions.json b/src/rest/data/fpt-2022-11-28/actions.json
index 0a0b8005c020..18a98ba54ed3 100644
--- a/src/rest/data/fpt-2022-11-28/actions.json
+++ b/src/rest/data/fpt-2022-11-28/actions.json
@@ -2520,6 +2520,657 @@
}
}
],
+ "concurrency-groups": [
+ {
+ "serverUrl": "https://api.github.com",
+ "verb": "get",
+ "requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups",
+ "title": "List concurrency groups for a repository",
+ "category": "actions",
+ "subcategory": "concurrency-groups",
+ "parameters": [
+ {
+ "name": "owner",
+ "description": "\n\n\n\n\n/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -333,14 +342,15 @@
{
"type": "string",
"name": "auth_type",
- "description": "/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -659,7 +688,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -745,6 +775,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -959,7 +997,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -1041,6 +1080,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -1184,7 +1231,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
]
},
{
@@ -1230,7 +1278,7 @@
{
"type": "string",
"name": "audience",
- "description": "\n\n\n\n\n/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -333,14 +342,15 @@
{
"type": "string",
"name": "auth_type",
- "description": "/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -659,7 +688,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -745,6 +775,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -959,7 +997,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -1041,6 +1080,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -1184,7 +1231,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
]
},
{
@@ -1230,7 +1278,7 @@
{
"type": "string",
"name": "audience",
- "description": "\n\n\n\n\n/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -333,14 +342,15 @@
{
"type": "string",
"name": "auth_type",
- "description": "/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -659,7 +688,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -745,6 +775,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -959,7 +997,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -1041,6 +1080,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -1184,7 +1231,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
]
},
{
@@ -1230,7 +1278,7 @@
{
"type": "string",
"name": "audience",
- "description": "\n\n\n\n\n/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -333,14 +342,15 @@
{
"type": "string",
"name": "auth_type",
- "description": "/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -659,7 +688,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -745,6 +775,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -959,7 +997,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -1041,6 +1080,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -1184,7 +1231,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
]
},
{
@@ -1230,7 +1278,7 @@
{
"type": "string",
"name": "audience",
- "description": "/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -413,7 +422,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -495,6 +505,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -638,7 +656,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
]
},
{
@@ -684,7 +703,7 @@
{
"type": "string",
"name": "audience",
- "description": "/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -413,7 +422,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -495,6 +505,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -638,7 +656,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
]
},
{
@@ -684,7 +703,7 @@
{
"type": "string",
"name": "audience",
- "description": "/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -333,14 +342,15 @@
{
"type": "string",
"name": "auth_type",
- "description": "/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -659,7 +688,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -745,6 +775,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -959,7 +997,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -1041,6 +1080,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -1184,7 +1231,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
]
},
{
@@ -1230,7 +1278,7 @@
{
"type": "string",
"name": "audience",
- "description": "/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -333,14 +342,15 @@
{
"type": "string",
"name": "auth_type",
- "description": "/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -659,7 +688,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -745,6 +775,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -959,7 +997,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -1041,6 +1080,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -1184,7 +1231,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
]
},
{
@@ -1230,7 +1278,7 @@
{
"type": "string",
"name": "audience",
- "description": "/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -333,14 +342,15 @@
{
"type": "string",
"name": "auth_type",
- "description": "/locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -659,7 +688,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -745,6 +775,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -959,7 +997,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
],
"type": "string"
},
@@ -1041,6 +1080,14 @@
"description": "The Cloudsmith API host.",
"type": "string"
},
+ "workload_identity_provider": {
+ "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects//locations/global/workloadIdentityPools//providers/`).",
+ "type": "string"
+ },
+ "service_account": {
+ "description": "The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).",
+ "type": "string"
+ },
"created_at": {
"type": "string",
"format": "date-time"
@@ -1184,7 +1231,8 @@
"oidc_azure",
"oidc_aws",
"oidc_jfrog",
- "oidc_cloudsmith"
+ "oidc_cloudsmith",
+ "oidc_gcp"
]
},
{
@@ -1230,7 +1278,7 @@
{
"type": "string",
"name": "audience",
- "description": " {
method?: string
- body?: any
+ body?: RequestInit['body']
followRedirects?: boolean
followAllRedirects?: boolean
headers?: Record
@@ -191,7 +191,7 @@ export async function getDOM(route: string, options: GetDOMOptions = {}): Promis
* @param opts - Options for the request.
* @returns A promise that resolves to the parsed JSON object.
*/
-export async function getJSON(
+export async function getJSON(
route: string,
opts: Omit = {},
): Promise {
diff --git a/src/types/types.ts b/src/types/types.ts
index 896237334f2c..ced06419308a 100644
--- a/src/types/types.ts
+++ b/src/types/types.ts
@@ -155,7 +155,6 @@ export type Context = {
redirectNotFound?: string
earlyAccessPageLinks?: string
changelogUrl?: string
- whatsNewChangelog?: ChangelogItem[]
secretScanningData?: SecretScanningData[]
ghesReleases?: GHESRelease[]
ghesReleaseNotes?: GHESReleasePatch[]
@@ -173,8 +172,6 @@ export type Context = {
breadcrumbs?: Breadcrumb[]
glossaries?: Glossary[]
currentProductName?: string
- productCommunityExamples?: ProductExample[]
- productUserExamples?: ProductExample[]
productGroups?: ProductGroup[]
featuredLinks?: FeaturedLinksExpanded
renderedPage?: string
@@ -270,12 +267,6 @@ export type ReleaseNotes = {
}
}
-export type ChangelogItem = {
- title: string
- date: string
- href: string
-}
-
export type SecretScanningData = {
provider: string
supportedSecret: string
@@ -437,12 +428,6 @@ export type AllVersions = {
// is not possible to happen at runtime.
export type URLSearchParamsTypes = string | string[][] | Record | URLSearchParams
-export type ProductExample = {
- repo?: string
- user?: string
- description: string
-}
-
export type FeatureData = {
[key: string]: Versions
}
diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json
index 7b9bdef0a537..28574f6f1461 100644
--- a/src/webhooks/lib/config.json
+++ b/src/webhooks/lib/config.json
@@ -1,3 +1,3 @@
{
- "sha": "d3a3c2a50bb45b5f437bdfd8e0c700091bb1fb7b"
+ "sha": "12330abe1a9651268439945b92312855bb071532"
}
\ No newline at end of file
The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Lists the active concurrency groups for a repository.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Response
", + "example": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "last_acquired_at": "2026-01-15T16:14:23Z" + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "last_acquired_at": "2026-01-15T16:13:55Z" + } + ] + }, + "schema": { + "title": "Concurrency Group List", + "description": "A list of active concurrency groups for a repository.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "last_acquired_at" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "last_acquired_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}", + "title": "Get a concurrency group for a repository", + "category": "actions", + "subcategory": "concurrency-groups", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The name of the concurrency group.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ahead_of_run", + "description": "Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with ahead_of_job.
Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with ahead_of_run.
Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.
\nOptionally, pass ahead_of_run or ahead_of_job to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.
When using ahead_of_run, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use ahead_of_job to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Response
", + "example": { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "total_count": 3, + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress" + }, + { + "run_id": 30433643, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433643", + "status": "pending" + }, + { + "run_id": 30433644, + "run_name": "Deploy hotfix", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644", + "job_id": 798245260, + "job_name": "deploy", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260", + "status": "pending" + } + ] + }, + "schema": { + "title": "Concurrency Group", + "description": "A concurrency group with the workflow runs and jobs that are either currently holding\nor waiting for the concurrency group lease.", + "type": "object", + "required": [ + "group_name", + "group_url", + "total_count", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "total_count": { + "type": "integer" + }, + "group_members": { + "type": "array", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "job_id": { + "type": "integer", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups", + "title": "List concurrency groups for a workflow run", + "category": "actions", + "subcategory": "concurrency-groups", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The unique identifier of the workflow run.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Lists all concurrency groups associated with a workflow run or its jobs.
\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the group_members array will be empty.\ntotal_count reflects the number of groups the run participates in by\nconfiguration, not the number with active items.
This differs from GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name},\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.
Results are sorted by group name and support cursor-based pagination via\nbefore and after. The after cursor paginates forward only and does\nnot emit a rel=\"prev\" Link; use before to page backward from a\nforward page's next cursor.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Response
", + "example": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress", + "position": 0, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642" + } + ] + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "pending", + "position": 2, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260", + "job_id": 798245260, + "job_name": "build", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260" + } + ] + } + ] + }, + "schema": { + "title": "Concurrency Group Run List", + "description": "A list of concurrency groups associated with a workflow run.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of concurrency groups this workflow run participates in,\nderived from the run's configuration. This count is not filtered by\nwhether the run currently holds or is waiting in each group, so it can\ninclude groups whose `group_members` array is empty (for example, when\nthe run has already released its lease in that group)." + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group. May return 404 if the group\nhas no active items at the time it is requested, since the\nget-by-name endpoint reports the live repo-wide state of a group\nwhile this endpoint lists groups associated with a run by\nconfiguration." + }, + "group_members": { + "type": "array", + "description": "Items belonging to this workflow run that are either currently holding or\nwaiting for the concurrency group lease. May be empty if the run no\nlonger has any active or queued items in this group.", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status", + "position", + "position_url" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "position": { + "type": "integer", + "description": "Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending)." + }, + "position_url": { + "type": "string", + "format": "uri", + "description": "API URL to get items ahead of this item in the concurrency group." + }, + "job_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": [ + "string", + "null" + ], + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + } + } + ], "hosted-runners": [ { "serverUrl": "https://api.github.com", @@ -27008,6 +27659,12 @@ "name": "enable_debug_logging", "description": "Whether to enable debug logging for the re-run.
", "default": false + }, + { + "type": "boolean", + "name": "enable_debugger", + "description": "Whether to enable the debugger for the re-run of this job.
", + "default": false } ], "descriptionHTML": "Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The account owner of the repository. The name is not case sensitive.
" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive.
" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100).
" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch.
" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be updated_at or created_at.
The direction to sort results. Can be asc or desc.
Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.
Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false.
Only show tasks updated at or after this time (ISO 8601 timestamp)
" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a list of tasks for a specific repository
\nFine-grained access tokens for \"List tasks for repository\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Tasks retrieved successfully
", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Tasks retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/agents/repos/{owner}/{repo}/tasks", + "title": "Start a task", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive.
" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive.
" + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "prompt", + "description": "The user's prompt for the agent
", + "isRequired": true + }, + { + "type": "string", + "name": "model", + "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: claude-sonnet-4.6, claude-opus-4.6, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4, claude-sonnet-4.5, claude-opus-4.5
Whether to create a PR.
", + "default": false + }, + { + "type": "string", + "name": "base_ref", + "description": "Base ref for new branch/PR
" + } + ], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nStarts a new Copilot cloud agent task for a repository.
\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.
\nFine-grained access tokens for \"Start a task\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read and write) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Task created successfully
", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Task created successfully
" + }, + { + "httpStatusCode": "400", + "description": "Problems parsing JSON
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/repos/{owner}/{repo}/tasks/{task_id}", + "title": "Get a task by repo", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive.
" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive.
" + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task.
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a task by ID scoped to an owner/repo path
\nFine-grained access tokens for \"Get a task by repo\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "task_id": "TASK_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Task retrieved successfully
", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "prompt": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main", + "model": "claude-sonnet-4.6" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Task retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks", + "title": "List tasks", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100).
" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch.
" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be updated_at or created_at.
The direction to sort results. Can be asc or desc.
Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.
Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false.
Only show tasks updated at or after this time (ISO 8601 timestamp)
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a list of tasks for the authenticated user
\nFine-grained access tokens for \"List tasks\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Tasks retrieved successfully
", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Tasks retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks/{task_id}", + "title": "Get a task by ID", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task.
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a task by ID with its associated sessions
\nFine-grained access tokens for \"Get a task by ID\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "task_id": "TASK_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Task retrieved successfully
", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "prompt": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main", + "model": "claude-sonnet-4.6" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Task retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Problems parsing request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + } + ] +} \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/orgs.json b/src/rest/data/fpt-2022-11-28/orgs.json index 08510d45c578..d4b83b4bef45 100644 --- a/src/rest/data/fpt-2022-11-28/orgs.json +++ b/src/rest/data/fpt-2022-11-28/orgs.json @@ -5561,19 +5561,19 @@ { "type": "string", "name": "name", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.
", + "description": "The name of the artifact.
", "isRequired": true }, { "type": "string", "name": "digest", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.
", + "description": "The hex encoded digest of the artifact.
", "isRequired": true }, { "type": "string", "name": "version", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.
" + "description": "The artifact version.
" }, { "type": "string", @@ -5615,7 +5615,7 @@ "default": true } ], - "descriptionHTML": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.
", + "descriptionHTML": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.
", "codeExamples": [ { "request": { diff --git a/src/rest/data/fpt-2022-11-28/private-registries.json b/src/rest/data/fpt-2022-11-28/private-registries.json index 4a2241ec4b4a..5fe0e8fe34cf 100644 --- a/src/rest/data/fpt-2022-11-28/private-registries.json +++ b/src/rest/data/fpt-2022-11-28/private-registries.json @@ -114,7 +114,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -196,6 +197,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects/The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith for OIDC authentication.
The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp for OIDC authentication.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
A boolean value (true or false) indicating whether to filter alerts by their push protection bypass status. When set to true, only alerts that were created because a push protection rule was bypassed will be returned. When set to false, only alerts that were not caused by a push protection bypass will be returned.
A boolean value (true or false) indicating whether to filter alerts by their push protection bypass status. When set to true, only alerts that were created because a push protection rule was bypassed will be returned. When set to false, only alerts that were not caused by a push protection bypass will be returned.
Bad request, resolution comment is invalid or the resolution was not changed.
" }, + { + "httpStatusCode": "403", + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer.
" + }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" diff --git a/src/rest/data/fpt-2026-03-10/actions.json b/src/rest/data/fpt-2026-03-10/actions.json index 044ce0c19d67..73cb97a83062 100644 --- a/src/rest/data/fpt-2026-03-10/actions.json +++ b/src/rest/data/fpt-2026-03-10/actions.json @@ -2520,6 +2520,657 @@ } } ], + "concurrency-groups": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups", + "title": "List concurrency groups for a repository", + "category": "actions", + "subcategory": "concurrency-groups", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Lists the active concurrency groups for a repository.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Response
", + "example": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "last_acquired_at": "2026-01-15T16:14:23Z" + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "last_acquired_at": "2026-01-15T16:13:55Z" + } + ] + }, + "schema": { + "title": "Concurrency Group List", + "description": "A list of active concurrency groups for a repository.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "last_acquired_at" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "last_acquired_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}", + "title": "Get a concurrency group for a repository", + "category": "actions", + "subcategory": "concurrency-groups", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The name of the concurrency group.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ahead_of_run", + "description": "Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with ahead_of_job.
Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with ahead_of_run.
Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.
\nOptionally, pass ahead_of_run or ahead_of_job to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.
When using ahead_of_run, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use ahead_of_job to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Response
", + "example": { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "total_count": 3, + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress" + }, + { + "run_id": 30433643, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433643", + "status": "pending" + }, + { + "run_id": 30433644, + "run_name": "Deploy hotfix", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644", + "job_id": 798245260, + "job_name": "deploy", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260", + "status": "pending" + } + ] + }, + "schema": { + "title": "Concurrency Group", + "description": "A concurrency group with the workflow runs and jobs that are either currently holding\nor waiting for the concurrency group lease.", + "type": "object", + "required": [ + "group_name", + "group_url", + "total_count", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "total_count": { + "type": "integer" + }, + "group_members": { + "type": "array", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "job_id": { + "type": "integer", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups", + "title": "List concurrency groups for a workflow run", + "category": "actions", + "subcategory": "concurrency-groups", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The unique identifier of the workflow run.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Lists all concurrency groups associated with a workflow run or its jobs.
\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the group_members array will be empty.\ntotal_count reflects the number of groups the run participates in by\nconfiguration, not the number with active items.
This differs from GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name},\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.
Results are sorted by group name and support cursor-based pagination via\nbefore and after. The after cursor paginates forward only and does\nnot emit a rel=\"prev\" Link; use before to page backward from a\nforward page's next cursor.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Response
", + "example": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress", + "position": 0, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642" + } + ] + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "pending", + "position": 2, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260", + "job_id": 798245260, + "job_name": "build", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260" + } + ] + } + ] + }, + "schema": { + "title": "Concurrency Group Run List", + "description": "A list of concurrency groups associated with a workflow run.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of concurrency groups this workflow run participates in,\nderived from the run's configuration. This count is not filtered by\nwhether the run currently holds or is waiting in each group, so it can\ninclude groups whose `group_members` array is empty (for example, when\nthe run has already released its lease in that group)." + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group. May return 404 if the group\nhas no active items at the time it is requested, since the\nget-by-name endpoint reports the live repo-wide state of a group\nwhile this endpoint lists groups associated with a run by\nconfiguration." + }, + "group_members": { + "type": "array", + "description": "Items belonging to this workflow run that are either currently holding or\nwaiting for the concurrency group lease. May be empty if the run no\nlonger has any active or queued items in this group.", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status", + "position", + "position_url" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "position": { + "type": "integer", + "description": "Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending)." + }, + "position_url": { + "type": "string", + "format": "uri", + "description": "API URL to get items ahead of this item in the concurrency group." + }, + "job_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": [ + "string", + "null" + ], + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + } + } + ], "hosted-runners": [ { "serverUrl": "https://api.github.com", @@ -26903,6 +27554,12 @@ "name": "enable_debug_logging", "description": "Whether to enable debug logging for the re-run.
", "default": false + }, + { + "type": "boolean", + "name": "enable_debugger", + "description": "Whether to enable the debugger for the re-run of this job.
", + "default": false } ], "descriptionHTML": "Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The account owner of the repository. The name is not case sensitive.
" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive.
" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100).
" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch.
" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be updated_at or created_at.
The direction to sort results. Can be asc or desc.
Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.
Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false.
Only show tasks updated at or after this time (ISO 8601 timestamp)
" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a list of tasks for a specific repository
\nFine-grained access tokens for \"List tasks for repository\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Tasks retrieved successfully
", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Tasks retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/agents/repos/{owner}/{repo}/tasks", + "title": "Start a task", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive.
" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive.
" + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "prompt", + "description": "The user's prompt for the agent
", + "isRequired": true + }, + { + "type": "string", + "name": "model", + "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: claude-sonnet-4.6, claude-opus-4.6, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4, claude-sonnet-4.5, claude-opus-4.5
Whether to create a PR.
", + "default": false + }, + { + "type": "string", + "name": "base_ref", + "description": "Base ref for new branch/PR
" + } + ], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nStarts a new Copilot cloud agent task for a repository.
\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.
\nFine-grained access tokens for \"Start a task\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read and write) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Task created successfully
", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Task created successfully
" + }, + { + "httpStatusCode": "400", + "description": "Problems parsing JSON
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/repos/{owner}/{repo}/tasks/{task_id}", + "title": "Get a task by repo", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive.
" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive.
" + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task.
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a task by ID scoped to an owner/repo path
\nFine-grained access tokens for \"Get a task by repo\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "task_id": "TASK_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Task retrieved successfully
", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "prompt": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main", + "model": "claude-sonnet-4.6" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Task retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks", + "title": "List tasks", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100).
" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch.
" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be updated_at or created_at.
The direction to sort results. Can be asc or desc.
Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.
Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false.
Only show tasks updated at or after this time (ISO 8601 timestamp)
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a list of tasks for the authenticated user
\nFine-grained access tokens for \"List tasks\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Tasks retrieved successfully
", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Tasks retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks/{task_id}", + "title": "Get a task by ID", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task.
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a task by ID with its associated sessions
\nFine-grained access tokens for \"Get a task by ID\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "task_id": "TASK_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Task retrieved successfully
", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "prompt": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main", + "model": "claude-sonnet-4.6" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Task retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Problems parsing request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + } + ] +} \ No newline at end of file diff --git a/src/rest/data/fpt-2026-03-10/orgs.json b/src/rest/data/fpt-2026-03-10/orgs.json index 77e8e98d98b3..eaf051c33cdb 100644 --- a/src/rest/data/fpt-2026-03-10/orgs.json +++ b/src/rest/data/fpt-2026-03-10/orgs.json @@ -5547,19 +5547,19 @@ { "type": "string", "name": "name", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.
", + "description": "The name of the artifact.
", "isRequired": true }, { "type": "string", "name": "digest", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.
", + "description": "The hex encoded digest of the artifact.
", "isRequired": true }, { "type": "string", "name": "version", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.
" + "description": "The artifact version.
" }, { "type": "string", @@ -5601,7 +5601,7 @@ "default": true } ], - "descriptionHTML": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.
", + "descriptionHTML": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.
", "codeExamples": [ { "request": { diff --git a/src/rest/data/fpt-2026-03-10/private-registries.json b/src/rest/data/fpt-2026-03-10/private-registries.json index 4a2241ec4b4a..5fe0e8fe34cf 100644 --- a/src/rest/data/fpt-2026-03-10/private-registries.json +++ b/src/rest/data/fpt-2026-03-10/private-registries.json @@ -114,7 +114,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -196,6 +197,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects/The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith for OIDC authentication.
The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp for OIDC authentication.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
A boolean value (true or false) indicating whether to filter alerts by their push protection bypass status. When set to true, only alerts that were created because a push protection rule was bypassed will be returned. When set to false, only alerts that were not caused by a push protection bypass will be returned.
A boolean value (true or false) indicating whether to filter alerts by their push protection bypass status. When set to true, only alerts that were created because a push protection rule was bypassed will be returned. When set to false, only alerts that were not caused by a push protection bypass will be returned.
Bad request, resolution comment is invalid or the resolution was not changed.
" }, + { + "httpStatusCode": "403", + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer.
" + }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" diff --git a/src/rest/data/ghec-2022-11-28/actions.json b/src/rest/data/ghec-2022-11-28/actions.json index f20d151c5765..e779f5987e92 100644 --- a/src/rest/data/ghec-2022-11-28/actions.json +++ b/src/rest/data/ghec-2022-11-28/actions.json @@ -2596,6 +2596,657 @@ } } ], + "concurrency-groups": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups", + "title": "List concurrency groups for a repository", + "category": "actions", + "subcategory": "concurrency-groups", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Lists the active concurrency groups for a repository.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Response
", + "example": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "last_acquired_at": "2026-01-15T16:14:23Z" + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "last_acquired_at": "2026-01-15T16:13:55Z" + } + ] + }, + "schema": { + "title": "Concurrency Group List", + "description": "A list of active concurrency groups for a repository.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "last_acquired_at" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "last_acquired_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}", + "title": "Get a concurrency group for a repository", + "category": "actions", + "subcategory": "concurrency-groups", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The name of the concurrency group.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ahead_of_run", + "description": "Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with ahead_of_job.
Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with ahead_of_run.
Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.
\nOptionally, pass ahead_of_run or ahead_of_job to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.
When using ahead_of_run, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use ahead_of_job to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Response
", + "example": { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "total_count": 3, + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress" + }, + { + "run_id": 30433643, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433643", + "status": "pending" + }, + { + "run_id": 30433644, + "run_name": "Deploy hotfix", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644", + "job_id": 798245260, + "job_name": "deploy", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260", + "status": "pending" + } + ] + }, + "schema": { + "title": "Concurrency Group", + "description": "A concurrency group with the workflow runs and jobs that are either currently holding\nor waiting for the concurrency group lease.", + "type": "object", + "required": [ + "group_name", + "group_url", + "total_count", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "total_count": { + "type": "integer" + }, + "group_members": { + "type": "array", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "job_id": { + "type": "integer", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups", + "title": "List concurrency groups for a workflow run", + "category": "actions", + "subcategory": "concurrency-groups", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The unique identifier of the workflow run.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Lists all concurrency groups associated with a workflow run or its jobs.
\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the group_members array will be empty.\ntotal_count reflects the number of groups the run participates in by\nconfiguration, not the number with active items.
This differs from GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name},\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.
Results are sorted by group name and support cursor-based pagination via\nbefore and after. The after cursor paginates forward only and does\nnot emit a rel=\"prev\" Link; use before to page backward from a\nforward page's next cursor.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Response
", + "example": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress", + "position": 0, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642" + } + ] + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "pending", + "position": 2, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260", + "job_id": 798245260, + "job_name": "build", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260" + } + ] + } + ] + }, + "schema": { + "title": "Concurrency Group Run List", + "description": "A list of concurrency groups associated with a workflow run.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of concurrency groups this workflow run participates in,\nderived from the run's configuration. This count is not filtered by\nwhether the run currently holds or is waiting in each group, so it can\ninclude groups whose `group_members` array is empty (for example, when\nthe run has already released its lease in that group)." + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group. May return 404 if the group\nhas no active items at the time it is requested, since the\nget-by-name endpoint reports the live repo-wide state of a group\nwhile this endpoint lists groups associated with a run by\nconfiguration." + }, + "group_members": { + "type": "array", + "description": "Items belonging to this workflow run that are either currently holding or\nwaiting for the concurrency group lease. May be empty if the run no\nlonger has any active or queued items in this group.", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status", + "position", + "position_url" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "position": { + "type": "integer", + "description": "Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending)." + }, + "position_url": { + "type": "string", + "format": "uri", + "description": "API URL to get items ahead of this item in the concurrency group." + }, + "job_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": [ + "string", + "null" + ], + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + } + } + ], "hosted-runners": [ { "serverUrl": "https://api.github.com", @@ -35707,6 +36358,12 @@ "name": "enable_debug_logging", "description": "Whether to enable debug logging for the re-run.
", "default": false + }, + { + "type": "boolean", + "name": "enable_debugger", + "description": "Whether to enable the debugger for the re-run of this job.
", + "default": false } ], "descriptionHTML": "Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The account owner of the repository. The name is not case sensitive.
" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive.
" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100).
" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch.
" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be updated_at or created_at.
The direction to sort results. Can be asc or desc.
Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.
Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false.
Only show tasks updated at or after this time (ISO 8601 timestamp)
" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a list of tasks for a specific repository
\nFine-grained access tokens for \"List tasks for repository\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Tasks retrieved successfully
", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Tasks retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/agents/repos/{owner}/{repo}/tasks", + "title": "Start a task", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive.
" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive.
" + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "prompt", + "description": "The user's prompt for the agent
", + "isRequired": true + }, + { + "type": "string", + "name": "model", + "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: claude-sonnet-4.6, claude-opus-4.6, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4, claude-sonnet-4.5, claude-opus-4.5
Whether to create a PR.
", + "default": false + }, + { + "type": "string", + "name": "base_ref", + "description": "Base ref for new branch/PR
" + } + ], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nStarts a new Copilot cloud agent task for a repository.
\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.
\nFine-grained access tokens for \"Start a task\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read and write) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Task created successfully
", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Task created successfully
" + }, + { + "httpStatusCode": "400", + "description": "Problems parsing JSON
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/repos/{owner}/{repo}/tasks/{task_id}", + "title": "Get a task by repo", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive.
" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive.
" + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task.
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a task by ID scoped to an owner/repo path
\nFine-grained access tokens for \"Get a task by repo\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "task_id": "TASK_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Task retrieved successfully
", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "prompt": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main", + "model": "claude-sonnet-4.6" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Task retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks", + "title": "List tasks", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100).
" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch.
" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be updated_at or created_at.
The direction to sort results. Can be asc or desc.
Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.
Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false.
Only show tasks updated at or after this time (ISO 8601 timestamp)
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a list of tasks for the authenticated user
\nFine-grained access tokens for \"List tasks\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Tasks retrieved successfully
", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Tasks retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks/{task_id}", + "title": "Get a task by ID", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task.
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a task by ID with its associated sessions
\nFine-grained access tokens for \"Get a task by ID\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "task_id": "TASK_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Task retrieved successfully
", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "prompt": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main", + "model": "claude-sonnet-4.6" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Task retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Problems parsing request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + } + ] +} \ No newline at end of file diff --git a/src/rest/data/ghec-2022-11-28/orgs.json b/src/rest/data/ghec-2022-11-28/orgs.json index 44ec1db1690c..01fb473e4fd4 100644 --- a/src/rest/data/ghec-2022-11-28/orgs.json +++ b/src/rest/data/ghec-2022-11-28/orgs.json @@ -6183,19 +6183,19 @@ { "type": "string", "name": "name", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.
", + "description": "The name of the artifact.
", "isRequired": true }, { "type": "string", "name": "digest", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.
", + "description": "The hex encoded digest of the artifact.
", "isRequired": true }, { "type": "string", "name": "version", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.
" + "description": "The artifact version.
" }, { "type": "string", @@ -6237,7 +6237,7 @@ "default": true } ], - "descriptionHTML": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.
", + "descriptionHTML": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2022-11-28/private-registries.json b/src/rest/data/ghec-2022-11-28/private-registries.json index 7611ea603ce1..b7033ebf2b6d 100644 --- a/src/rest/data/ghec-2022-11-28/private-registries.json +++ b/src/rest/data/ghec-2022-11-28/private-registries.json @@ -114,7 +114,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -196,6 +197,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects/The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith for OIDC authentication.
The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp for OIDC authentication.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
A boolean value (true or false) indicating whether to filter alerts by their push protection bypass status. When set to true, only alerts that were created because a push protection rule was bypassed will be returned. When set to false, only alerts that were not caused by a push protection bypass will be returned.
A boolean value (true or false) indicating whether to filter alerts by their push protection bypass status. When set to true, only alerts that were created because a push protection rule was bypassed will be returned. When set to false, only alerts that were not caused by a push protection bypass will be returned.
A boolean value (true or false) indicating whether to filter alerts by their push protection bypass status. When set to true, only alerts that were created because a push protection rule was bypassed will be returned. When set to false, only alerts that were not caused by a push protection bypass will be returned.
Bad request, resolution comment is invalid or the resolution was not changed.
" }, + { + "httpStatusCode": "403", + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer.
" + }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" diff --git a/src/rest/data/ghec-2026-03-10/actions.json b/src/rest/data/ghec-2026-03-10/actions.json index 03b1abf38051..0a138046c195 100644 --- a/src/rest/data/ghec-2026-03-10/actions.json +++ b/src/rest/data/ghec-2026-03-10/actions.json @@ -2596,6 +2596,657 @@ } } ], + "concurrency-groups": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups", + "title": "List concurrency groups for a repository", + "category": "actions", + "subcategory": "concurrency-groups", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Lists the active concurrency groups for a repository.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Response
", + "example": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "last_acquired_at": "2026-01-15T16:14:23Z" + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "last_acquired_at": "2026-01-15T16:13:55Z" + } + ] + }, + "schema": { + "title": "Concurrency Group List", + "description": "A list of active concurrency groups for a repository.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "last_acquired_at" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "last_acquired_at": { + "type": [ + "string", + "null" + ], + "format": "date-time" + } + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/concurrency_groups/{concurrency_group_name}", + "title": "Get a concurrency group for a repository", + "category": "actions", + "subcategory": "concurrency-groups", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The name of the concurrency group.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "ahead_of_run", + "description": "Filter to items ahead of this workflow run ID in the queue, plus the run itself.\nMatches workflow-level concurrency and reusable-workflow leases held on behalf of\nthe run. Mutually exclusive with ahead_of_job.
Filter to items ahead of this job ID in the queue, plus the job itself.\nMatches job-level concurrency and reusable-workflow leases on the job's\nancestor paths. Mutually exclusive with ahead_of_run.
Gets a specific concurrency group for a repository, including all instances in the group's queue.\nReturns 404 if the group is inactive or does not exist.
\nOptionally, pass ahead_of_run or ahead_of_job to filter the results to only the items\nahead of the specified workflow run or job in the queue, plus the specified item itself\n(returned as the last element). This is useful for determining what is blocking a particular\nrun or job. Returns 422 if the specified run or job is not in this concurrency group.
When using ahead_of_run, this matches workflow-level concurrency and any reusable-workflow\nleases held on behalf of that run. Job-level leases within the run are not considered to\nblock the run as a whole. Use ahead_of_job to match job-level concurrency and reusable-workflow\nleases on the job's ancestor paths.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Response
", + "example": { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "total_count": 3, + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress" + }, + { + "run_id": 30433643, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433643", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433643", + "status": "pending" + }, + { + "run_id": 30433644, + "run_name": "Deploy hotfix", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433644", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644", + "job_id": 798245260, + "job_name": "deploy", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433644/job/798245260", + "status": "pending" + } + ] + }, + "schema": { + "title": "Concurrency Group", + "description": "A concurrency group with the workflow runs and jobs that are either currently holding\nor waiting for the concurrency group lease.", + "type": "object", + "required": [ + "group_name", + "group_url", + "total_count", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group." + }, + "total_count": { + "type": "integer" + }, + "group_members": { + "type": "array", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "job_id": { + "type": "integer", + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": "string", + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/concurrency_groups", + "title": "List concurrency groups for a workflow run", + "category": "actions", + "subcategory": "concurrency-groups", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The unique identifier of the workflow run.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Lists all concurrency groups associated with a workflow run or its jobs.
\nThe set of groups is derived from the run's configuration, so a group is\nincluded even when the run no longer has any items currently holding or\nwaiting in it. In that case the group_members array will be empty.\ntotal_count reflects the number of groups the run participates in by\nconfiguration, not the number with active items.
This differs from GET /repos/{owner}/{repo}/actions/concurrency_groups/{group_name},\nwhich returns 404 when a group has no active items. That endpoint reports\nthe live state of a group repo-wide, while this endpoint reports the\ngroups associated with a specific run by configuration.
Results are sorted by group name and support cursor-based pagination via\nbefore and after. The after cursor paginates forward only and does\nnot emit a rel=\"prev\" Link; use before to page backward from a\nforward page's next cursor.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.
Response
", + "example": { + "total_count": 2, + "concurrency_groups": [ + { + "group_name": "deploy-prod", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "in_progress", + "position": 0, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/deploy-prod?ahead_of_run=30433642" + } + ] + }, + { + "group_name": "ci-build", + "group_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build", + "group_members": [ + { + "run_id": 30433642, + "run_name": "Deploy to production", + "run_url": "https://api.github.com/repos/octocat/Hello-World/actions/runs/30433642", + "run_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642", + "status": "pending", + "position": 2, + "position_url": "https://api.github.com/repos/octocat/Hello-World/actions/concurrency_groups/ci-build?ahead_of_job=798245260", + "job_id": 798245260, + "job_name": "build", + "job_url": "https://api.github.com/repos/octocat/Hello-World/actions/jobs/798245260", + "job_html_url": "https://github.com/octocat/Hello-World/actions/runs/30433642/job/798245260" + } + ] + } + ] + }, + "schema": { + "title": "Concurrency Group Run List", + "description": "A list of concurrency groups associated with a workflow run.", + "type": "object", + "required": [ + "total_count", + "concurrency_groups" + ], + "properties": { + "total_count": { + "type": "integer", + "description": "The total number of concurrency groups this workflow run participates in,\nderived from the run's configuration. This count is not filtered by\nwhether the run currently holds or is waiting in each group, so it can\ninclude groups whose `group_members` array is empty (for example, when\nthe run has already released its lease in that group)." + }, + "concurrency_groups": { + "type": "array", + "items": { + "type": "object", + "required": [ + "group_name", + "group_url", + "group_members" + ], + "properties": { + "group_name": { + "type": "string", + "description": "The name of the concurrency group." + }, + "group_url": { + "type": "string", + "format": "uri", + "description": "API URL for this concurrency group. May return 404 if the group\nhas no active items at the time it is requested, since the\nget-by-name endpoint reports the live repo-wide state of a group\nwhile this endpoint lists groups associated with a run by\nconfiguration." + }, + "group_members": { + "type": "array", + "description": "Items belonging to this workflow run that are either currently holding or\nwaiting for the concurrency group lease. May be empty if the run no\nlonger has any active or queued items in this group.", + "items": { + "type": "object", + "required": [ + "run_id", + "run_name", + "run_url", + "run_html_url", + "status", + "position", + "position_url" + ], + "properties": { + "run_id": { + "type": "integer", + "description": "The ID of the workflow run." + }, + "run_name": { + "type": "string", + "description": "The name of the workflow run." + }, + "run_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the workflow run." + }, + "run_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the workflow run." + }, + "position": { + "type": "integer", + "description": "Queue position. 0 means the item holds the concurrency lease (in_progress), 1 or higher means queued (pending)." + }, + "position_url": { + "type": "string", + "format": "uri", + "description": "API URL to get items ahead of this item in the concurrency group." + }, + "job_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_name": { + "type": [ + "string", + "null" + ], + "description": "The display name of the job, when the item represents a job-level or reusable-workflow-level lease." + }, + "job_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "API URL for the job." + }, + "job_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "Web URL for the job." + }, + "status": { + "type": "string", + "enum": [ + "in_progress", + "pending" + ] + } + } + } + } + } + } + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Actions\" repository permissions": "read" + } + ], + "allowsPublicRead": true + } + } + ], "hosted-runners": [ { "serverUrl": "https://api.github.com", @@ -35570,6 +36221,12 @@ "name": "enable_debug_logging", "description": "Whether to enable debug logging for the re-run.
", "default": false + }, + { + "type": "boolean", + "name": "enable_debugger", + "description": "Whether to enable the debugger for the re-run of this job.
", + "default": false } ], "descriptionHTML": "Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The account owner of the repository. The name is not case sensitive.
" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive.
" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100).
" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch.
" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be updated_at or created_at.
The direction to sort results. Can be asc or desc.
Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.
Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false.
Only show tasks updated at or after this time (ISO 8601 timestamp)
" + }, + { + "name": "creator_id", + "in": "query", + "schema": { + "type": "integer" + }, + "description": "Filter tasks by creator user ID
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a list of tasks for a specific repository
\nFine-grained access tokens for \"List tasks for repository\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Tasks retrieved successfully
", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Tasks retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/agents/repos/{owner}/{repo}/tasks", + "title": "Start a task", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive.
" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive.
" + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "prompt", + "description": "The user's prompt for the agent
", + "isRequired": true + }, + { + "type": "string", + "name": "model", + "description": "The model to use for this task. The allowed models may change over time and depend on the user's GitHub Copilot plan and organization policies. Currently supported values: claude-sonnet-4.6, claude-opus-4.6, gpt-5.2-codex, gpt-5.3-codex, gpt-5.4, claude-sonnet-4.5, claude-opus-4.5
Whether to create a PR.
", + "default": false + }, + { + "type": "string", + "name": "base_ref", + "description": "Base ref for new branch/PR
" + } + ], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nStarts a new Copilot cloud agent task for a repository.
\nThis endpoint is only available to users with a Copilot Business or Copilot Enterprise subscription.
\nFine-grained access tokens for \"Start a task\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read and write) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "prompt": "Fix the login button on the homepage", + "base_ref": "main" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Task created successfully
", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "queued", + "session_count": 1, + "artifacts": [], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T00:00:00Z" + }, + "schema": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Task created successfully
" + }, + { + "httpStatusCode": "400", + "description": "Problems parsing JSON
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/repos/{owner}/{repo}/tasks/{task_id}", + "title": "Get a task by repo", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The account owner of the repository. The name is not case sensitive.
" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The name of the repository. The name is not case sensitive.
" + }, + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task.
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a task by ID scoped to an owner/repo path
\nFine-grained access tokens for \"Get a task by repo\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "task_id": "TASK_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Task retrieved successfully
", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "prompt": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main", + "model": "claude-sonnet-4.6" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Task retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks", + "title": "List tasks", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30, + "minimum": 1, + "maximum": 100 + }, + "description": "The number of results per page (max 100).
" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1, + "minimum": 1 + }, + "description": "The page number of the results to fetch.
" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "default": "updated_at", + "enum": [ + "updated_at", + "created_at" + ] + }, + "description": "The field to sort results by. Can be updated_at or created_at.
The direction to sort results. Can be asc or desc.
Comma-separated list of task states to filter by. Can be any combination of: queued, in_progress, completed, failed, idle, waiting_for_user, timed_out, cancelled.
Filter by archived status. When true, returns only archived tasks. When false or omitted, returns only non-archived tasks. Defaults to false.
Only show tasks updated at or after this time (ISO 8601 timestamp)
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a list of tasks for the authenticated user
\nFine-grained access tokens for \"List tasks\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json" + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Tasks retrieved successfully
", + "example": { + "tasks": [ + { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "tasks" + ], + "properties": { + "tasks": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + "description": "List of tasks" + }, + "total_active_count": { + "type": "integer", + "format": "int32", + "description": "Total count of active (non-archived) tasks" + }, + "total_archived_count": { + "type": "integer", + "format": "int32", + "description": "Total count of archived tasks" + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Tasks retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Bad request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/agents/tasks/{task_id}", + "title": "Get a task by ID", + "category": "agent-tasks", + "subcategory": "agent-tasks", + "parameters": [ + { + "name": "task_id", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The unique identifier of the task.
" + } + ], + "bodyParameters": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nReturns a task by ID with its associated sessions
\nFine-grained access tokens for \"Get a task by ID\"
\nThis endpoint works with the following fine-grained token types:
\n\nThe fine-grained token must have the following permission set:
\n- \n
- \"Agent tasks\" repository permissions (read) \n
GitHub App installation access tokens are not supported for this endpoint.
", + "codeExamples": [ + { + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "task_id": "TASK_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Task retrieved successfully
", + "example": { + "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "url": "https://api.github.com/agents/repos/octocat/hello-world/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "html_url": "https://github.com/octocat/hello-world/copilot/tasks/a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "creator": { + "id": 1 + }, + "creator_type": "user", + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "state": "completed", + "session_count": 1, + "artifacts": [ + { + "provider": "github", + "type": "pull", + "data": { + "id": 42 + } + } + ], + "archived_at": null, + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "sessions": [ + { + "id": "s1a2b3c4-d5e6-7890-abcd-ef1234567890", + "name": "Fix the login button on the homepage", + "user": { + "id": 1 + }, + "owner": { + "id": 1 + }, + "repository": { + "id": 1296269 + }, + "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", + "state": "completed", + "created_at": "2025-01-01T00:00:00Z", + "updated_at": "2025-01-01T01:00:00Z", + "completed_at": "2025-01-01T01:00:00Z", + "prompt": "Fix the login button on the homepage", + "head_ref": "copilot/fix-1", + "base_ref": "main", + "model": "claude-sonnet-4.6" + } + ] + }, + "schema": { + "allOf": [ + { + "type": "object", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique task identifier" + }, + "url": { + "type": "string", + "description": "API URL for this task" + }, + "html_url": { + "type": "string", + "description": "Web URL for this task" + }, + "name": { + "type": "string", + "description": "Human-readable name derived from the task prompt" + }, + "creator": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + } + ], + "description": "The entity who created this task" + }, + "creator_type": { + "type": "string", + "description": "Type of the task creator", + "enum": [ + "user", + "organization" + ] + }, + "user_collaborators": { + "type": "array", + "items": { + "type": "object", + "description": "A GitHub user", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "description": "User objects of collaborators on this task", + "deprecated": true + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this task belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "state": { + "type": "string", + "description": "Current state of the task, derived from its most recent session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "session_count": { + "type": "integer", + "format": "int32", + "description": "Number of sessions in this task" + }, + "artifacts": { + "type": "array", + "items": { + "type": "object", + "description": "A resource generated by the task", + "required": [ + "provider", + "type", + "data" + ], + "properties": { + "provider": { + "type": "string", + "enum": [ + "github" + ], + "description": "Provider namespace" + }, + "type": { + "type": "string", + "enum": [ + "pull", + "branch" + ], + "description": "Type of artifact. Available Values: `pull`, `branch`.\n" + }, + "data": { + "oneOf": [ + { + "type": "object", + "description": "A GitHub resource (pull request, issue, etc.)", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "GitHub resource ID" + }, + "global_id": { + "type": "string", + "description": "GraphQL global ID" + } + } + }, + { + "type": "object", + "description": "A Git branch reference", + "required": [ + "head_ref", + "base_ref" + ], + "properties": { + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + } + } + } + ], + "description": "Resource data (shape depends on type)" + } + } + }, + "description": "Resources created by this task (PRs, branches, etc.)" + }, + "archived_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp when the task was archived, null if not archived" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of the most recent update" + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp when the task was created" + } + } + }, + { + "type": "object", + "properties": { + "sessions": { + "type": "array", + "items": { + "type": "object", + "description": "Full session details within a task", + "required": [ + "id", + "state", + "created_at" + ], + "properties": { + "id": { + "type": "string", + "description": "Session ID" + }, + "name": { + "type": "string", + "description": "Session name" + }, + "user": { + "description": "The user who created this session", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "owner": { + "description": "The owner of the repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the user" + } + } + }, + "repository": { + "description": "The repository this session belongs to", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The unique identifier of the repository" + } + } + }, + "task_id": { + "type": "string", + "description": "Task ID this session belongs to" + }, + "state": { + "type": "string", + "description": "Current state of a session", + "enum": [ + "queued", + "in_progress", + "completed", + "failed", + "idle", + "waiting_for_user", + "timed_out", + "cancelled" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Creation timestamp" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "Last update timestamp" + }, + "completed_at": { + "type": "string", + "format": "date-time", + "description": "Completion timestamp" + }, + "prompt": { + "type": "string", + "description": "Content of the triggering event" + }, + "head_ref": { + "type": "string", + "description": "Head branch name" + }, + "base_ref": { + "type": "string", + "description": "Base branch name" + }, + "model": { + "type": "string", + "description": "Model used for this session" + }, + "error": { + "type": "object", + "description": "Error details for a failed session", + "properties": { + "message": { + "type": "string", + "description": "Error message" + } + } + } + } + }, + "description": "Sessions associated with this task" + } + } + } + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "Task retrieved successfully
" + }, + { + "httpStatusCode": "400", + "description": "Problems parsing request
" + }, + { + "httpStatusCode": "401", + "description": "Authentication required
" + }, + { + "httpStatusCode": "403", + "description": "Insufficient permissions
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation Failed
" + } + ], + "previews": [] + } + ] +} \ No newline at end of file diff --git a/src/rest/data/ghec-2026-03-10/orgs.json b/src/rest/data/ghec-2026-03-10/orgs.json index caec43e1968e..4e9746ff155e 100644 --- a/src/rest/data/ghec-2026-03-10/orgs.json +++ b/src/rest/data/ghec-2026-03-10/orgs.json @@ -6169,19 +6169,19 @@ { "type": "string", "name": "name", - "description": "The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name parameter must also be identical across all entries.
", + "description": "The name of the artifact.
", "isRequired": true }, { "type": "string", "name": "digest", - "description": "The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,\nthe name and version parameters must also be identical across all entries.
", + "description": "The hex encoded digest of the artifact.
", "isRequired": true }, { "type": "string", "name": "version", - "description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.
" + "description": "The artifact version.
" }, { "type": "string", @@ -6223,7 +6223,7 @@ "default": true } ], - "descriptionHTML": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.
", + "descriptionHTML": "Set deployment records for a given cluster.\nIf proposed records in the 'deployments' field have identical 'cluster', 'logical_environment',\n'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated.\nIf no existing records match, new records will be created.\nNote: Artifacts are uniquely identified by the combination of their repository and digest fields. If two entries in the deployments\narray resolve to the same repository and have identical digest fields but differing name and version fields, the endpoint will use\nthe artifact name and version from the record processed first, since a single artifact (identified by repository and digest) can\nonly have one name and version.
", "codeExamples": [ { "request": { diff --git a/src/rest/data/ghec-2026-03-10/private-registries.json b/src/rest/data/ghec-2026-03-10/private-registries.json index 7611ea603ce1..b7033ebf2b6d 100644 --- a/src/rest/data/ghec-2026-03-10/private-registries.json +++ b/src/rest/data/ghec-2026-03-10/private-registries.json @@ -114,7 +114,8 @@ "oidc_azure", "oidc_aws", "oidc_jfrog", - "oidc_cloudsmith" + "oidc_cloudsmith", + "oidc_gcp" ], "type": "string" }, @@ -196,6 +197,14 @@ "description": "The Cloudsmith API host.", "type": "string" }, + "workload_identity_provider": { + "description": "The full resource name of the GCP Workload Identity Provider (e.g. `projects/The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith for OIDC authentication.
The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp for OIDC authentication.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
A boolean value (true or false) indicating whether to filter alerts by their push protection bypass status. When set to true, only alerts that were created because a push protection rule was bypassed will be returned. When set to false, only alerts that were not caused by a push protection bypass will be returned.
A boolean value (true or false) indicating whether to filter alerts by their push protection bypass status. When set to true, only alerts that were created because a push protection rule was bypassed will be returned. When set to false, only alerts that were not caused by a push protection bypass will be returned.
A boolean value (true or false) indicating whether to filter alerts by their push protection bypass status. When set to true, only alerts that were created because a push protection rule was bypassed will be returned. When set to false, only alerts that were not caused by a push protection bypass will be returned.
Bad request, resolution comment is invalid or the resolution was not changed.
" }, + { + "httpStatusCode": "403", + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer.
" + }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" diff --git a/src/rest/data/ghes-3.15-2022-11-28/actions.json b/src/rest/data/ghes-3.15-2022-11-28/actions.json index da2482025b1c..3b9dc3fa3543 100644 --- a/src/rest/data/ghes-3.15-2022-11-28/actions.json +++ b/src/rest/data/ghes-3.15-2022-11-28/actions.json @@ -25625,6 +25625,12 @@ "name": "enable_debug_logging", "description": "Whether to enable debug logging for the re-run.
", "default": false + }, + { + "type": "boolean", + "name": "enable_debugger", + "description": "Whether to enable the debugger for the re-run of this job.
", + "default": false } ], "descriptionHTML": "Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Bad request, resolution comment is invalid or the resolution was not changed.
" }, + { + "httpStatusCode": "403", + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer.
" + }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" diff --git a/src/rest/data/ghes-3.16-2022-11-28/actions.json b/src/rest/data/ghes-3.16-2022-11-28/actions.json index 525b26282ac5..a988b072655f 100644 --- a/src/rest/data/ghes-3.16-2022-11-28/actions.json +++ b/src/rest/data/ghes-3.16-2022-11-28/actions.json @@ -25625,6 +25625,12 @@ "name": "enable_debug_logging", "description": "Whether to enable debug logging for the re-run.
", "default": false + }, + { + "type": "boolean", + "name": "enable_debugger", + "description": "Whether to enable the debugger for the re-run of this job.
", + "default": false } ], "descriptionHTML": "Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Bad request, resolution comment is invalid or the resolution was not changed.
" }, + { + "httpStatusCode": "403", + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer.
" + }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" diff --git a/src/rest/data/ghes-3.17-2022-11-28/actions.json b/src/rest/data/ghes-3.17-2022-11-28/actions.json index 08c47567fef2..c8232b0609f5 100644 --- a/src/rest/data/ghes-3.17-2022-11-28/actions.json +++ b/src/rest/data/ghes-3.17-2022-11-28/actions.json @@ -25661,6 +25661,12 @@ "name": "enable_debug_logging", "description": "Whether to enable debug logging for the re-run.
", "default": false + }, + { + "type": "boolean", + "name": "enable_debugger", + "description": "Whether to enable the debugger for the re-run of this job.
", + "default": false } ], "descriptionHTML": "Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Bad request, resolution comment is invalid or the resolution was not changed.
" }, + { + "httpStatusCode": "403", + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer.
" + }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" diff --git a/src/rest/data/ghes-3.18-2022-11-28/actions.json b/src/rest/data/ghes-3.18-2022-11-28/actions.json index fdda87e8e3a3..2df66c9d0f35 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/actions.json +++ b/src/rest/data/ghes-3.18-2022-11-28/actions.json @@ -25676,6 +25676,12 @@ "name": "enable_debug_logging", "description": "Whether to enable debug logging for the re-run.
", "default": false + }, + { + "type": "boolean", + "name": "enable_debugger", + "description": "Whether to enable the debugger for the re-run of this job.
", + "default": false } ], "descriptionHTML": "Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith for OIDC authentication.
The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp for OIDC authentication.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Bad request, resolution comment is invalid or the resolution was not changed.
" }, + { + "httpStatusCode": "403", + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer.
" + }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" diff --git a/src/rest/data/ghes-3.19-2022-11-28/actions.json b/src/rest/data/ghes-3.19-2022-11-28/actions.json index c842c4ca1e23..09b6b0bd56fa 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/actions.json +++ b/src/rest/data/ghes-3.19-2022-11-28/actions.json @@ -28679,6 +28679,12 @@ "name": "enable_debug_logging", "description": "Whether to enable debug logging for the re-run.
", "default": false + }, + { + "type": "boolean", + "name": "enable_debugger", + "description": "Whether to enable the debugger for the re-run of this job.
", + "default": false } ], "descriptionHTML": "Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith for OIDC authentication.
The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp for OIDC authentication.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Bad request, resolution comment is invalid or the resolution was not changed.
" }, + { + "httpStatusCode": "403", + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer.
" + }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" diff --git a/src/rest/data/ghes-3.20-2022-11-28/actions.json b/src/rest/data/ghes-3.20-2022-11-28/actions.json index b1a1bc857131..6a209c612d32 100644 --- a/src/rest/data/ghes-3.20-2022-11-28/actions.json +++ b/src/rest/data/ghes-3.20-2022-11-28/actions.json @@ -28679,6 +28679,12 @@ "name": "enable_debug_logging", "description": "Whether to enable debug logging for the re-run.
", "default": false + }, + { + "type": "boolean", + "name": "enable_debugger", + "description": "Whether to enable the debugger for the re-run of this job.
", + "default": false } ], "descriptionHTML": "Re-run a job and its dependent jobs in a workflow run.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith for OIDC authentication.
The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp for OIDC authentication.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and required for oidc_cloudsmith auth types.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, or oidc_cloudsmith), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"\nFor OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Bad request, resolution comment is invalid or the resolution was not changed.
" }, + { + "httpStatusCode": "403", + "description": "Delegated alert dismissal is enabled and the authenticated user is not a valid reviewer.
" + }, { "httpStatusCode": "404", "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found
" diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index f38c5a72271d..2412fd4706dd 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -52,5 +52,5 @@ ] } }, - "sha": "d3a3c2a50bb45b5f437bdfd8e0c700091bb1fb7b" + "sha": "12330abe1a9651268439945b92312855bb071532" } \ No newline at end of file diff --git a/src/tests/README.md b/src/tests/README.md index f4d6402976ee..8fd2cfb9d25d 100644 --- a/src/tests/README.md +++ b/src/tests/README.md @@ -57,7 +57,6 @@ Some suites require environment variables or tests will fail with 404s or conten ```bash npm run test:article-api -npm run test:changelogs npm run test:fixtures npm run test:landings npm run test:languages # requires Elasticsearch running diff --git a/src/tests/helpers/e2etest.ts b/src/tests/helpers/e2etest.ts index 85f66ad70412..db21f2d8c160 100644 --- a/src/tests/helpers/e2etest.ts +++ b/src/tests/helpers/e2etest.ts @@ -5,13 +5,13 @@ import { omitBy, isUndefined } from 'lodash-es' type ResponseTypes = 'buffer' | 'json' | 'text' type ResponseTypeMap = { buffer: ArrayBuffer - json: any + json: unknown text: string } interface GetOptions