1
0
mirror of synced 2026-01-05 03:06:35 -05:00

automate github apps docs (#35530)

Co-authored-by: Sarah Edwards <skedwards88@github.com>
This commit is contained in:
Rachael Sewell
2023-06-16 12:23:05 -07:00
committed by GitHub
parent b0ea5f518f
commit cb37f22ef0
89 changed files with 224473 additions and 21362 deletions

View File

@@ -0,0 +1,81 @@
import { Fragment } from 'react'
import { useRouter } from 'next/router'
import { slug as githubSlug } from 'github-slugger'
import { HeadingLink } from 'components/article/HeadingLink'
import { Link } from 'components/Link'
import { MainContext, MainContextT } from 'components/context/MainContext'
import {
AutomatedPageContext,
AutomatedPageContextT,
} from 'src/automated-pipelines/components/AutomatedPageContext'
import { AutomatedPage } from 'src/automated-pipelines/components/AutomatedPage'
import { RestRedirect } from 'src/rest/components/RestRedirect'
type EnabledOperationT = {
slug: string
subcategory: string
verb: string
requestPath: string
}
export type EnabledListT = Record<string, EnabledOperationT[]>
type Props = {
items: EnabledListT
currentVersion: string
categoriesWithoutSubcategories: string[]
mainContext: MainContextT
automatedPageContext: AutomatedPageContextT
}
export function EnabledList({
items,
currentVersion,
categoriesWithoutSubcategories,
mainContext,
automatedPageContext,
}: Props) {
const { locale } = useRouter()
const DEFAULT_VERSION = mainContext.nonEnterpriseDefaultVersion
const restRoot =
currentVersion === DEFAULT_VERSION ? `/${locale}/rest` : `/${locale}/${currentVersion}/rest`
const content = Object.entries(items).map(([category, operations]) =>
operations.length === 0 ? null : (
<Fragment key={category}>
<HeadingLink as="h2" slug={githubSlug(category)}>
{category}
</HeadingLink>
<ul>
{operations.map((operation, index) => {
const { slug, verb, requestPath } = operation
const subcategory = categoriesWithoutSubcategories.includes(category)
? ''
: `/${operation.subcategory}`
const opPath = `${restRoot}/${category}${subcategory}#${slug}`
return (
<li key={`enabledList-${slug}-${index}`}>
<Link href={opPath}>
<code>
<span>{verb.toUpperCase()}</span> {requestPath}
</code>
</Link>
</li>
)
})}
</ul>
</Fragment>
)
)
return (
<MainContext.Provider value={mainContext}>
<AutomatedPageContext.Provider value={automatedPageContext}>
<RestRedirect />
<AutomatedPage>{content}</AutomatedPage>
</AutomatedPageContext.Provider>
</MainContext.Provider>
)
}

View File

@@ -0,0 +1,19 @@
.parameterTable {
table {
table-layout: fixed !important;
}
th:first-of-type {
width: 56% !important;
}
th:last-of-type {
width: 20% !important;
}
td {
padding-left: 0.3rem !important;
padding-right: 0.3rem !important;
}
}
.codeBlock code:not(td *) {
word-break: break-word;
}

View File

@@ -0,0 +1,160 @@
import { useRouter } from 'next/router'
import cx from 'classnames'
import { slug as githubSlug } from 'github-slugger'
import { HeadingLink } from 'components/article/HeadingLink'
import { useTranslation } from 'components/hooks/useTranslation'
import { Link } from 'components/Link'
import { MainContextT } from 'components/context/MainContext'
import {
AutomatedPageContext,
AutomatedPageContextT,
} from 'src/automated-pipelines/components/AutomatedPageContext'
import { AutomatedPage } from 'src/automated-pipelines/components/AutomatedPage'
import { RestRedirect } from 'src/rest/components/RestRedirect'
import styles from 'src/github-apps/components/PermissionTable.module.scss'
const IAT_DOCS_REF =
'/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-as-a-github-app-installation'
const UAT_DOCS_REF =
'/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user'
type PermissionOperationsT = {
slug: string
category: string
subcategory: string
verb: string
requestPath: string
access: 'admin' | 'write' | 'read'
'user-to-server': boolean
'server-to-server': boolean
'additional-permissions': []
}
export type PermissionT = {
displayTitle: string
resourceGroup: string
permissions: PermissionOperationsT[]
}
export type PermissionListT = Record<string, PermissionT>
type Props = {
items: PermissionListT
currentVersion: string
categoriesWithoutSubcategories: string[]
mainContext: MainContextT
automatedPageContext: AutomatedPageContextT
tokenTypes?: boolean
}
export function PermissionsList({
items,
currentVersion,
categoriesWithoutSubcategories,
automatedPageContext,
mainContext,
tokenTypes = false,
}: Props) {
const { locale } = useRouter()
const DEFAULT_VERSION = mainContext.nonEnterpriseDefaultVersion
const rootPath =
currentVersion === DEFAULT_VERSION ? `/${locale}` : `/${locale}/${currentVersion}`
// Translated strings
const { t } = useTranslation('products')
const ENDPOINTS_TH = t('rest.overview.permissions.endpoints')
const ACCESS_TH = t('rest.overview.permissions.access')
const TOKENS_TH = t('rest.overview.permissions.tokens')
const ADDITIONAL_TH = t('rest.overview.permissions.additionalPermissions')
const UAT = t('rest.overview.permissions.uat')
const IAT = t('rest.overview.permissions.iat')
const content = Object.entries(items).map(([permissionName, permissionObject]) => {
const { displayTitle, permissions } = permissionObject
const adminPermissions = permissions.filter((permission) => permission.access === 'admin')
const writePermissions = permissions.filter((permission) => permission.access === 'write')
const readPermissions = permissions.filter((permission) => permission.access === 'read')
const sortedPermissions = [...adminPermissions, ...writePermissions, ...readPermissions]
return (
<div key={permissionName} className={cx(styles.parameterTable)}>
<HeadingLink as="h2" slug={githubSlug(displayTitle)}>
{displayTitle}
</HeadingLink>
<table>
<thead>
<tr>
<th className="text-left">{ENDPOINTS_TH}</th>
<th className="text-center">{ACCESS_TH}</th>
{tokenTypes ? <th className="text-center">{TOKENS_TH}</th> : null}
<th className="text-center">{ADDITIONAL_TH}</th>
</tr>
</thead>
<tbody>
{sortedPermissions.map((operation, index) => {
const { slug, verb, requestPath } = operation
const category = categoriesWithoutSubcategories.includes(operation.category)
? `${operation.category}`
: `${operation.category}/${operation.subcategory}`
const opPath = `${rootPath}/rest/${category}#${slug}`
const iat = operation['server-to-server'] ? (
<span className="label mt-2">
<Link href={`${rootPath}${IAT_DOCS_REF}`}>{IAT}</Link>
</span>
) : null
const uat = operation['user-to-server'] ? (
<span className="label no-underline">
<Link href={`${rootPath}${UAT_DOCS_REF}`}>{UAT}</Link>
</span>
) : null
const additionalPermissions = operation['additional-permissions'].map(
(permission) => items[permission].displayTitle
)
const permissionsClass = operation['additional-permissions'].length
? ''
: 'text-center'
return (
<tr key={`${permissionName}-${operation.slug}-${index}`}>
<td>
<Link href={`${opPath}`}>
<span>{verb.toUpperCase()}</span> {`${requestPath}`}
</Link>
</td>
<td className="v-align-middle text-center">{operation.access}</td>
{tokenTypes ? (
<td className="v-align-middle text-center">
{uat}
<br />
{iat}
</td>
) : null}
<td className={permissionsClass}>
{operation['additional-permissions'].length
? additionalPermissions.map((permission, index) => {
return (
<div key={`${permission}-${index}`}>
<a href={`#${githubSlug(permission)}`}>{permission}</a>
{additionalPermissions.length - 1 !== index ? (
<span className="pl-1">, </span>
) : null}
</div>
)
})
: '✖️'}
</td>
</tr>
)
})}
</tbody>
</table>
</div>
)
})
return (
<AutomatedPageContext.Provider value={automatedPageContext}>
<RestRedirect />
<AutomatedPage>{content}</AutomatedPage>
</AutomatedPageContext.Provider>
)
}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,5 +1,53 @@
{
"actions": [
{
"slug": "get-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "set-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "list-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "set-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "enable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "disable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "delete",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "get-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "set-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "get-github-actions-permissions-for-an-organization",
"subcategory": "permissions",
@@ -354,6 +402,18 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs"
},
{
"slug": "re-run-a-workflow",
"subcategory": "workflow-runs",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun"
},
{
"slug": "get-workflow-run-usage",
"subcategory": "workflow-runs",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing"
},
{
"slug": "list-repository-secrets",
"subcategory": "secrets",
@@ -419,6 +479,12 @@
"subcategory": "workflow-runs",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs"
},
{
"slug": "get-workflow-usage",
"subcategory": "workflows",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing"
}
],
"activity": [
@@ -466,36 +532,6 @@
}
],
"apps": [
{
"slug": "get-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app"
},
{
"slug": "list-installation-requests-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installation-requests"
},
{
"slug": "list-installations-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations"
},
{
"slug": "get-an-installation-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations/{installation_id}"
},
{
"slug": "create-an-installation-access-token-for-an-app",
"subcategory": "apps",
"verb": "post",
"requestPath": "/app/installations/{installation_id}/access_tokens"
},
{
"slug": "get-an-app",
"subcategory": "apps",
@@ -507,12 +543,6 @@
"subcategory": "installations",
"verb": "get",
"requestPath": "/installation/repositories"
},
{
"slug": "revoke-an-installation-access-token",
"subcategory": "installations",
"verb": "delete",
"requestPath": "/installation/token"
}
],
"branches": [
@@ -1157,6 +1187,14 @@
"requestPath": "/emojis"
}
],
"enterprise-admin": [
{
"slug": "get-the-audit-log-for-an-enterprise",
"subcategory": "audit-log",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/audit-log"
}
],
"git": [
{
"slug": "create-a-blob",
@@ -1177,7 +1215,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit-object",
"slug": "get-a-commit",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"
@@ -1718,24 +1756,6 @@
"verb": "delete",
"requestPath": "/orgs/{org}/outside_collaborators/{username}"
},
{
"slug": "list-organization-memberships-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs"
},
{
"slug": "get-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "update-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "patch",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "list-organizations-for-a-user",
"subcategory": "orgs",
@@ -1931,12 +1951,6 @@
"subcategory": "projects",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/projects"
},
{
"slug": "create-a-user-project",
"subcategory": "projects",
"verb": "post",
"requestPath": "/user/projects"
}
],
"pulls": [
@@ -2000,6 +2014,12 @@
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments"
},
{
"slug": "create-a-reply-for-a-review-comment",
"subcategory": "comments",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"
},
{
"slug": "list-commits-on-a-pull-request",
"subcategory": "pulls",
@@ -2089,41 +2109,21 @@
"subcategory": "reviews",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"
}
],
"rate-limit": [
},
{
"slug": "get-rate-limit-status-for-the-authenticated-user",
"subcategory": "rate-limit",
"verb": "get",
"requestPath": "/rate_limit"
"slug": "update-a-pull-request-branch",
"subcategory": "pulls",
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch"
}
],
"reactions": [
{
"slug": "list-reactions-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "create-reaction-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "delete-team-discussion-comment-reaction",
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-team-discussion",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"
},
{
"slug": "delete-team-discussion-reaction",
"subcategory": "reactions",
@@ -2172,6 +2172,12 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "create-reaction-for-an-issue",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "delete-an-issue-reaction",
"subcategory": "reactions",
@@ -2281,12 +2287,6 @@
"subcategory": "assets",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
},
{
"slug": "upload-a-release-asset",
"subcategory": "assets",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
}
],
"repos": [
@@ -2398,30 +2398,12 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/languages"
},
{
"slug": "get-a-repository-readme",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme"
},
{
"slug": "get-a-repository-readme-for-a-directory",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme/{dir}"
},
{
"slug": "list-repository-tags",
"subcategory": "repos",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/tags"
},
{
"slug": "download-a-repository-archive-tar",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/tarball/{ref}"
},
{
"slug": "list-repository-teams",
"subcategory": "repos",
@@ -2440,18 +2422,6 @@
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/topics"
},
{
"slug": "transfer-a-repository",
"subcategory": "repos",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/transfer"
},
{
"slug": "download-a-repository-archive-zip",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}"
},
{
"slug": "list-repositories-for-a-user",
"subcategory": "repos",
@@ -2555,244 +2525,16 @@
"requestPath": "/orgs/{org}/teams"
},
{
"slug": "get-a-team-by-name",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "update-a-team",
"subcategory": "teams",
"slug": "update-the-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}"
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "delete-a-team",
"subcategory": "teams",
"slug": "remove-the-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "list-discussions",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "create-a-discussion",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "get-a-discussion",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-team-members",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/members"
},
{
"slug": "get-team-membership-for-a-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user",
"subcategory": "members",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user",
"subcategory": "members",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "list-team-projects",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects"
},
{
"slug": "check-team-permissions-for-a-project",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "list-team-repositories",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos"
},
{
"slug": "check-team-permissions-for-a-repository",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/teams"
},
{
"slug": "get-a-team-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}"
},
{
"slug": "update-a-team-legacy",
"subcategory": "teams",
"verb": "patch",
"requestPath": "/teams/{team_id}"
},
{
"slug": "delete-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}"
},
{
"slug": "list-discussions-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "create-a-discussion-legacy",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "get-a-discussion-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion-legacy",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion-legacy",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-team-members-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/members"
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "get-team-member-legacy",
@@ -2811,78 +2553,6 @@
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/members/{username}"
},
{
"slug": "get-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "put",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "list-team-projects-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects"
},
{
"slug": "check-team-permissions-for-a-project-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "list-team-repositories-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos"
},
{
"slug": "check-team-permissions-for-a-repository-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/teams"
}
],
"users": [

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,5 +1,53 @@
{
"actions": [
{
"slug": "get-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "set-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "list-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "set-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "enable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "disable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "delete",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "get-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "set-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "get-github-actions-permissions-for-an-organization",
"subcategory": "permissions",
@@ -432,6 +480,18 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"
},
{
"slug": "review-pending-deployments-for-a-workflow-run",
"subcategory": "workflow-runs",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"
},
{
"slug": "re-run-a-workflow",
"subcategory": "workflow-runs",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun"
},
{
"slug": "list-repository-secrets",
"subcategory": "secrets",
@@ -610,36 +670,6 @@
}
],
"apps": [
{
"slug": "get-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app"
},
{
"slug": "list-installation-requests-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installation-requests"
},
{
"slug": "list-installations-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations"
},
{
"slug": "get-an-installation-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations/{installation_id}"
},
{
"slug": "create-an-installation-access-token-for-an-app",
"subcategory": "apps",
"verb": "post",
"requestPath": "/app/installations/{installation_id}/access_tokens"
},
{
"slug": "get-an-app",
"subcategory": "apps",
@@ -651,12 +681,6 @@
"subcategory": "installations",
"verb": "get",
"requestPath": "/installation/repositories"
},
{
"slug": "revoke-an-installation-access-token",
"subcategory": "installations",
"verb": "delete",
"requestPath": "/installation/token"
}
],
"billing": [
@@ -1396,6 +1420,18 @@
}
],
"enterprise-admin": [
{
"slug": "get-the-audit-log-for-an-enterprise",
"subcategory": "audit-log",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/audit-log"
},
{
"slug": "get-github-advanced-security-active-committers-for-an-enterprise",
"subcategory": "billing",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/settings/billing/advanced-security"
},
{
"slug": "list-pre-receive-hooks-for-an-organization",
"subcategory": "org-pre-receive-hooks",
@@ -1408,12 +1444,6 @@
"verb": "get",
"requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "update-pre-receive-hook-enforcement-for-an-organization",
"subcategory": "org-pre-receive-hooks",
"verb": "patch",
"requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "remove-pre-receive-hook-enforcement-for-an-organization",
"subcategory": "org-pre-receive-hooks",
@@ -1432,12 +1462,6 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "update-pre-receive-hook-enforcement-for-a-repository",
"subcategory": "repo-pre-receive-hooks",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "remove-pre-receive-hook-enforcement-for-a-repository",
"subcategory": "repo-pre-receive-hooks",
@@ -1465,7 +1489,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit-object",
"slug": "get-a-commit",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"
@@ -2024,24 +2048,6 @@
"verb": "get",
"requestPath": "/orgs/{org}/public_members/{username}"
},
{
"slug": "list-organization-memberships-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs"
},
{
"slug": "get-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "update-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "patch",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "list-organizations-for-a-user",
"subcategory": "orgs",
@@ -2237,12 +2243,6 @@
"subcategory": "projects",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/projects"
},
{
"slug": "create-a-user-project",
"subcategory": "projects",
"verb": "post",
"requestPath": "/user/projects"
}
],
"pulls": [
@@ -2306,6 +2306,12 @@
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments"
},
{
"slug": "create-a-reply-for-a-review-comment",
"subcategory": "comments",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"
},
{
"slug": "list-commits-on-a-pull-request",
"subcategory": "pulls",
@@ -2395,53 +2401,27 @@
"subcategory": "reviews",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"
}
],
"rate-limit": [
},
{
"slug": "get-rate-limit-status-for-the-authenticated-user",
"subcategory": "rate-limit",
"verb": "get",
"requestPath": "/rate_limit"
"slug": "update-a-pull-request-branch",
"subcategory": "pulls",
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch"
}
],
"reactions": [
{
"slug": "list-reactions-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "create-reaction-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "delete-team-discussion-comment-reaction",
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-team-discussion",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"
},
{
"slug": "delete-team-discussion-reaction",
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}"
},
{
"slug": "delete-a-reaction-legacy",
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-commit-comment",
"subcategory": "reactions",
@@ -2484,6 +2464,12 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "create-reaction-for-an-issue",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "delete-an-issue-reaction",
"subcategory": "reactions",
@@ -2525,24 +2511,6 @@
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-team-discussion-comment-legacy",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "create-reaction-for-a-team-discussion-comment-legacy",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "list-reactions-for-a-team-discussion-legacy",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions"
}
],
"releases": [
@@ -2617,12 +2585,6 @@
"subcategory": "assets",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
},
{
"slug": "upload-a-release-asset",
"subcategory": "assets",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
}
],
"repos": [
@@ -2728,18 +2690,6 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/languages"
},
{
"slug": "get-a-repository-readme",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme"
},
{
"slug": "get-a-repository-readme-for-a-directory",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme/{dir}"
},
{
"slug": "list-repository-cache-replication-status",
"subcategory": "repos",
@@ -2752,12 +2702,6 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/tags"
},
{
"slug": "download-a-repository-archive-tar",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/tarball/{ref}"
},
{
"slug": "list-repository-teams",
"subcategory": "repos",
@@ -2776,18 +2720,6 @@
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/topics"
},
{
"slug": "transfer-a-repository",
"subcategory": "repos",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/transfer"
},
{
"slug": "download-a-repository-archive-zip",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}"
},
{
"slug": "list-public-repositories",
"subcategory": "repos",
@@ -2890,246 +2822,6 @@
"verb": "post",
"requestPath": "/orgs/{org}/teams"
},
{
"slug": "get-a-team-by-name",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "update-a-team",
"subcategory": "teams",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "delete-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "list-discussions",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "create-a-discussion",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "get-a-discussion",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-team-members",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/members"
},
{
"slug": "get-team-membership-for-a-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user",
"subcategory": "members",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user",
"subcategory": "members",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "list-team-projects",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects"
},
{
"slug": "check-team-permissions-for-a-project",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "list-team-repositories",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos"
},
{
"slug": "check-team-permissions-for-a-repository",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/teams"
},
{
"slug": "get-a-team-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}"
},
{
"slug": "update-a-team-legacy",
"subcategory": "teams",
"verb": "patch",
"requestPath": "/teams/{team_id}"
},
{
"slug": "delete-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}"
},
{
"slug": "list-discussions-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "create-a-discussion-legacy",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "get-a-discussion-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion-legacy",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion-legacy",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-team-members-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/members"
},
{
"slug": "get-team-member-legacy",
"subcategory": "members",
@@ -3147,78 +2839,6 @@
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/members/{username}"
},
{
"slug": "get-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "put",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "list-team-projects-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects"
},
{
"slug": "check-team-permissions-for-a-project-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "list-team-repositories-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos"
},
{
"slug": "check-team-permissions-for-a-repository-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/teams"
}
],
"users": [

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,5 +1,71 @@
{
"actions": [
{
"slug": "get-github-actions-cache-usage-for-an-enterprise",
"subcategory": "cache",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage"
},
{
"slug": "get-github-actions-cache-usage-policy-for-an-enterprise",
"subcategory": "cache",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy"
},
{
"slug": "set-github-actions-cache-usage-policy-for-an-enterprise",
"subcategory": "cache",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy"
},
{
"slug": "get-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "set-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "list-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "set-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "enable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "disable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "delete",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "get-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "set-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "get-github-actions-cache-usage-for-an-organization",
"subcategory": "cache",
@@ -510,6 +576,18 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"
},
{
"slug": "review-pending-deployments-for-a-workflow-run",
"subcategory": "workflow-runs",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"
},
{
"slug": "re-run-a-workflow",
"subcategory": "workflow-runs",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun"
},
{
"slug": "re-run-failed-jobs-from-a-workflow-run",
"subcategory": "workflow-runs",
@@ -694,36 +772,6 @@
}
],
"apps": [
{
"slug": "get-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app"
},
{
"slug": "list-installation-requests-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installation-requests"
},
{
"slug": "list-installations-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations"
},
{
"slug": "get-an-installation-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations/{installation_id}"
},
{
"slug": "create-an-installation-access-token-for-an-app",
"subcategory": "apps",
"verb": "post",
"requestPath": "/app/installations/{installation_id}/access_tokens"
},
{
"slug": "get-an-app",
"subcategory": "apps",
@@ -735,12 +783,6 @@
"subcategory": "installations",
"verb": "get",
"requestPath": "/installation/repositories"
},
{
"slug": "revoke-an-installation-access-token",
"subcategory": "installations",
"verb": "delete",
"requestPath": "/installation/token"
}
],
"billing": [
@@ -1486,6 +1528,18 @@
}
],
"enterprise-admin": [
{
"slug": "get-the-audit-log-for-an-enterprise",
"subcategory": "audit-log",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/audit-log"
},
{
"slug": "get-github-advanced-security-active-committers-for-an-enterprise",
"subcategory": "billing",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/settings/billing/advanced-security"
},
{
"slug": "list-pre-receive-hooks-for-an-organization",
"subcategory": "org-pre-receive-hooks",
@@ -1498,12 +1552,6 @@
"verb": "get",
"requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "update-pre-receive-hook-enforcement-for-an-organization",
"subcategory": "org-pre-receive-hooks",
"verb": "patch",
"requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "remove-pre-receive-hook-enforcement-for-an-organization",
"subcategory": "org-pre-receive-hooks",
@@ -1522,12 +1570,6 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "update-pre-receive-hook-enforcement-for-a-repository",
"subcategory": "repo-pre-receive-hooks",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "remove-pre-receive-hook-enforcement-for-a-repository",
"subcategory": "repo-pre-receive-hooks",
@@ -1555,7 +1597,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit-object",
"slug": "get-a-commit",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"
@@ -2114,24 +2156,6 @@
"verb": "get",
"requestPath": "/orgs/{org}/public_members/{username}"
},
{
"slug": "list-organization-memberships-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs"
},
{
"slug": "get-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "update-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "patch",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "list-organizations-for-a-user",
"subcategory": "orgs",
@@ -2327,12 +2351,6 @@
"subcategory": "projects",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/projects"
},
{
"slug": "create-a-user-project",
"subcategory": "projects",
"verb": "post",
"requestPath": "/user/projects"
}
],
"pulls": [
@@ -2396,6 +2414,12 @@
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments"
},
{
"slug": "create-a-reply-for-a-review-comment",
"subcategory": "comments",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"
},
{
"slug": "list-commits-on-a-pull-request",
"subcategory": "pulls",
@@ -2485,41 +2509,21 @@
"subcategory": "reviews",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"
}
],
"rate-limit": [
},
{
"slug": "get-rate-limit-status-for-the-authenticated-user",
"subcategory": "rate-limit",
"verb": "get",
"requestPath": "/rate_limit"
"slug": "update-a-pull-request-branch",
"subcategory": "pulls",
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch"
}
],
"reactions": [
{
"slug": "list-reactions-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "create-reaction-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "delete-team-discussion-comment-reaction",
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-team-discussion",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"
},
{
"slug": "delete-team-discussion-reaction",
"subcategory": "reactions",
@@ -2568,6 +2572,12 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "create-reaction-for-an-issue",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "delete-an-issue-reaction",
"subcategory": "reactions",
@@ -2609,24 +2619,6 @@
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-team-discussion-comment-legacy",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "create-reaction-for-a-team-discussion-comment-legacy",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "list-reactions-for-a-team-discussion-legacy",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions"
}
],
"releases": [
@@ -2701,12 +2693,6 @@
"subcategory": "assets",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
},
{
"slug": "upload-a-release-asset",
"subcategory": "assets",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
}
],
"repos": [
@@ -2818,18 +2804,6 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/languages"
},
{
"slug": "get-a-repository-readme",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme"
},
{
"slug": "get-a-repository-readme-for-a-directory",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme/{dir}"
},
{
"slug": "list-repository-cache-replication-status",
"subcategory": "repos",
@@ -2860,12 +2834,6 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}"
},
{
"slug": "download-a-repository-archive-tar",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/tarball/{ref}"
},
{
"slug": "list-repository-teams",
"subcategory": "repos",
@@ -2884,18 +2852,6 @@
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/topics"
},
{
"slug": "transfer-a-repository",
"subcategory": "repos",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/transfer"
},
{
"slug": "download-a-repository-archive-zip",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}"
},
{
"slug": "list-public-repositories",
"subcategory": "repos",
@@ -2998,246 +2954,6 @@
"verb": "post",
"requestPath": "/orgs/{org}/teams"
},
{
"slug": "get-a-team-by-name",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "update-a-team",
"subcategory": "teams",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "delete-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "list-discussions",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "create-a-discussion",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "get-a-discussion",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-team-members",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/members"
},
{
"slug": "get-team-membership-for-a-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user",
"subcategory": "members",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user",
"subcategory": "members",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "list-team-projects",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects"
},
{
"slug": "check-team-permissions-for-a-project",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "list-team-repositories",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos"
},
{
"slug": "check-team-permissions-for-a-repository",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/teams"
},
{
"slug": "get-a-team-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}"
},
{
"slug": "update-a-team-legacy",
"subcategory": "teams",
"verb": "patch",
"requestPath": "/teams/{team_id}"
},
{
"slug": "delete-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}"
},
{
"slug": "list-discussions-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "create-a-discussion-legacy",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "get-a-discussion-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion-legacy",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion-legacy",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-team-members-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/members"
},
{
"slug": "get-team-member-legacy",
"subcategory": "members",
@@ -3255,78 +2971,6 @@
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/members/{username}"
},
{
"slug": "get-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "put",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "list-team-projects-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects"
},
{
"slug": "check-team-permissions-for-a-project-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "list-team-repositories-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos"
},
{
"slug": "check-team-permissions-for-a-repository-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/teams"
}
],
"users": [

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,5 +1,83 @@
{
"actions": [
{
"slug": "get-github-actions-cache-usage-for-an-enterprise",
"subcategory": "cache",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage"
},
{
"slug": "get-github-actions-cache-usage-policy-for-an-enterprise",
"subcategory": "cache",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy"
},
{
"slug": "set-github-actions-cache-usage-policy-for-an-enterprise",
"subcategory": "cache",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy"
},
{
"slug": "get-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "set-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "list-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "set-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "enable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "disable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "delete",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "get-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "set-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "get-default-workflow-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/workflow"
},
{
"slug": "set-default-workflow-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/workflow"
},
{
"slug": "get-github-actions-cache-usage-for-an-organization",
"subcategory": "cache",
@@ -522,6 +600,18 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"
},
{
"slug": "review-pending-deployments-for-a-workflow-run",
"subcategory": "workflow-runs",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"
},
{
"slug": "re-run-a-workflow",
"subcategory": "workflow-runs",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun"
},
{
"slug": "re-run-failed-jobs-from-a-workflow-run",
"subcategory": "workflow-runs",
@@ -706,36 +796,6 @@
}
],
"apps": [
{
"slug": "get-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app"
},
{
"slug": "list-installation-requests-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installation-requests"
},
{
"slug": "list-installations-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations"
},
{
"slug": "get-an-installation-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations/{installation_id}"
},
{
"slug": "create-an-installation-access-token-for-an-app",
"subcategory": "apps",
"verb": "post",
"requestPath": "/app/installations/{installation_id}/access_tokens"
},
{
"slug": "get-an-app",
"subcategory": "apps",
@@ -747,12 +807,6 @@
"subcategory": "installations",
"verb": "get",
"requestPath": "/installation/repositories"
},
{
"slug": "revoke-an-installation-access-token",
"subcategory": "installations",
"verb": "delete",
"requestPath": "/installation/token"
}
],
"billing": [
@@ -1365,6 +1419,14 @@
"requestPath": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}"
}
],
"dependency-graph": [
{
"slug": "get-a-diff-of-the-dependencies-between-commits",
"subcategory": "dependency-review",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}"
}
],
"deploy-keys": [
{
"slug": "list-deploy-keys",
@@ -1498,6 +1560,18 @@
}
],
"enterprise-admin": [
{
"slug": "get-the-audit-log-for-an-enterprise",
"subcategory": "audit-log",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/audit-log"
},
{
"slug": "get-github-advanced-security-active-committers-for-an-enterprise",
"subcategory": "billing",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/settings/billing/advanced-security"
},
{
"slug": "list-pre-receive-hooks-for-an-organization",
"subcategory": "org-pre-receive-hooks",
@@ -1510,12 +1584,6 @@
"verb": "get",
"requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "update-pre-receive-hook-enforcement-for-an-organization",
"subcategory": "org-pre-receive-hooks",
"verb": "patch",
"requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "remove-pre-receive-hook-enforcement-for-an-organization",
"subcategory": "org-pre-receive-hooks",
@@ -1534,12 +1602,6 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "update-pre-receive-hook-enforcement-for-a-repository",
"subcategory": "repo-pre-receive-hooks",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "remove-pre-receive-hook-enforcement-for-a-repository",
"subcategory": "repo-pre-receive-hooks",
@@ -1639,7 +1701,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit-object",
"slug": "get-a-commit",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"
@@ -2198,24 +2260,6 @@
"verb": "get",
"requestPath": "/orgs/{org}/public_members/{username}"
},
{
"slug": "list-organization-memberships-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs"
},
{
"slug": "get-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "update-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "patch",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "list-organizations-for-a-user",
"subcategory": "orgs",
@@ -2411,12 +2455,6 @@
"subcategory": "projects",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/projects"
},
{
"slug": "create-a-user-project",
"subcategory": "projects",
"verb": "post",
"requestPath": "/user/projects"
}
],
"pulls": [
@@ -2480,6 +2518,12 @@
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments"
},
{
"slug": "create-a-reply-for-a-review-comment",
"subcategory": "comments",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"
},
{
"slug": "list-commits-on-a-pull-request",
"subcategory": "pulls",
@@ -2569,41 +2613,21 @@
"subcategory": "reviews",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"
}
],
"rate-limit": [
},
{
"slug": "get-rate-limit-status-for-the-authenticated-user",
"subcategory": "rate-limit",
"verb": "get",
"requestPath": "/rate_limit"
"slug": "update-a-pull-request-branch",
"subcategory": "pulls",
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch"
}
],
"reactions": [
{
"slug": "list-reactions-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "create-reaction-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "delete-team-discussion-comment-reaction",
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-team-discussion",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"
},
{
"slug": "delete-team-discussion-reaction",
"subcategory": "reactions",
@@ -2652,6 +2676,12 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "create-reaction-for-an-issue",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "delete-an-issue-reaction",
"subcategory": "reactions",
@@ -2693,24 +2723,6 @@
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-team-discussion-comment-legacy",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "create-reaction-for-a-team-discussion-comment-legacy",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "list-reactions-for-a-team-discussion-legacy",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions"
}
],
"releases": [
@@ -2785,12 +2797,6 @@
"subcategory": "assets",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
},
{
"slug": "upload-a-release-asset",
"subcategory": "assets",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
}
],
"repos": [
@@ -2902,18 +2908,6 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/languages"
},
{
"slug": "get-a-repository-readme",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme"
},
{
"slug": "get-a-repository-readme-for-a-directory",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme/{dir}"
},
{
"slug": "list-repository-cache-replication-status",
"subcategory": "repos",
@@ -2944,12 +2938,6 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}"
},
{
"slug": "download-a-repository-archive-tar",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/tarball/{ref}"
},
{
"slug": "list-repository-teams",
"subcategory": "repos",
@@ -2968,18 +2956,6 @@
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/topics"
},
{
"slug": "transfer-a-repository",
"subcategory": "repos",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/transfer"
},
{
"slug": "download-a-repository-archive-zip",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}"
},
{
"slug": "list-public-repositories",
"subcategory": "repos",
@@ -3094,84 +3070,6 @@
"verb": "post",
"requestPath": "/orgs/{org}/teams"
},
{
"slug": "get-a-team-by-name",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "update-a-team",
"subcategory": "teams",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "delete-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "list-discussions",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "create-a-discussion",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "get-a-discussion",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-a-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
@@ -3179,166 +3077,16 @@
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "list-team-members",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/members"
},
{
"slug": "get-team-membership-for-a-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user",
"subcategory": "members",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user",
"subcategory": "members",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "list-team-projects",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects"
},
{
"slug": "check-team-permissions-for-a-project",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "list-team-repositories",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos"
},
{
"slug": "check-team-permissions-for-a-repository",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/teams"
},
{
"slug": "get-a-team-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}"
},
{
"slug": "update-a-team-legacy",
"subcategory": "teams",
"slug": "update-the-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
"verb": "patch",
"requestPath": "/teams/{team_id}"
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "delete-a-team-legacy",
"subcategory": "teams",
"slug": "remove-the-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
"verb": "delete",
"requestPath": "/teams/{team_id}"
},
{
"slug": "list-discussions-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "create-a-discussion-legacy",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "get-a-discussion-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion-legacy",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion-legacy",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-team-members-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/members"
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "get-team-member-legacy",
@@ -3357,78 +3105,6 @@
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/members/{username}"
},
{
"slug": "get-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "put",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "list-team-projects-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects"
},
{
"slug": "check-team-permissions-for-a-project-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "list-team-repositories-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos"
},
{
"slug": "check-team-permissions-for-a-repository-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/teams"
}
],
"users": [

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,5 +1,83 @@
{
"actions": [
{
"slug": "get-github-actions-cache-usage-for-an-enterprise",
"subcategory": "cache",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage"
},
{
"slug": "get-github-actions-cache-usage-policy-for-an-enterprise",
"subcategory": "cache",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy"
},
{
"slug": "set-github-actions-cache-usage-policy-for-an-enterprise",
"subcategory": "cache",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy"
},
{
"slug": "get-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "set-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "list-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "set-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "enable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "disable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "delete",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "get-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "set-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "get-default-workflow-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/workflow"
},
{
"slug": "set-default-workflow-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/workflow"
},
{
"slug": "get-github-actions-cache-usage-for-an-organization",
"subcategory": "cache",
@@ -564,6 +642,18 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"
},
{
"slug": "review-pending-deployments-for-a-workflow-run",
"subcategory": "workflow-runs",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"
},
{
"slug": "re-run-a-workflow",
"subcategory": "workflow-runs",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun"
},
{
"slug": "re-run-failed-jobs-from-a-workflow-run",
"subcategory": "workflow-runs",
@@ -748,36 +838,6 @@
}
],
"apps": [
{
"slug": "get-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app"
},
{
"slug": "list-installation-requests-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installation-requests"
},
{
"slug": "list-installations-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations"
},
{
"slug": "get-an-installation-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations/{installation_id}"
},
{
"slug": "create-an-installation-access-token-for-an-app",
"subcategory": "apps",
"verb": "post",
"requestPath": "/app/installations/{installation_id}/access_tokens"
},
{
"slug": "get-an-app",
"subcategory": "apps",
@@ -789,12 +849,6 @@
"subcategory": "installations",
"verb": "get",
"requestPath": "/installation/repositories"
},
{
"slug": "revoke-an-installation-access-token",
"subcategory": "installations",
"verb": "delete",
"requestPath": "/installation/token"
}
],
"billing": [
@@ -1408,6 +1462,12 @@
}
],
"dependency-graph": [
{
"slug": "get-a-diff-of-the-dependencies-between-commits",
"subcategory": "dependency-review",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}"
},
{
"slug": "create-a-snapshot-of-dependencies-for-a-repository",
"subcategory": "dependency-submission",
@@ -1548,6 +1608,18 @@
}
],
"enterprise-admin": [
{
"slug": "get-the-audit-log-for-an-enterprise",
"subcategory": "audit-log",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/audit-log"
},
{
"slug": "get-github-advanced-security-active-committers-for-an-enterprise",
"subcategory": "billing",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/settings/billing/advanced-security"
},
{
"slug": "list-pre-receive-hooks-for-an-organization",
"subcategory": "org-pre-receive-hooks",
@@ -1560,12 +1632,6 @@
"verb": "get",
"requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "update-pre-receive-hook-enforcement-for-an-organization",
"subcategory": "org-pre-receive-hooks",
"verb": "patch",
"requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "remove-pre-receive-hook-enforcement-for-an-organization",
"subcategory": "org-pre-receive-hooks",
@@ -1584,12 +1650,6 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "update-pre-receive-hook-enforcement-for-a-repository",
"subcategory": "repo-pre-receive-hooks",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "remove-pre-receive-hook-enforcement-for-a-repository",
"subcategory": "repo-pre-receive-hooks",
@@ -1689,7 +1749,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit-object",
"slug": "get-a-commit",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"
@@ -2272,24 +2332,6 @@
"verb": "post",
"requestPath": "/orgs/{org}/{security_product}/{enablement}"
},
{
"slug": "list-organization-memberships-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs"
},
{
"slug": "get-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "update-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "patch",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "list-organizations-for-a-user",
"subcategory": "orgs",
@@ -2491,12 +2533,6 @@
"subcategory": "projects",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/projects"
},
{
"slug": "create-a-user-project",
"subcategory": "projects",
"verb": "post",
"requestPath": "/user/projects"
}
],
"pulls": [
@@ -2560,6 +2596,12 @@
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments"
},
{
"slug": "create-a-reply-for-a-review-comment",
"subcategory": "comments",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"
},
{
"slug": "list-commits-on-a-pull-request",
"subcategory": "pulls",
@@ -2649,41 +2691,21 @@
"subcategory": "reviews",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"
}
],
"rate-limit": [
},
{
"slug": "get-rate-limit-status-for-the-authenticated-user",
"subcategory": "rate-limit",
"verb": "get",
"requestPath": "/rate_limit"
"slug": "update-a-pull-request-branch",
"subcategory": "pulls",
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch"
}
],
"reactions": [
{
"slug": "list-reactions-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "create-reaction-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "delete-team-discussion-comment-reaction",
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-team-discussion",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"
},
{
"slug": "delete-team-discussion-reaction",
"subcategory": "reactions",
@@ -2732,6 +2754,12 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "create-reaction-for-an-issue",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "delete-an-issue-reaction",
"subcategory": "reactions",
@@ -2773,24 +2801,6 @@
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-team-discussion-comment-legacy",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "create-reaction-for-a-team-discussion-comment-legacy",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "list-reactions-for-a-team-discussion-legacy",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions"
}
],
"releases": [
@@ -2865,12 +2875,6 @@
"subcategory": "assets",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
},
{
"slug": "upload-a-release-asset",
"subcategory": "assets",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
}
],
"repos": [
@@ -2982,18 +2986,6 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/languages"
},
{
"slug": "get-a-repository-readme",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme"
},
{
"slug": "get-a-repository-readme-for-a-directory",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme/{dir}"
},
{
"slug": "list-repository-cache-replication-status",
"subcategory": "repos",
@@ -3024,12 +3016,6 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}"
},
{
"slug": "download-a-repository-archive-tar",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/tarball/{ref}"
},
{
"slug": "list-repository-teams",
"subcategory": "repos",
@@ -3048,18 +3034,6 @@
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/topics"
},
{
"slug": "transfer-a-repository",
"subcategory": "repos",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/transfer"
},
{
"slug": "download-a-repository-archive-zip",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}"
},
{
"slug": "list-public-repositories",
"subcategory": "repos",
@@ -3174,84 +3148,6 @@
"verb": "post",
"requestPath": "/orgs/{org}/teams"
},
{
"slug": "get-a-team-by-name",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "update-a-team",
"subcategory": "teams",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "delete-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "list-discussions",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "create-a-discussion",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "get-a-discussion",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-a-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
@@ -3259,166 +3155,16 @@
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "list-team-members",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/members"
},
{
"slug": "get-team-membership-for-a-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user",
"subcategory": "members",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user",
"subcategory": "members",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "list-team-projects",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects"
},
{
"slug": "check-team-permissions-for-a-project",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "list-team-repositories",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos"
},
{
"slug": "check-team-permissions-for-a-repository",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/teams"
},
{
"slug": "get-a-team-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}"
},
{
"slug": "update-a-team-legacy",
"subcategory": "teams",
"slug": "update-the-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
"verb": "patch",
"requestPath": "/teams/{team_id}"
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "delete-a-team-legacy",
"subcategory": "teams",
"slug": "remove-the-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
"verb": "delete",
"requestPath": "/teams/{team_id}"
},
{
"slug": "list-discussions-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "create-a-discussion-legacy",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "get-a-discussion-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion-legacy",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion-legacy",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-team-members-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/members"
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "get-team-member-legacy",
@@ -3437,78 +3183,6 @@
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/members/{username}"
},
{
"slug": "get-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "put",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "list-team-projects-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects"
},
{
"slug": "check-team-permissions-for-a-project-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "list-team-repositories-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos"
},
{
"slug": "check-team-permissions-for-a-repository-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/teams"
}
],
"users": [

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,5 +1,83 @@
{
"actions": [
{
"slug": "get-github-actions-cache-usage-for-an-enterprise",
"subcategory": "cache",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage"
},
{
"slug": "get-github-actions-cache-usage-policy-for-an-enterprise",
"subcategory": "cache",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy"
},
{
"slug": "set-github-actions-cache-usage-policy-for-an-enterprise",
"subcategory": "cache",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy"
},
{
"slug": "get-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "set-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "list-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "set-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "enable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "disable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "delete",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "get-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "set-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "get-default-workflow-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/workflow"
},
{
"slug": "set-default-workflow-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/workflow"
},
{
"slug": "get-github-actions-cache-usage-for-an-organization",
"subcategory": "cache",
@@ -114,12 +192,6 @@
"verb": "delete",
"requestPath": "/orgs/{org}/actions/required_workflows/{required_workflow_id}"
},
{
"slug": "list-selected-repositories-for-a-required-workflow",
"subcategory": "required-workflows",
"verb": "get",
"requestPath": "/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories"
},
{
"slug": "sets-repositories-for-a-required-workflow",
"subcategory": "required-workflows",
@@ -384,12 +456,6 @@
"verb": "put",
"requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}"
},
{
"slug": "remove-selected-repository-from-an-organization-variable",
"subcategory": "variables",
"verb": "delete",
"requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}"
},
{
"slug": "list-repository-required-workflows",
"subcategory": "required-workflows",
@@ -690,6 +756,18 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"
},
{
"slug": "review-pending-deployments-for-a-workflow-run",
"subcategory": "workflow-runs",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"
},
{
"slug": "re-run-a-workflow",
"subcategory": "workflow-runs",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun"
},
{
"slug": "re-run-failed-jobs-from-a-workflow-run",
"subcategory": "workflow-runs",
@@ -954,36 +1032,6 @@
}
],
"apps": [
{
"slug": "get-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app"
},
{
"slug": "list-installation-requests-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installation-requests"
},
{
"slug": "list-installations-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations"
},
{
"slug": "get-an-installation-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations/{installation_id}"
},
{
"slug": "create-an-installation-access-token-for-an-app",
"subcategory": "apps",
"verb": "post",
"requestPath": "/app/installations/{installation_id}/access_tokens"
},
{
"slug": "get-an-app",
"subcategory": "apps",
@@ -995,12 +1043,6 @@
"subcategory": "installations",
"verb": "get",
"requestPath": "/installation/repositories"
},
{
"slug": "revoke-an-installation-access-token",
"subcategory": "installations",
"verb": "delete",
"requestPath": "/installation/token"
}
],
"billing": [
@@ -1638,6 +1680,12 @@
}
],
"dependency-graph": [
{
"slug": "get-a-diff-of-the-dependencies-between-commits",
"subcategory": "dependency-review",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}"
},
{
"slug": "create-a-snapshot-of-dependencies-for-a-repository",
"subcategory": "dependency-submission",
@@ -1778,6 +1826,18 @@
}
],
"enterprise-admin": [
{
"slug": "get-the-audit-log-for-an-enterprise",
"subcategory": "audit-log",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/audit-log"
},
{
"slug": "get-github-advanced-security-active-committers-for-an-enterprise",
"subcategory": "billing",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/settings/billing/advanced-security"
},
{
"slug": "list-pre-receive-hooks-for-an-organization",
"subcategory": "org-pre-receive-hooks",
@@ -1790,12 +1850,6 @@
"verb": "get",
"requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "update-pre-receive-hook-enforcement-for-an-organization",
"subcategory": "org-pre-receive-hooks",
"verb": "patch",
"requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "remove-pre-receive-hook-enforcement-for-an-organization",
"subcategory": "org-pre-receive-hooks",
@@ -1814,12 +1868,6 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "update-pre-receive-hook-enforcement-for-a-repository",
"subcategory": "repo-pre-receive-hooks",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "remove-pre-receive-hook-enforcement-for-a-repository",
"subcategory": "repo-pre-receive-hooks",
@@ -1919,7 +1967,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit-object",
"slug": "get-a-commit",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"
@@ -2502,24 +2550,6 @@
"verb": "post",
"requestPath": "/orgs/{org}/{security_product}/{enablement}"
},
{
"slug": "list-organization-memberships-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs"
},
{
"slug": "get-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "update-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "patch",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "list-organizations-for-a-user",
"subcategory": "orgs",
@@ -2721,12 +2751,6 @@
"subcategory": "projects",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/projects"
},
{
"slug": "create-a-user-project",
"subcategory": "projects",
"verb": "post",
"requestPath": "/user/projects"
}
],
"pulls": [
@@ -2790,6 +2814,12 @@
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments"
},
{
"slug": "create-a-reply-for-a-review-comment",
"subcategory": "comments",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"
},
{
"slug": "list-commits-on-a-pull-request",
"subcategory": "pulls",
@@ -2879,41 +2909,21 @@
"subcategory": "reviews",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"
}
],
"rate-limit": [
},
{
"slug": "get-rate-limit-status-for-the-authenticated-user",
"subcategory": "rate-limit",
"verb": "get",
"requestPath": "/rate_limit"
"slug": "update-a-pull-request-branch",
"subcategory": "pulls",
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch"
}
],
"reactions": [
{
"slug": "list-reactions-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "create-reaction-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "delete-team-discussion-comment-reaction",
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-team-discussion",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"
},
{
"slug": "delete-team-discussion-reaction",
"subcategory": "reactions",
@@ -2962,6 +2972,12 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "create-reaction-for-an-issue",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "delete-an-issue-reaction",
"subcategory": "reactions",
@@ -3003,24 +3019,6 @@
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-team-discussion-comment-legacy",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "create-reaction-for-a-team-discussion-comment-legacy",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "list-reactions-for-a-team-discussion-legacy",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions"
}
],
"releases": [
@@ -3095,12 +3093,6 @@
"subcategory": "assets",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
},
{
"slug": "upload-a-release-asset",
"subcategory": "assets",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
}
],
"repos": [
@@ -3212,18 +3204,6 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/languages"
},
{
"slug": "get-a-repository-readme",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme"
},
{
"slug": "get-a-repository-readme-for-a-directory",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme/{dir}"
},
{
"slug": "list-repository-cache-replication-status",
"subcategory": "repos",
@@ -3254,12 +3234,6 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}"
},
{
"slug": "download-a-repository-archive-tar",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/tarball/{ref}"
},
{
"slug": "list-repository-teams",
"subcategory": "repos",
@@ -3278,18 +3252,6 @@
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/topics"
},
{
"slug": "transfer-a-repository",
"subcategory": "repos",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/transfer"
},
{
"slug": "download-a-repository-archive-zip",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}"
},
{
"slug": "list-public-repositories",
"subcategory": "repos",
@@ -3404,84 +3366,6 @@
"verb": "post",
"requestPath": "/orgs/{org}/teams"
},
{
"slug": "get-a-team-by-name",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "update-a-team",
"subcategory": "teams",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "delete-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "list-discussions",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "create-a-discussion",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "get-a-discussion",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-a-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
@@ -3489,166 +3373,16 @@
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "list-team-members",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/members"
},
{
"slug": "get-team-membership-for-a-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user",
"subcategory": "members",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user",
"subcategory": "members",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "list-team-projects",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects"
},
{
"slug": "check-team-permissions-for-a-project",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "list-team-repositories",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos"
},
{
"slug": "check-team-permissions-for-a-repository",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/teams"
},
{
"slug": "get-a-team-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}"
},
{
"slug": "update-a-team-legacy",
"subcategory": "teams",
"slug": "update-the-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
"verb": "patch",
"requestPath": "/teams/{team_id}"
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "delete-a-team-legacy",
"subcategory": "teams",
"slug": "remove-the-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
"verb": "delete",
"requestPath": "/teams/{team_id}"
},
{
"slug": "list-discussions-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "create-a-discussion-legacy",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "get-a-discussion-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion-legacy",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion-legacy",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-team-members-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/members"
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "get-team-member-legacy",
@@ -3667,78 +3401,6 @@
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/members/{username}"
},
{
"slug": "get-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "put",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "list-team-projects-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects"
},
{
"slug": "check-team-permissions-for-a-project-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "list-team-repositories-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos"
},
{
"slug": "check-team-permissions-for-a-repository-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/teams"
}
],
"users": [

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,5 +1,83 @@
{
"actions": [
{
"slug": "get-github-actions-cache-usage-for-an-enterprise",
"subcategory": "cache",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage"
},
{
"slug": "get-github-actions-cache-usage-policy-for-an-enterprise",
"subcategory": "cache",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy"
},
{
"slug": "set-github-actions-cache-usage-policy-for-an-enterprise",
"subcategory": "cache",
"verb": "patch",
"requestPath": "/enterprises/{enterprise}/actions/cache/usage-policy"
},
{
"slug": "get-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "set-github-actions-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions"
},
{
"slug": "list-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "set-selected-organizations-enabled-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations"
},
{
"slug": "enable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "disable-a-selected-organization-for-github-actions-in-an-enterprise",
"subcategory": "permissions",
"verb": "delete",
"requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}"
},
{
"slug": "get-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "set-allowed-actions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions"
},
{
"slug": "get-default-workflow-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/actions/permissions/workflow"
},
{
"slug": "set-default-workflow-permissions-for-an-enterprise",
"subcategory": "permissions",
"verb": "put",
"requestPath": "/enterprises/{enterprise}/actions/permissions/workflow"
},
{
"slug": "get-github-actions-cache-usage-for-an-organization",
"subcategory": "cache",
@@ -114,12 +192,6 @@
"verb": "delete",
"requestPath": "/orgs/{org}/actions/required_workflows/{required_workflow_id}"
},
{
"slug": "list-selected-repositories-for-a-required-workflow",
"subcategory": "required-workflows",
"verb": "get",
"requestPath": "/orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories"
},
{
"slug": "sets-repositories-for-a-required-workflow",
"subcategory": "required-workflows",
@@ -384,12 +456,6 @@
"verb": "put",
"requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}"
},
{
"slug": "remove-selected-repository-from-an-organization-variable",
"subcategory": "variables",
"verb": "delete",
"requestPath": "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}"
},
{
"slug": "list-repository-required-workflows",
"subcategory": "required-workflows",
@@ -702,6 +768,18 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"
},
{
"slug": "review-pending-deployments-for-a-workflow-run",
"subcategory": "workflow-runs",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments"
},
{
"slug": "re-run-a-workflow",
"subcategory": "workflow-runs",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun"
},
{
"slug": "re-run-failed-jobs-from-a-workflow-run",
"subcategory": "workflow-runs",
@@ -966,36 +1044,6 @@
}
],
"apps": [
{
"slug": "get-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app"
},
{
"slug": "list-installation-requests-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installation-requests"
},
{
"slug": "list-installations-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations"
},
{
"slug": "get-an-installation-for-the-authenticated-app",
"subcategory": "apps",
"verb": "get",
"requestPath": "/app/installations/{installation_id}"
},
{
"slug": "create-an-installation-access-token-for-an-app",
"subcategory": "apps",
"verb": "post",
"requestPath": "/app/installations/{installation_id}/access_tokens"
},
{
"slug": "get-an-app",
"subcategory": "apps",
@@ -1007,12 +1055,6 @@
"subcategory": "installations",
"verb": "get",
"requestPath": "/installation/repositories"
},
{
"slug": "revoke-an-installation-access-token",
"subcategory": "installations",
"verb": "delete",
"requestPath": "/installation/token"
}
],
"billing": [
@@ -1376,12 +1418,6 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}"
},
{
"slug": "get-a-code-scanning-default-setup-configuration",
"subcategory": "code-scanning",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/code-scanning/default-setup"
},
{
"slug": "update-a-code-scanning-default-setup-configuration",
"subcategory": "code-scanning",
@@ -1662,6 +1698,18 @@
}
],
"dependency-graph": [
{
"slug": "get-a-diff-of-the-dependencies-between-commits",
"subcategory": "dependency-review",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}"
},
{
"slug": "export-a-software-bill-of-materials-sbom-for-a-repository",
"subcategory": "sboms",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/dependency-graph/sbom"
},
{
"slug": "create-a-snapshot-of-dependencies-for-a-repository",
"subcategory": "dependency-submission",
@@ -1802,6 +1850,18 @@
}
],
"enterprise-admin": [
{
"slug": "get-the-audit-log-for-an-enterprise",
"subcategory": "audit-log",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/audit-log"
},
{
"slug": "get-github-advanced-security-active-committers-for-an-enterprise",
"subcategory": "billing",
"verb": "get",
"requestPath": "/enterprises/{enterprise}/settings/billing/advanced-security"
},
{
"slug": "list-pre-receive-hooks-for-an-organization",
"subcategory": "org-pre-receive-hooks",
@@ -1814,12 +1874,6 @@
"verb": "get",
"requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "update-pre-receive-hook-enforcement-for-an-organization",
"subcategory": "org-pre-receive-hooks",
"verb": "patch",
"requestPath": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "remove-pre-receive-hook-enforcement-for-an-organization",
"subcategory": "org-pre-receive-hooks",
@@ -1838,12 +1892,6 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "update-pre-receive-hook-enforcement-for-a-repository",
"subcategory": "repo-pre-receive-hooks",
"verb": "patch",
"requestPath": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}"
},
{
"slug": "remove-pre-receive-hook-enforcement-for-a-repository",
"subcategory": "repo-pre-receive-hooks",
@@ -1943,7 +1991,7 @@
"requestPath": "/repos/{owner}/{repo}/git/commits"
},
{
"slug": "get-a-commit-object",
"slug": "get-a-commit",
"subcategory": "commits",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/git/commits/{commit_sha}"
@@ -2538,12 +2586,6 @@
"verb": "get",
"requestPath": "/orgs/{org}/public_members/{username}"
},
{
"slug": "list-repository-fine-grained-permissions-for-an-organization",
"subcategory": "custom-roles",
"verb": "get",
"requestPath": "/orgs/{org}/repository-fine-grained-permissions"
},
{
"slug": "list-security-manager-teams",
"subcategory": "security-managers",
@@ -2568,24 +2610,6 @@
"verb": "post",
"requestPath": "/orgs/{org}/{security_product}/{enablement}"
},
{
"slug": "list-organization-memberships-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs"
},
{
"slug": "get-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "update-an-organization-membership-for-the-authenticated-user",
"subcategory": "members",
"verb": "patch",
"requestPath": "/user/memberships/orgs/{org}"
},
{
"slug": "list-organizations-for-a-user",
"subcategory": "orgs",
@@ -2593,6 +2617,164 @@
"requestPath": "/users/{username}/orgs"
}
],
"packages": [
{
"slug": "get-list-of-conflicting-packages-during-docker-migration-for-organization",
"subcategory": "packages",
"verb": "get",
"requestPath": "/orgs/{org}/docker/conflicts"
},
{
"slug": "list-packages-for-an-organization",
"subcategory": "packages",
"verb": "get",
"requestPath": "/orgs/{org}/packages"
},
{
"slug": "get-a-package-for-an-organization",
"subcategory": "packages",
"verb": "get",
"requestPath": "/orgs/{org}/packages/{package_type}/{package_name}"
},
{
"slug": "delete-a-package-for-an-organization",
"subcategory": "packages",
"verb": "delete",
"requestPath": "/orgs/{org}/packages/{package_type}/{package_name}"
},
{
"slug": "restore-a-package-for-an-organization",
"subcategory": "packages",
"verb": "post",
"requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/restore"
},
{
"slug": "list-package-versions-for-a-package-owned-by-an-organization",
"subcategory": "packages",
"verb": "get",
"requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions"
},
{
"slug": "get-a-package-version-for-an-organization",
"subcategory": "packages",
"verb": "get",
"requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"
},
{
"slug": "delete-package-version-for-an-organization",
"subcategory": "packages",
"verb": "delete",
"requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}"
},
{
"slug": "restore-package-version-for-an-organization",
"subcategory": "packages",
"verb": "post",
"requestPath": "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"
},
{
"slug": "list-packages-for-the-authenticated-users-namespace",
"subcategory": "packages",
"verb": "get",
"requestPath": "/user/packages"
},
{
"slug": "get-a-package-for-the-authenticated-user",
"subcategory": "packages",
"verb": "get",
"requestPath": "/user/packages/{package_type}/{package_name}"
},
{
"slug": "delete-a-package-for-the-authenticated-user",
"subcategory": "packages",
"verb": "delete",
"requestPath": "/user/packages/{package_type}/{package_name}"
},
{
"slug": "restore-a-package-for-the-authenticated-user",
"subcategory": "packages",
"verb": "post",
"requestPath": "/user/packages/{package_type}/{package_name}/restore"
},
{
"slug": "list-package-versions-for-a-package-owned-by-the-authenticated-user",
"subcategory": "packages",
"verb": "get",
"requestPath": "/user/packages/{package_type}/{package_name}/versions"
},
{
"slug": "get-a-package-version-for-the-authenticated-user",
"subcategory": "packages",
"verb": "get",
"requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}"
},
{
"slug": "delete-a-package-version-for-the-authenticated-user",
"subcategory": "packages",
"verb": "delete",
"requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}"
},
{
"slug": "restore-a-package-version-for-the-authenticated-user",
"subcategory": "packages",
"verb": "post",
"requestPath": "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"
},
{
"slug": "get-list-of-conflicting-packages-during-docker-migration-for-user",
"subcategory": "packages",
"verb": "get",
"requestPath": "/users/{username}/docker/conflicts"
},
{
"slug": "list-packages-for-a-user",
"subcategory": "packages",
"verb": "get",
"requestPath": "/users/{username}/packages"
},
{
"slug": "get-a-package-for-a-user",
"subcategory": "packages",
"verb": "get",
"requestPath": "/users/{username}/packages/{package_type}/{package_name}"
},
{
"slug": "delete-a-package-for-a-user",
"subcategory": "packages",
"verb": "delete",
"requestPath": "/users/{username}/packages/{package_type}/{package_name}"
},
{
"slug": "restore-a-package-for-a-user",
"subcategory": "packages",
"verb": "post",
"requestPath": "/users/{username}/packages/{package_type}/{package_name}/restore"
},
{
"slug": "list-package-versions-for-a-package-owned-by-a-user",
"subcategory": "packages",
"verb": "get",
"requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions"
},
{
"slug": "get-a-package-version-for-a-user",
"subcategory": "packages",
"verb": "get",
"requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"
},
{
"slug": "delete-package-version-for-a-user",
"subcategory": "packages",
"verb": "delete",
"requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}"
},
{
"slug": "restore-package-version-for-a-user",
"subcategory": "packages",
"verb": "post",
"requestPath": "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore"
}
],
"pages": [
{
"slug": "get-a-github-enterprise-server-pages-site",
@@ -2787,12 +2969,6 @@
"subcategory": "projects",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/projects"
},
{
"slug": "create-a-user-project",
"subcategory": "projects",
"verb": "post",
"requestPath": "/user/projects"
}
],
"pulls": [
@@ -2856,6 +3032,12 @@
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments"
},
{
"slug": "create-a-reply-for-a-review-comment",
"subcategory": "comments",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies"
},
{
"slug": "list-commits-on-a-pull-request",
"subcategory": "pulls",
@@ -2945,41 +3127,21 @@
"subcategory": "reviews",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events"
}
],
"rate-limit": [
},
{
"slug": "get-rate-limit-status-for-the-authenticated-user",
"subcategory": "rate-limit",
"verb": "get",
"requestPath": "/rate_limit"
"slug": "update-a-pull-request-branch",
"subcategory": "pulls",
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch"
}
],
"reactions": [
{
"slug": "list-reactions-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "create-reaction-for-a-team-discussion-comment",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "delete-team-discussion-comment-reaction",
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-team-discussion",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions"
},
{
"slug": "delete-team-discussion-reaction",
"subcategory": "reactions",
@@ -3028,6 +3190,12 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "create-reaction-for-an-issue",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/reactions"
},
{
"slug": "delete-an-issue-reaction",
"subcategory": "reactions",
@@ -3069,24 +3237,6 @@
"subcategory": "reactions",
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}"
},
{
"slug": "list-reactions-for-a-team-discussion-comment-legacy",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "create-reaction-for-a-team-discussion-comment-legacy",
"subcategory": "reactions",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions"
},
{
"slug": "list-reactions-for-a-team-discussion-legacy",
"subcategory": "reactions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/reactions"
}
],
"releases": [
@@ -3161,12 +3311,6 @@
"subcategory": "assets",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
},
{
"slug": "upload-a-release-asset",
"subcategory": "assets",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets"
}
],
"repos": [
@@ -3278,18 +3422,6 @@
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/languages"
},
{
"slug": "get-a-repository-readme",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme"
},
{
"slug": "get-a-repository-readme-for-a-directory",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/readme/{dir}"
},
{
"slug": "list-repository-cache-replication-status",
"subcategory": "repos",
@@ -3320,12 +3452,6 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}"
},
{
"slug": "download-a-repository-archive-tar",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/tarball/{ref}"
},
{
"slug": "list-repository-teams",
"subcategory": "repos",
@@ -3345,10 +3471,10 @@
"requestPath": "/repos/{owner}/{repo}/topics"
},
{
"slug": "transfer-a-repository",
"slug": "check-if-vulnerability-alerts-are-enabled-for-a-repository",
"subcategory": "repos",
"verb": "post",
"requestPath": "/repos/{owner}/{repo}/transfer"
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts"
},
{
"slug": "enable-vulnerability-alerts",
@@ -3362,12 +3488,6 @@
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts"
},
{
"slug": "download-a-repository-archive-zip",
"subcategory": "contents",
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}"
},
{
"slug": "list-public-repositories",
"subcategory": "repos",
@@ -3482,84 +3602,6 @@
"verb": "post",
"requestPath": "/orgs/{org}/teams"
},
{
"slug": "get-a-team-by-name",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "update-a-team",
"subcategory": "teams",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "delete-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}"
},
{
"slug": "list-discussions",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "create-a-discussion",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions"
},
{
"slug": "get-a-discussion",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-a-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
@@ -3567,166 +3609,16 @@
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "list-team-members",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/members"
},
{
"slug": "get-team-membership-for-a-user",
"subcategory": "members",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user",
"subcategory": "members",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user",
"subcategory": "members",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}"
},
{
"slug": "list-team-projects",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects"
},
{
"slug": "check-team-permissions-for-a-project",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}"
},
{
"slug": "list-team-repositories",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos"
},
{
"slug": "check-team-permissions-for-a-repository",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions",
"subcategory": "teams",
"verb": "put",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams",
"subcategory": "teams",
"verb": "get",
"requestPath": "/orgs/{org}/teams/{team_slug}/teams"
},
{
"slug": "get-a-team-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}"
},
{
"slug": "update-a-team-legacy",
"subcategory": "teams",
"slug": "update-the-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
"verb": "patch",
"requestPath": "/teams/{team_id}"
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "delete-a-team-legacy",
"subcategory": "teams",
"slug": "remove-the-connection-between-an-external-group-and-a-team",
"subcategory": "external-groups",
"verb": "delete",
"requestPath": "/teams/{team_id}"
},
{
"slug": "list-discussions-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "create-a-discussion-legacy",
"subcategory": "discussions",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions"
},
{
"slug": "get-a-discussion-legacy",
"subcategory": "discussions",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "update-a-discussion-legacy",
"subcategory": "discussions",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "delete-a-discussion-legacy",
"subcategory": "discussions",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}"
},
{
"slug": "list-discussion-comments-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "create-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "post",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments"
},
{
"slug": "get-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "get",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "update-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "patch",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "delete-a-discussion-comment-legacy",
"subcategory": "discussion-comments",
"verb": "delete",
"requestPath": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}"
},
{
"slug": "list-team-members-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/members"
"requestPath": "/orgs/{org}/teams/{team_slug}/external-groups"
},
{
"slug": "get-team-member-legacy",
@@ -3745,93 +3637,9 @@
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/members/{username}"
},
{
"slug": "get-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "get",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "add-or-update-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "put",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "remove-team-membership-for-a-user-legacy",
"subcategory": "members",
"verb": "delete",
"requestPath": "/teams/{team_id}/memberships/{username}"
},
{
"slug": "list-team-projects-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects"
},
{
"slug": "check-team-permissions-for-a-project-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "add-or-update-team-project-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "remove-a-project-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/projects/{project_id}"
},
{
"slug": "list-team-repositories-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos"
},
{
"slug": "check-team-permissions-for-a-repository-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "add-or-update-team-repository-permissions-legacy",
"subcategory": "teams",
"verb": "put",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "remove-a-repository-from-a-team-legacy",
"subcategory": "teams",
"verb": "delete",
"requestPath": "/teams/{team_id}/repos/{owner}/{repo}"
},
{
"slug": "list-child-teams-legacy",
"subcategory": "teams",
"verb": "get",
"requestPath": "/teams/{team_id}/teams"
}
],
"users": [
{
"slug": "add-social-accounts-for-the-authenticated-user",
"subcategory": "social-accounts",
"verb": "post",
"requestPath": "/user/social_accounts"
},
{
"slug": "delete-social-accounts-for-the-authenticated-user",
"subcategory": "social-accounts",
"verb": "delete",
"requestPath": "/user/social_accounts"
},
{
"slug": "list-users",
"subcategory": "users",

File diff suppressed because it is too large Load Diff

View File

@@ -1,4 +1,57 @@
{
"targetDirectory": "content/rest/overview",
"pages": {
"server-to-server-rest": {
"frontmatterDefaults": {
"versions": {
"fpt": "*",
"ghae": "*",
"ghec": "*",
"ghes": "*"
},
"autogenerated": "github-apps"
},
"targetFilename": "content/rest/overview/endpoints-available-for-github-app-installation-access-tokens.md"
},
"user-to-server-rest": {
"frontmatterDefaults": {
"versions": {
"fpt": "*",
"ghae": "*",
"ghec": "*",
"ghes": "*"
},
"autogenerated": "github-apps"
},
"targetFilename": "content/rest/overview/endpoints-available-for-github-app-user-access-tokens.md"
},
"server-to-server-permissions": {
"frontmatterDefaults": {
"versions": {
"fpt": "*",
"ghae": "*",
"ghec": "*",
"ghes": "*"
},
"autogenerated": "github-apps"
},
"targetFilename": "content/rest/overview/permissions-required-for-github-apps.md"
},
"fine-grained-pat": {
"frontmatterDefaults": {
"versions": "data/features/pat-v2.yml",
"autogenerated": "github-apps"
},
"targetFilename": "content/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens.md"
},
"fine-grained-pat-permissions": {
"frontmatterDefaults": {
"versions": "data/features/pat-v2.yml",
"autogenerated": "github-apps"
},
"targetFilename": "content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md"
}
},
"api-versions": {
"fpt": [
"2022-11-28"

View File

@@ -1,22 +1,55 @@
import path from 'path'
import { readFile } from 'fs/promises'
import { readCompressedJsonFileFallback } from '../../../lib/read-json-file.js'
import { getOpenApiVersion } from '../../../lib/all-versions.js'
import { categoriesWithoutSubcategories } from '../../rest/lib/index.js'
export const ENABLED_APPS_DIR = 'src/github-apps/data'
export const ENABLED_APPS_FILENAME = 'server-to-server-rest.json'
const ENABLED_APPS_DIR = 'src/github-apps/data'
const githubAppsData = new Map()
const enabledForApps = new Map()
// Initialize the Map with the page type keys listed under `pages`
// in the config.json file.
const appsDataConfig = JSON.parse(await readFile('src/github-apps/lib/config.json', 'utf8'))
for (const pageType of Object.keys(appsDataConfig.pages)) {
githubAppsData.set(pageType, new Map())
}
export async function getEnabledForApps(docsVersion, apiVersion) {
export async function getAppsData(pageType, docsVersion, apiVersion) {
const pageTypeMap = githubAppsData.get(pageType)
const filename = `${pageType}.json`
const openApiVersion = getOpenApiVersion(docsVersion) + (apiVersion ? `-${apiVersion}` : '')
if (!enabledForApps.has(openApiVersion)) {
if (!pageTypeMap.has(openApiVersion)) {
// The `readCompressedJsonFileFallback()` function
// will check for both a .br and .json extension.
const appDataPath = path.join(ENABLED_APPS_DIR, openApiVersion, ENABLED_APPS_FILENAME)
const appDataPath = path.join(ENABLED_APPS_DIR, openApiVersion, filename)
const data = readCompressedJsonFileFallback(appDataPath)
enabledForApps.set(openApiVersion, data)
pageTypeMap.set(openApiVersion, data)
}
return enabledForApps.get(openApiVersion)
return pageTypeMap.get(openApiVersion)
}
export async function getAppsServerSideProps(context, pageType, { useDisplayTitle = false }) {
const { getAutomatedPageMiniTocItems } = await import('lib/get-mini-toc-items')
const { getAutomatedPageContextFromRequest } = await import(
'src/automated-pipelines/components/AutomatedPageContext'
)
const currentVersion = context.query.versionId
const allVersions = context.req.context.allVersions
const queryApiVersion = context.query.apiVersion
const apiVersion = allVersions[currentVersion].apiVersions.includes(queryApiVersion)
? queryApiVersion
: allVersions[currentVersion].latestApiVersion
const appsItems = await getAppsData(pageType, currentVersion, apiVersion)
// Create minitoc
const { miniTocItems } = getAutomatedPageContextFromRequest(context.req)
const titles = useDisplayTitle
? Object.values(appsItems).map((item) => item.displayTitle)
: Object.keys(appsItems)
const appMiniToc = await getAutomatedPageMiniTocItems(titles, context)
appMiniToc && miniTocItems.push(...appMiniToc)
return { currentVersion, appsItems, categoriesWithoutSubcategories }
}

View File

@@ -0,0 +1,51 @@
import { GetServerSideProps } from 'next'
import {
AutomatedPageContextT,
getAutomatedPageContextFromRequest,
} from 'src/automated-pipelines/components/AutomatedPageContext'
import { MainContextT, getMainContext } from 'components/context/MainContext'
import { EnabledList, EnabledListT } from 'src/github-apps/components/EnabledList'
type Props = {
mainContext: MainContextT
currentVersion: string
appsItems: EnabledListT
automatedPageContext: AutomatedPageContextT
categoriesWithoutSubcategories: string[]
}
export default function FineGrainedTokenEndpoints({
mainContext,
currentVersion,
appsItems,
automatedPageContext,
categoriesWithoutSubcategories,
}: Props) {
return (
<EnabledList
items={appsItems}
currentVersion={currentVersion}
categoriesWithoutSubcategories={categoriesWithoutSubcategories}
mainContext={mainContext}
automatedPageContext={automatedPageContext}
/>
)
}
export const getServerSideProps: GetServerSideProps<Props> = async (context) => {
const { getAppsServerSideProps } = await import('src/github-apps/lib/index.js')
const { currentVersion, appsItems, categoriesWithoutSubcategories } =
await getAppsServerSideProps(context, 'fine-grained-pat', { useDisplayTitle: false })
return {
props: {
mainContext: await getMainContext(context.req, context.res),
currentVersion,
appsItems,
automatedPageContext: getAutomatedPageContextFromRequest(context.req),
categoriesWithoutSubcategories,
},
}
}

View File

@@ -0,0 +1,51 @@
import { GetServerSideProps } from 'next'
import {
AutomatedPageContextT,
getAutomatedPageContextFromRequest,
} from 'src/automated-pipelines/components/AutomatedPageContext'
import { MainContextT, getMainContext } from 'components/context/MainContext'
import { EnabledList, EnabledListT } from 'src/github-apps/components/EnabledList'
type Props = {
mainContext: MainContextT
currentVersion: string
appsItems: EnabledListT
automatedPageContext: AutomatedPageContextT
categoriesWithoutSubcategories: string[]
}
export default function GitHubAppEndpoints({
mainContext,
currentVersion,
appsItems,
automatedPageContext,
categoriesWithoutSubcategories,
}: Props) {
return (
<EnabledList
items={appsItems}
currentVersion={currentVersion}
categoriesWithoutSubcategories={categoriesWithoutSubcategories}
mainContext={mainContext}
automatedPageContext={automatedPageContext}
/>
)
}
export const getServerSideProps: GetServerSideProps<Props> = async (context) => {
const { getAppsServerSideProps } = await import('src/github-apps/lib/index.js')
const { currentVersion, appsItems, categoriesWithoutSubcategories } =
await getAppsServerSideProps(context, 'server-to-server-rest', { useDisplayTitle: false })
return {
props: {
mainContext: await getMainContext(context.req, context.res),
currentVersion,
appsItems,
automatedPageContext: getAutomatedPageContextFromRequest(context.req),
categoriesWithoutSubcategories,
},
}
}

View File

@@ -0,0 +1,51 @@
import { GetServerSideProps } from 'next'
import {
AutomatedPageContextT,
getAutomatedPageContextFromRequest,
} from 'src/automated-pipelines/components/AutomatedPageContext'
import { MainContextT, getMainContext } from 'components/context/MainContext'
import { EnabledList, EnabledListT } from 'src/github-apps/components/EnabledList'
type Props = {
mainContext: MainContextT
currentVersion: string
appsItems: EnabledListT
automatedPageContext: AutomatedPageContextT
categoriesWithoutSubcategories: string[]
}
export default function UserGitHubAppEndpoints({
mainContext,
currentVersion,
appsItems,
automatedPageContext,
categoriesWithoutSubcategories,
}: Props) {
return (
<EnabledList
items={appsItems}
currentVersion={currentVersion}
categoriesWithoutSubcategories={categoriesWithoutSubcategories}
mainContext={mainContext}
automatedPageContext={automatedPageContext}
/>
)
}
export const getServerSideProps: GetServerSideProps<Props> = async (context) => {
const { getAppsServerSideProps } = await import('src/github-apps/lib/index.js')
const { currentVersion, appsItems, categoriesWithoutSubcategories } =
await getAppsServerSideProps(context, 'user-to-server-rest', { useDisplayTitle: false })
return {
props: {
mainContext: await getMainContext(context.req, context.res),
currentVersion,
appsItems,
automatedPageContext: getAutomatedPageContextFromRequest(context.req),
categoriesWithoutSubcategories,
},
}
}

View File

@@ -1,108 +0,0 @@
import { GetServerSideProps } from 'next'
import { Fragment } from 'react'
import { useRouter } from 'next/router'
import { AutomatedPage } from 'src/automated-pipelines/components/AutomatedPage'
import {
AutomatedPageContext,
AutomatedPageContextT,
getAutomatedPageContextFromRequest,
} from 'src/automated-pipelines/components/AutomatedPageContext'
import { MainContextT, MainContext, getMainContext } from 'components/context/MainContext'
import { Link } from 'components/Link'
import { RestRedirect } from 'src/rest/components/RestRedirect'
type OperationT = {
slug: string
subcategory: string
verb: string
requestPath: string
}
type EnabledAppCategoryT = {
[category: string]: OperationT[]
}
type Props = {
mainContext: MainContextT
currentVersion: string
enabledForApps: EnabledAppCategoryT
automatedPageContext: AutomatedPageContextT
categoriesWithoutSubcategories: string[]
}
export default function Category({
mainContext,
currentVersion,
enabledForApps,
automatedPageContext,
categoriesWithoutSubcategories,
}: Props) {
const { locale } = useRouter()
const version = currentVersion === 'free-pro-team@latest' ? '' : `/${currentVersion}`
const pathnamePrefix = `/${locale}${version}/rest/`
const content = Object.entries(enabledForApps)
.filter(([, operations]) => operations.length)
.map(([category, operations]) => (
<Fragment key={category}>
<h3 id={category}>
<Link href={`${pathnamePrefix}${category}`}>{category}</Link>
</h3>
<ul>
{operations.map((operation, index) => (
<li key={`${category}-${operation.slug}-${index}`}>
<Link
href={`${pathnamePrefix}${category}${
categoriesWithoutSubcategories.includes(category)
? ''
: '/' + operation.subcategory
}#${operation.slug}`}
>
<code>
<span className="text-uppercase">{operation.verb}</span> {operation.requestPath}
</code>
</Link>
</li>
))}
</ul>
</Fragment>
))
return (
<MainContext.Provider value={mainContext}>
<AutomatedPageContext.Provider value={automatedPageContext}>
<RestRedirect />
<AutomatedPage>{content}</AutomatedPage>
</AutomatedPageContext.Provider>
</MainContext.Provider>
)
}
export const getServerSideProps: GetServerSideProps<Props> = async (context) => {
const { categoriesWithoutSubcategories } = await import('src/rest/lib/index.js')
const { getEnabledForApps } = await import('src/github-apps/lib/index.js')
const req = context.req as any
const res = context.res as any
const currentVersion = context.query.versionId as string
const allVersions = req.context.allVersions
const queryApiVersion = context.query.apiVersion
const apiVersion = allVersions[currentVersion].apiVersions.includes(queryApiVersion)
? queryApiVersion
: allVersions[currentVersion].latestApiVersion
const automatedPageContext = getAutomatedPageContextFromRequest(req)
const enabledForApps = await getEnabledForApps(currentVersion, apiVersion)
return {
props: {
mainContext: await getMainContext(req, res),
currentVersion,
enabledForApps,
automatedPageContext,
categoriesWithoutSubcategories,
},
}
}

View File

@@ -0,0 +1,52 @@
import { GetServerSideProps } from 'next'
import {
AutomatedPageContextT,
getAutomatedPageContextFromRequest,
} from 'src/automated-pipelines/components/AutomatedPageContext'
import { MainContext, MainContextT, getMainContext } from 'components/context/MainContext'
import { PermissionsList, PermissionListT } from 'src/github-apps/components/PermissionsList'
type Props = {
mainContext: MainContextT
currentVersion: string
appsItems: PermissionListT
automatedPageContext: AutomatedPageContextT
categoriesWithoutSubcategories: string[]
}
export default function FineGrainedPatPermissions({
mainContext,
currentVersion,
appsItems,
automatedPageContext,
categoriesWithoutSubcategories,
}: Props) {
return (
<MainContext.Provider value={mainContext}>
<PermissionsList
items={appsItems}
currentVersion={currentVersion}
categoriesWithoutSubcategories={categoriesWithoutSubcategories}
mainContext={mainContext}
automatedPageContext={automatedPageContext}
/>
</MainContext.Provider>
)
}
export const getServerSideProps: GetServerSideProps<Props> = async (context) => {
const { getAppsServerSideProps } = await import('src/github-apps/lib/index.js')
const { currentVersion, appsItems, categoriesWithoutSubcategories } =
await getAppsServerSideProps(context, 'fine-grained-pat-permissions', { useDisplayTitle: true })
return {
props: {
mainContext: await getMainContext(context.req, context.res),
currentVersion,
appsItems,
automatedPageContext: getAutomatedPageContextFromRequest(context.req),
categoriesWithoutSubcategories,
},
}
}

View File

@@ -0,0 +1,52 @@
import { GetServerSideProps } from 'next'
import {
AutomatedPageContextT,
getAutomatedPageContextFromRequest,
} from 'src/automated-pipelines/components/AutomatedPageContext'
import { MainContext, MainContextT, getMainContext } from 'components/context/MainContext'
import { PermissionsList, PermissionListT } from 'src/github-apps/components/PermissionsList'
type Props = {
mainContext: MainContextT
currentVersion: string
appsItems: PermissionListT
automatedPageContext: AutomatedPageContextT
categoriesWithoutSubcategories: string[]
}
export default function GitHubAppPermissions({
mainContext,
currentVersion,
appsItems,
automatedPageContext,
categoriesWithoutSubcategories,
}: Props) {
return (
<MainContext.Provider value={mainContext}>
<PermissionsList
items={appsItems}
currentVersion={currentVersion}
categoriesWithoutSubcategories={categoriesWithoutSubcategories}
mainContext={mainContext}
automatedPageContext={automatedPageContext}
tokenTypes={true}
/>
</MainContext.Provider>
)
}
export const getServerSideProps: GetServerSideProps<Props> = async (context) => {
const { getAppsServerSideProps } = await import('src/github-apps/lib/index.js')
const { currentVersion, appsItems, categoriesWithoutSubcategories } =
await getAppsServerSideProps(context, 'server-to-server-permissions', { useDisplayTitle: true })
return {
props: {
mainContext: await getMainContext(context.req, context.res),
currentVersion,
appsItems,
automatedPageContext: getAutomatedPageContextFromRequest(context.req),
categoriesWithoutSubcategories,
},
}
}

View File

@@ -0,0 +1,28 @@
#!/usr/bin/env node
// This schema is used to validate
// src/github-apps/data/server-to-server-rest.json
// src/github-apps/data/user-to-server-rest.json
// and src/github-apps/data/fine-grained-pat.json
export default {
type: 'object',
required: ['slug', 'subcategory', 'verb', 'requestPath'],
properties: {
slug: {
description: 'The documentation slug for the REST API operation.',
type: 'string',
},
subcategory: {
description: 'The subcategory of the REST API operation.',
type: 'string',
},
verb: {
description: 'The API request verb.',
type: 'string',
},
requestPath: {
description: 'The API request path.',
type: 'string',
},
},
}

View File

@@ -0,0 +1,55 @@
#!/usr/bin/env node
// This schema is used to validate
// src/github-apps/data/fine-grained-pat-permissions.json
// and src/github-apps/data/server-to-server-permissions.json
const permissionObjects = {
type: 'object',
required: ['access', 'category', 'subcategory', 'slug', 'verb', 'requestPath'],
properties: {
access: {
type: 'string',
enum: ['read', 'write', 'admin'],
},
category: {
type: 'string',
},
subcategory: {
type: 'string',
},
slug: {
type: 'string',
},
verb: {
type: 'string',
enum: ['get', 'patch', 'post', 'put', 'delete'],
},
requestPath: {
type: 'string',
},
'additional-permissions': {
type: 'array',
},
},
}
export default {
type: 'object',
required: ['title', 'displayTitle', 'permissions'],
properties: {
// Properties from the source OpenAPI schema that this module depends on
title: {
description: 'The name of the permission.',
type: 'string',
},
displayTitle: {
description: 'The display title, which includes the resource group and permission name',
type: 'string',
},
permissions: {
description: 'An oject with keys for read and write, each with an array of objects.',
type: 'array',
items: permissionObjects,
},
},
}

View File

@@ -5,59 +5,121 @@ import { mkdirp } from 'mkdirp'
import { readFile, writeFile } from 'fs/promises'
import path from 'path'
import { slug } from 'github-slugger'
import yaml from 'js-yaml'
import { getOverrideCategory } from '../../rest/scripts/utils/operation.js'
import { ENABLED_APPS_DIR, ENABLED_APPS_FILENAME } from '../lib/index.js'
import { getContents } from '../../../script/helpers/git-utils.js'
import permissionSchema from './permission-list-schema.js'
import enabledSchema from './enabled-list-schema.js'
import { validateData } from '../../rest/scripts/utils/validate-data.js'
const ENABLED_APPS_DIR = 'src/github-apps/data'
const CONFIG_FILE = 'src/github-apps/lib/config.json'
export async function syncGitHubAppsData(openApiSource, sourceSchemas, progAccessSource = false) {
const { progAccessData, progActorResources } = await getProgAccessData(progAccessSource)
// Creates the src/github-apps/data files used for
// https://docs.github.com/en/rest/overview/endpoints-available-for-github-apps
export async function syncGitHubAppsData(sourceDirectory, sourceSchemas) {
for (const schemaName of sourceSchemas) {
const data = JSON.parse(await readFile(path.join(sourceDirectory, schemaName), 'utf8'))
const data = JSON.parse(await readFile(path.join(openApiSource, schemaName), 'utf8'))
const appsDataConfig = JSON.parse(await readFile(CONFIG_FILE, 'utf8'))
// Initialize the data structure with keys for each page type
const githubAppsData = {}
for (const pageType of Object.keys(appsDataConfig.pages)) {
githubAppsData[pageType] = {}
}
// Because the information used on the apps page doesn't require any
// rendered content we can parse the dereferenced files directly
const enabledForApps = {}
for (const [requestPath, operationsAtPath] of Object.entries(data.paths)) {
for (const [verb, operation] of Object.entries(operationsAtPath)) {
// We only want to process operations that are
// server-to-server GitHub App enabled
if (!operation['x-github'].enabledForGitHubApps) continue
// We only want to process operations that have programmatic access data
if (!progAccessData[operation.operationId]) continue
const schemaCategory = operation['x-github'].category
const schemaSubcategory = operation['x-github'].subcategory
const { category, subcategory } = getOverrideCategory(
operation.operationId,
schemaCategory,
schemaSubcategory
)
if (!enabledForApps[category]) {
enabledForApps[category] = []
}
enabledForApps[category].push({
const isInstallationAccessToken = progAccessData[operation.operationId].serverToServer
const isUserAccessToken = progAccessData[operation.operationId].userToServerRest
const isFineGrainedPat =
isUserAccessToken && !progAccessData[operation.operationId].disabledForPathv2
const { category, subcategory } = getCategory(operation)
const appDataOperation = {
slug: slug(operation.summary),
subcategory,
verb,
requestPath,
})
}
const appDataOperationWithCategory = Object.assign({ category }, appDataOperation)
// server-to-server
if (isInstallationAccessToken) {
initAppData(githubAppsData['server-to-server-rest'], category, appDataOperation)
}
// user-to-server
if (isUserAccessToken) {
initAppData(githubAppsData['user-to-server-rest'], category, appDataOperation)
}
// fine-grained pat
if (isFineGrainedPat) {
initAppData(githubAppsData['fine-grained-pat'], category, appDataOperation)
}
// permissions
for (const [permissionName, readOrWrite] of Object.entries(
progAccessData[operation.operationId].permissions
)) {
const tempTitle = permissionName.replace(/_/g, ' ')
const permissionNameExists = progActorResources[permissionName]
if (!permissionNameExists) {
console.warn(
`The permission ${permissionName} is missing from config/locales/programmatic_actor_fine_grained_resources.en.yml. Creating a placeholder value of ${tempTitle} until it's added.`
)
}
const title = progActorResources[permissionName]?.title || tempTitle
const resourceGroup = progActorResources[permissionName]?.resource_group || ''
const displayTitle = getDisplayTitle(title, resourceGroup)
const relatedPermissionNames = Object.keys(
progAccessData[operation.operationId].permissions
).filter((permission) => permission !== permissionName)
// github app permissions
const serverToServerPermissions = githubAppsData['server-to-server-permissions']
if (!serverToServerPermissions[permissionName]) {
serverToServerPermissions[permissionName] = {
title,
displayTitle,
permissions: [],
}
}
const worksWithData = {
'user-to-server': Boolean(isUserAccessToken),
'server-to-server': Boolean(isInstallationAccessToken),
'additional-permissions': relatedPermissionNames,
}
serverToServerPermissions[permissionName].permissions.push(
Object.assign({}, appDataOperationWithCategory, { access: readOrWrite }, worksWithData)
)
// fine-grained pats
if (isFineGrainedPat) {
const findGrainedPatPermissions = githubAppsData['fine-grained-pat-permissions']
if (!findGrainedPatPermissions[permissionName]) {
findGrainedPatPermissions[permissionName] = {
title,
displayTitle,
permissions: [],
}
}
findGrainedPatPermissions[permissionName].permissions.push(
Object.assign({}, appDataOperationWithCategory, {
'additional-permissions': relatedPermissionNames,
access: readOrWrite,
})
)
}
}
}
}
if (Object.keys(enabledForApps).length === 0) {
throw new Error(
`Generating GitHub Apps data failed for ${sourceDirectory}/${schemaName}. The generated data file was empty.`
)
}
// Sort the operations by category for readability
const sortedOperations = Object.keys(enabledForApps)
.sort()
.reduce((acc, key) => {
acc[key] = enabledForApps[key]
return acc
}, {})
const versionName = path.basename(schemaName, '.json')
const targetDirectory = path.join(ENABLED_APPS_DIR, versionName)
@@ -66,8 +128,140 @@ export async function syncGitHubAppsData(sourceDirectory, sourceSchemas) {
await mkdirp(targetDirectory)
}
const targetPath = path.join(targetDirectory, ENABLED_APPS_FILENAME)
await writeFile(targetPath, JSON.stringify(sortedOperations, null, 2))
console.log(`✅ Wrote ${targetPath}`)
for (const pageType of Object.keys(githubAppsData)) {
const data = githubAppsData[pageType]
await validateAppData(data, pageType)
const filename = `${pageType}.json`
if (Object.keys(data).length === 0) {
throw new Error(
`Generating GitHub Apps data failed for ${openApiSource}/${schemaName}. The generated data file was empty.`
)
}
const sortedOperations = pageType.includes('permissions')
? sortObjectByTitle(data)
: sortObjectByKeys(data)
const targetPath = path.join(targetDirectory, filename)
await writeFile(targetPath, JSON.stringify(sortedOperations, null, 2))
console.log(`✅ Wrote ${targetPath}`)
}
}
}
// When progAccessSource is defined, it will contain the root directory
// of the repo with the programmatic access file. If it is not defined,
// the file will be retrieved from the remote repo via the REST API.
async function getProgAccessData(progAccessSource) {
let progAccessDataRaw
// config/locales/programmatic_actor_fine_grained_resources.en.yml
let progActorResources
const progAccessFilepath = 'config/access_control/programmatic_access.yaml'
const progActorFilepath = 'config/locales/programmatic_actor_fine_grained_resources.en.yml'
if (progAccessSource) {
progAccessDataRaw = yaml.load(
await readFile(path.join(progAccessSource, progAccessFilepath), 'utf8')
)
progActorResources = yaml.load(
await readFile(path.join(progAccessSource, progActorFilepath), 'utf8')
).en.programmatic_actor_fine_grained_resources
} else {
progAccessDataRaw = yaml.load(
await getContents('github', 'github', 'master', progAccessFilepath)
)
progActorResources = yaml.load(
await getContents('github', 'github', 'master', progActorFilepath)
).en.programmatic_actor_fine_grained_resources
}
const progAccessData = {}
for (const operation of progAccessDataRaw) {
const permissions = {}
if (operation.permission_sets) {
operation.permission_sets.forEach((permissionSet) => {
Object.assign(permissions, permissionSet)
})
}
const userToServerRest = operation.user_to_server.enabled
const serverToServer = operation.server_to_server.enabled
const allowPermissionlessAccess = operation.allows_permissionless_access
const disabledForPathv2 = operation.disabled_for_pathv2
progAccessData[operation.operation_ids] = {
userToServerRest,
serverToServer,
permissions,
allowPermissionlessAccess,
disabledForPathv2,
}
}
return { progAccessData, progActorResources }
}
function sortObjectByKeys(obj) {
return Object.keys(obj)
.sort()
.reduce((acc, key) => {
acc[key] = obj[key]
return acc
}, {})
}
function sortObjectByTitle(obj) {
return Object.keys(obj)
.sort((a, b) => {
if (obj[a].displayTitle > obj[b].displayTitle) {
return 1
}
if (obj[a].displayTitle < obj[b].displayTitle) {
return -1
}
return 0
})
.reduce((acc, key) => {
acc[key] = obj[key]
return acc
}, {})
}
function getCategory(operation) {
const schemaCategory = operation['x-github'].category
const schemaSubcategory = operation['x-github'].subcategory
return getOverrideCategory(operation.operationId, schemaCategory, schemaSubcategory)
}
function getDisplayTitle(title, resourceGroup) {
if (!title) {
console.warn(`No title found for title ${title} resource group ${resourceGroup}`)
return ''
}
return !resourceGroup
? sentenceCase(title) + ' permissions'
: sentenceCase(resourceGroup) + ' permissions for ' + `"${title}"`
}
function sentenceCase(str) {
return str.charAt(0).toUpperCase() + str.slice(1)
}
function initAppData(storage, category, data) {
if (!storage[category]) {
storage[category] = []
}
storage[category].push(data)
}
async function validateAppData(data, pageType) {
if (pageType.includes('permissions')) {
for (const value of Object.values(data)) {
validateData(value, permissionSchema)
}
} else {
for (const arrayItems of Object.values(data)) {
for (const item of arrayItems) {
validateData(item, enabledSchema)
}
}
}
}

View File

@@ -1,42 +1,48 @@
import { jest, test } from '@jest/globals'
import { readFile } from 'fs/promises'
import { allVersions } from '../../../lib/all-versions.js'
import { get, getDOM } from '../../../tests/helpers/e2etest.js'
import { categoriesWithoutSubcategories } from '../../rest/lib/index.js'
import { getEnabledForApps } from '../lib/index.js'
import { isApiVersioned, allVersions } from '../../../lib/all-versions.js'
import { categoriesWithoutSubcategories } from '#src/rest/lib/index.js'
import { getAppsData } from '#src/github-apps/lib/index.js'
const configContent = JSON.parse(await readFile('src/github-apps/lib/config.json', 'utf8'))
const pageTypes = Object.keys(configContent.pages)
const permissionPages = pageTypes.filter((pageType) => pageType.includes('permissions'))
const enabledPages = pageTypes.filter((pageType) => !pageType.includes('permissions'))
const defaultVersion = Object.values(allVersions)
.filter((version) => version.nonEnterpriseDefault)
.shift()
const version = defaultVersion.version
const apiVersion = defaultVersion.latestApiVersion
describe('REST references docs', () => {
jest.setTimeout(3 * 60 * 1000)
// This test ensures that the page component and the Markdown file are
// in sync. It also checks that all expected items are present.
// For every version of /rest/overview/endpoints-available-for-github-apps
test('loads operations enabled for GitHub Apps', async () => {
const flatMapping = getFlatMappingWithCalendarDates()
for (const [version, versionValue] of Object.entries(flatMapping)) {
test('loads enabled list pages', async () => {
for (const page of enabledPages) {
const schemaSlugs = []
const enabledForApps = await getEnabledForApps(version, versionValue.apiVersion)
const enabledForApps = await getAppsData(page, version, apiVersion)
// using the static file, generate the expected slug for each operation
for (const [key, value] of Object.entries(enabledForApps)) {
schemaSlugs.push(
...value.map(
(item) =>
`/en${
versionValue.url === '' ? versionValue.url : `/${versionValue.url}`
}/rest/${key}${
`/en/rest/${key}${
categoriesWithoutSubcategories.includes(key) ? '' : '/' + item.subcategory
}#${item.slug}`
)
)
}
// get all of the href attributes in the anchor tags
const $ = await getDOM(
`/en/${versionValue.url}/rest/overview/endpoints-available-for-github-apps${
versionValue.apiVersion ? `?apiVersion=${versionValue.apiVersion}` : ''
}`
)
const contentPath = configContent.pages[page].targetFilename
.replace('content/', '')
.replace('.md', '')
const $ = await getDOM(`/en/${contentPath}${apiVersion ? `?apiVersion=${apiVersion}` : ''}`)
const domH3Ids = $('#article-contents a')
.map((i, a) => $(a).attr('href'))
.get()
@@ -44,40 +50,46 @@ describe('REST references docs', () => {
}
})
test('falls back when unsupported calendar version provided', async () => {
const res = await get(
`/en/rest/overview/endpoints-available-for-github-apps?${new URLSearchParams({
apiVersion: 'junk',
})}`
)
expect(res.statusCode).toBe(200)
})
})
test('loads permission list pages', async () => {
// permissions pages
for (const page of permissionPages) {
const schemaSlugs = []
// This gets a flat mapping for all REST versions (versioned and unversioned) and creates a mapping between
// the full name of the version including calendar dates to its url name and apiVersion if it exists.
// Example:
// {
// free-pro-team@latest: { url: '', apiVersion: 2022-08-09 }
// free-pro-team@latest: { url: '', apiVersion: 2022-11-14 }
// enterprise-cloud@latest: { url: 'enterprise-cloud@latest, apiVersion: 2022-11-14 }
// enterprise-server@3.6: { url: enterprise-server@3.6 }
// }
function getFlatMappingWithCalendarDates() {
const flatMapping = {}
const permissionsData = await getAppsData(page, version, apiVersion)
for (const version in allVersions) {
if (isApiVersioned(version)) {
for (const apiVersion of allVersions[version].apiVersions) {
flatMapping[allVersions[version].version] = {
url: `${version === 'free-pro-team@latest' ? '' : allVersions[version].version}`,
apiVersion,
}
// using the static file, generate the expected slug for each operation
for (const value of Object.values(permissionsData)) {
schemaSlugs.push(
...value.permissions.map(
(item) =>
`/en/rest/${item.category}${
categoriesWithoutSubcategories.includes(item.category) ? '' : '/' + item.subcategory
}#${item.slug}`
)
)
}
} else {
flatMapping[allVersions[version].version] = { url: allVersions[version].version }
}
}
return flatMapping
}
// get all of the href attributes in the anchor tags
const contentPath = configContent.pages[page].targetFilename
.replace('content/', '')
.replace('.md', '')
const $ = await getDOM(`/en/${contentPath}${apiVersion ? `?apiVersion=${apiVersion}` : ''}`)
const domH3Ids = $('#article-contents table tbody tr td a')
.map((i, a) => $(a).attr('href'))
.get()
expect(schemaSlugs.every((slug) => domH3Ids.includes(slug))).toBe(true)
}
})
for (const page of pageTypes) {
const contentPath = configContent.pages[page].targetFilename
.replace('content/', '')
.replace('.md', '')
const url = `/${contentPath}?${new URLSearchParams({ apiVersion: 'junk' })}`
test(`falls back when unsupported calendar version provided for ${contentPath}`, async () => {
const res = await get(url, { followRedirects: true })
expect(res.statusCode).toBe(200)
})
}
})