From 8d3eb29ba0e205d3702c0a6c3045cf849d59df82 Mon Sep 17 00:00:00 2001 From: Rachael Sewell Date: Tue, 14 Feb 2023 12:21:44 -0800 Subject: [PATCH] autogenerate frontmatter (#34744) --- .../webhooks/webhook-events-and-payloads.md | 2 ++ content/graphql/overview/breaking-changes.md | 4 ++++ content/graphql/overview/changelog.md | 4 ++++ content/graphql/overview/schema-previews.md | 4 ++++ content/graphql/reference/enums.md | 2 ++ content/graphql/reference/index.md | 4 ++++ content/graphql/reference/input-objects.md | 2 ++ content/graphql/reference/interfaces.md | 2 ++ content/graphql/reference/mutations.md | 2 ++ content/graphql/reference/objects.md | 2 ++ content/graphql/reference/queries.md | 2 ++ content/graphql/reference/scalars.md | 2 ++ content/graphql/reference/unions.md | 2 ++ content/rest/actions/artifacts.md | 4 ++++ content/rest/actions/cache.md | 4 ++++ content/rest/actions/index.md | 5 +++++ content/rest/actions/oidc.md | 4 ++++ content/rest/actions/permissions.md | 4 ++++ content/rest/actions/required-workflows.md | 4 ++++ content/rest/actions/secrets.md | 4 ++++ content/rest/actions/self-hosted-runner-groups.md | 4 ++++ content/rest/actions/self-hosted-runners.md | 6 +++++- content/rest/actions/variables.md | 4 ++++ content/rest/actions/workflow-jobs.md | 4 ++++ content/rest/actions/workflow-runs.md | 4 ++++ content/rest/actions/workflows.md | 4 ++++ content/rest/activity/events.md | 4 ++++ content/rest/activity/feeds.md | 4 ++++ content/rest/activity/index.md | 4 ++++ content/rest/activity/notifications.md | 4 ++++ content/rest/activity/starring.md | 4 ++++ content/rest/activity/watching.md | 4 ++++ content/rest/announcement-banners/enterprises.md | 4 ++++ content/rest/announcement-banners/index.md | 4 ++++ content/rest/announcement-banners/organizations.md | 4 ++++ content/rest/apps/apps.md | 4 ++++ content/rest/apps/index.md | 4 ++++ content/rest/apps/installations.md | 4 ++++ content/rest/apps/marketplace.md | 4 ++++ content/rest/apps/oauth-applications.md | 4 ++++ content/rest/apps/webhooks.md | 4 ++++ content/rest/billing.md | 4 ++++ content/rest/branches/branch-protection.md | 4 ++++ content/rest/branches/branches.md | 4 ++++ content/rest/branches/index.md | 4 ++++ content/rest/checks/index.md | 4 ++++ content/rest/checks/runs.md | 4 ++++ content/rest/checks/suites.md | 4 ++++ content/rest/code-scanning.md | 4 ++++ content/rest/codes-of-conduct.md | 4 ++++ content/rest/codespaces/codespaces.md | 4 ++++ content/rest/codespaces/index.md | 4 ++++ content/rest/codespaces/machines.md | 4 ++++ content/rest/codespaces/organization-secrets.md | 4 ++++ content/rest/codespaces/organizations.md | 4 ++++ content/rest/codespaces/repository-secrets.md | 4 ++++ content/rest/codespaces/secrets.md | 4 ++++ content/rest/collaborators/collaborators.md | 4 ++++ content/rest/collaborators/index.md | 4 ++++ content/rest/collaborators/invitations.md | 4 ++++ content/rest/commits/comments.md | 4 ++++ content/rest/commits/commits.md | 4 ++++ content/rest/commits/index.md | 4 ++++ content/rest/commits/statuses.md | 4 ++++ content/rest/dependabot/alerts.md | 4 ++++ content/rest/dependabot/index.md | 4 ++++ content/rest/dependabot/secrets.md | 4 ++++ content/rest/dependency-graph/dependency-review.md | 4 ++++ content/rest/dependency-graph/dependency-submission.md | 4 ++++ content/rest/dependency-graph/index.md | 4 ++++ content/rest/deploy-keys.md | 4 ++++ content/rest/deployments/branch-policies.md | 4 ++++ content/rest/deployments/deployments.md | 4 ++++ content/rest/deployments/environments.md | 4 ++++ content/rest/deployments/index.md | 4 ++++ content/rest/deployments/statuses.md | 4 ++++ content/rest/emojis.md | 4 ++++ content/rest/enterprise-admin/admin-stats.md | 4 ++++ content/rest/enterprise-admin/announcement.md | 4 ++++ content/rest/enterprise-admin/audit-log.md | 4 ++++ content/rest/enterprise-admin/billing.md | 4 ++++ content/rest/enterprise-admin/code-security-and-analysis.md | 4 ++++ content/rest/enterprise-admin/global-webhooks.md | 4 ++++ content/rest/enterprise-admin/index.md | 4 ++++ content/rest/enterprise-admin/ldap.md | 4 ++++ content/rest/enterprise-admin/license.md | 4 ++++ content/rest/enterprise-admin/management-console.md | 4 ++++ content/rest/enterprise-admin/org-pre-receive-hooks.md | 4 ++++ content/rest/enterprise-admin/orgs.md | 4 ++++ content/rest/enterprise-admin/pre-receive-environments.md | 4 ++++ content/rest/enterprise-admin/pre-receive-hooks.md | 4 ++++ content/rest/enterprise-admin/repo-pre-receive-hooks.md | 4 ++++ content/rest/enterprise-admin/scim.md | 4 ++++ content/rest/enterprise-admin/users.md | 4 ++++ content/rest/gists/comments.md | 4 ++++ content/rest/gists/gists.md | 4 ++++ content/rest/gists/index.md | 4 ++++ content/rest/git/blobs.md | 4 ++++ content/rest/git/commits.md | 4 ++++ content/rest/git/index.md | 4 ++++ content/rest/git/refs.md | 4 ++++ content/rest/git/tags.md | 4 ++++ content/rest/git/trees.md | 4 ++++ content/rest/gitignore.md | 4 ++++ content/rest/index.md | 4 ++++ content/rest/interactions/index.md | 4 ++++ content/rest/interactions/orgs.md | 4 ++++ content/rest/interactions/repos.md | 4 ++++ content/rest/interactions/user.md | 4 ++++ content/rest/issues/assignees.md | 4 ++++ content/rest/issues/comments.md | 4 ++++ content/rest/issues/events.md | 4 ++++ content/rest/issues/index.md | 4 ++++ content/rest/issues/issues.md | 4 ++++ content/rest/issues/labels.md | 4 ++++ content/rest/issues/milestones.md | 4 ++++ content/rest/issues/timeline.md | 4 ++++ content/rest/licenses.md | 4 ++++ content/rest/markdown.md | 4 ++++ content/rest/meta.md | 4 ++++ content/rest/metrics/community.md | 4 ++++ content/rest/metrics/index.md | 4 ++++ content/rest/metrics/statistics.md | 4 ++++ content/rest/metrics/traffic.md | 4 ++++ content/rest/migrations/index.md | 4 ++++ content/rest/migrations/orgs.md | 4 ++++ content/rest/migrations/source-imports.md | 4 ++++ content/rest/migrations/users.md | 4 ++++ content/rest/oauth-authorizations.md | 4 ++++ content/rest/orgs/blocking.md | 4 ++++ content/rest/orgs/custom-roles.md | 4 ++++ content/rest/orgs/index.md | 4 ++++ content/rest/orgs/members.md | 4 ++++ content/rest/orgs/orgs.md | 4 ++++ content/rest/orgs/outside-collaborators.md | 4 ++++ content/rest/orgs/security-managers.md | 4 ++++ content/rest/orgs/webhooks.md | 4 ++++ .../rest/overview/endpoints-available-for-github-apps.md | 3 +++ content/rest/packages.md | 4 ++++ content/rest/pages.md | 4 ++++ content/rest/projects/cards.md | 4 ++++ content/rest/projects/collaborators.md | 4 ++++ content/rest/projects/columns.md | 4 ++++ content/rest/projects/index.md | 4 ++++ content/rest/projects/projects.md | 4 ++++ content/rest/pulls/comments.md | 4 ++++ content/rest/pulls/index.md | 4 ++++ content/rest/pulls/pulls.md | 4 ++++ content/rest/pulls/review-requests.md | 4 ++++ content/rest/pulls/reviews.md | 4 ++++ content/rest/rate-limit.md | 4 ++++ content/rest/reactions.md | 4 ++++ content/rest/releases/assets.md | 4 ++++ content/rest/releases/index.md | 4 ++++ content/rest/releases/releases.md | 4 ++++ content/rest/repos/autolinks.md | 4 ++++ content/rest/repos/contents.md | 4 ++++ content/rest/repos/forks.md | 4 ++++ content/rest/repos/index.md | 4 ++++ content/rest/repos/lfs.md | 4 ++++ content/rest/repos/repos.md | 4 ++++ content/rest/repos/tags.md | 4 ++++ content/rest/scim.md | 4 ++++ content/rest/search.md | 4 ++++ content/rest/secret-scanning.md | 4 ++++ content/rest/teams/discussion-comments.md | 4 ++++ content/rest/teams/discussions.md | 4 ++++ content/rest/teams/external-groups.md | 4 ++++ content/rest/teams/index.md | 4 ++++ content/rest/teams/members.md | 4 ++++ content/rest/teams/team-sync.md | 4 ++++ content/rest/teams/teams.md | 4 ++++ content/rest/users/blocking.md | 4 ++++ content/rest/users/emails.md | 4 ++++ content/rest/users/followers.md | 4 ++++ content/rest/users/gpg-keys.md | 4 ++++ content/rest/users/index.md | 4 ++++ content/rest/users/keys.md | 4 ++++ content/rest/users/ssh-signing-keys.md | 4 ++++ content/rest/users/users.md | 4 ++++ content/rest/webhooks/index.md | 4 ++++ content/rest/webhooks/repo-config.md | 4 ++++ content/rest/webhooks/repo-deliveries.md | 4 ++++ content/rest/webhooks/repos.md | 4 ++++ lib/frontmatter.js | 3 +++ 185 files changed, 722 insertions(+), 1 deletion(-) diff --git a/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index a18077da9b..905002a843 100644 --- a/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -15,6 +15,7 @@ versions: topics: - Webhooks shortTitle: Webhook events & payloads +autogenerated: true --- {% data reusables.webhooks.webhooks_intro %} @@ -97,4 +98,5 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`. > } ``` + diff --git a/content/graphql/overview/breaking-changes.md b/content/graphql/overview/breaking-changes.md index 110f17ece2..a669c1a704 100644 --- a/content/graphql/overview/breaking-changes.md +++ b/content/graphql/overview/breaking-changes.md @@ -10,6 +10,7 @@ versions: ghae: '*' topics: - API +autogenerated: true --- ## About breaking changes @@ -22,3 +23,6 @@ Breaking changes are any changes that might require action from our integrators. We strive to provide stable APIs for our integrators. When a new feature is still evolving, we release it behind a [schema preview](/graphql/overview/schema-previews). We'll announce upcoming breaking changes at least three months before making changes to the GraphQL schema, to give integrators time to make the necessary adjustments. Changes go into effect on the first day of a quarter (January 1st, April 1st, July 1st, or October 1st). For example, if we announce a change on January 15th, it will be made on July 1st. + + + \ No newline at end of file diff --git a/content/graphql/overview/changelog.md b/content/graphql/overview/changelog.md index e2dfdef917..06eba7b59e 100644 --- a/content/graphql/overview/changelog.md +++ b/content/graphql/overview/changelog.md @@ -10,6 +10,10 @@ versions: ghae: '*' topics: - API +autogenerated: true --- Breaking changes include changes that will break existing queries or could affect the runtime behavior of clients. For a list of breaking changes and when they will occur, see our [breaking changes log](/graphql/overview/breaking-changes). + + + \ No newline at end of file diff --git a/content/graphql/overview/schema-previews.md b/content/graphql/overview/schema-previews.md index 5c337e2ba0..6051351ce6 100644 --- a/content/graphql/overview/schema-previews.md +++ b/content/graphql/overview/schema-previews.md @@ -10,6 +10,7 @@ versions: ghae: '*' topics: - API +autogenerated: true --- ## About schema previews @@ -23,3 +24,6 @@ To access a schema preview, you'll need to provide a custom [media type](/rest/o **Note:** The GraphQL schema members under preview cannot be accessed via the Explorer at this time. {% endnote %} + + + \ No newline at end of file diff --git a/content/graphql/reference/enums.md b/content/graphql/reference/enums.md index 5b9fa40b56..48f0e856c7 100644 --- a/content/graphql/reference/enums.md +++ b/content/graphql/reference/enums.md @@ -11,6 +11,7 @@ versions: ghae: '*' topics: - API +autogenerated: true --- ## About enums @@ -23,4 +24,5 @@ For more information, see "[Introduction to GraphQL](/graphql/guides/introductio {% data reusables.projects.graphql-ghes %} + diff --git a/content/graphql/reference/index.md b/content/graphql/reference/index.md index d6ddcc993a..09fbe40403 100644 --- a/content/graphql/reference/index.md +++ b/content/graphql/reference/index.md @@ -17,5 +17,9 @@ children: - /unions - /input-objects - /scalars +autogenerated: true --- + + + \ No newline at end of file diff --git a/content/graphql/reference/input-objects.md b/content/graphql/reference/input-objects.md index eb4777a413..7665d28493 100644 --- a/content/graphql/reference/input-objects.md +++ b/content/graphql/reference/input-objects.md @@ -11,6 +11,7 @@ versions: ghae: '*' topics: - API +autogenerated: true --- ## About input objects @@ -23,4 +24,5 @@ For more information, see "[About mutations](/graphql/guides/forming-calls-with- {% data reusables.projects.graphql-ghes %} + diff --git a/content/graphql/reference/interfaces.md b/content/graphql/reference/interfaces.md index b30b03ca98..d1269ef7a4 100644 --- a/content/graphql/reference/interfaces.md +++ b/content/graphql/reference/interfaces.md @@ -11,6 +11,7 @@ versions: ghae: '*' topics: - API +autogenerated: true --- ## About interfaces @@ -23,4 +24,5 @@ For more information, see "[Implementation](/graphql/guides/introduction-to-grap {% data reusables.projects.graphql-ghes %} + diff --git a/content/graphql/reference/mutations.md b/content/graphql/reference/mutations.md index 9b33942959..8ea209e1d6 100644 --- a/content/graphql/reference/mutations.md +++ b/content/graphql/reference/mutations.md @@ -11,6 +11,7 @@ versions: ghae: '*' topics: - API +autogenerated: true --- ## About mutations @@ -21,4 +22,5 @@ For more information, see "[About mutations](/graphql/guides/forming-calls-with- {% data reusables.projects.graphql-ghes %} + diff --git a/content/graphql/reference/objects.md b/content/graphql/reference/objects.md index a5adf544d6..d44f19691f 100644 --- a/content/graphql/reference/objects.md +++ b/content/graphql/reference/objects.md @@ -11,6 +11,7 @@ versions: ghae: '*' topics: - API +autogenerated: true --- ## About objects @@ -23,4 +24,5 @@ For more information, see "[Introduction to GraphQL](/graphql/guides/introductio {% data reusables.projects.graphql-ghes %} + diff --git a/content/graphql/reference/queries.md b/content/graphql/reference/queries.md index 17c452f873..e1c7ca7ae7 100644 --- a/content/graphql/reference/queries.md +++ b/content/graphql/reference/queries.md @@ -12,6 +12,7 @@ versions: ghae: '*' topics: - API +autogenerated: true --- ## About queries @@ -26,4 +27,5 @@ For more information, see "[About queries](/graphql/guides/forming-calls-with-gr {% endnote %} + diff --git a/content/graphql/reference/scalars.md b/content/graphql/reference/scalars.md index 3e26c60b55..5d9e535246 100644 --- a/content/graphql/reference/scalars.md +++ b/content/graphql/reference/scalars.md @@ -11,6 +11,7 @@ versions: ghae: '*' topics: - API +autogenerated: true --- ## About scalars @@ -21,4 +22,5 @@ When calling the GraphQL API, you must specify nested subfields until you return For more information, see "[Introduction to GraphQL](/graphql/guides/introduction-to-graphql#field)." + diff --git a/content/graphql/reference/unions.md b/content/graphql/reference/unions.md index b9bd13ef09..365930ba70 100644 --- a/content/graphql/reference/unions.md +++ b/content/graphql/reference/unions.md @@ -11,6 +11,7 @@ versions: ghae: '*' topics: - API +autogenerated: true --- ## About unions @@ -23,4 +24,5 @@ For more information, see "[Introduction to GraphQL](/graphql/guides/introductio {% data reusables.projects.graphql-ghes %} + diff --git a/content/rest/actions/artifacts.md b/content/rest/actions/artifacts.md index 795b64fa94..47dadd2620 100644 --- a/content/rest/actions/artifacts.md +++ b/content/rest/actions/artifacts.md @@ -10,6 +10,7 @@ versions: ghes: '*' ghae: '*' ghec: '*' +autogenerated: true --- ## About artifacts in {% data variables.product.prodname_actions %} @@ -17,3 +18,6 @@ versions: You can use the REST API to download, delete, and retrieve information about workflow artifacts in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-artifacts %} For more information, see "[Storing workflow data as artifacts](/actions/using-workflows/storing-workflow-data-as-artifacts)." {% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} + + + diff --git a/content/rest/actions/cache.md b/content/rest/actions/cache.md index ced57df852..c568306d04 100644 --- a/content/rest/actions/cache.md +++ b/content/rest/actions/cache.md @@ -9,8 +9,12 @@ versions: fpt: '*' ghec: '*' ghes: '>3.4' +autogenerated: true --- ## About the cache in {% data variables.product.prodname_actions %} You can use the REST API to query and manage the cache for repositories in {% data variables.product.prodname_actions %}. {% ifversion actions-cache-management %}You can also install a {% data variables.product.prodname_cli %} extension to manage your caches from the command line. {% endif %}For more information, see "[Caching dependencies to speed up workflows](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows#managing-caches)." + + + diff --git a/content/rest/actions/index.md b/content/rest/actions/index.md index 1fe2c4d495..03944b619d 100644 --- a/content/rest/actions/index.md +++ b/content/rest/actions/index.md @@ -25,5 +25,10 @@ children: - /workflow-jobs - /workflow-runs - /workflows +autogenerated: true --- + You can use the REST API to manage and control {% data variables.product.prodname_actions %} for an organization or repository. {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} require the permissions mentioned in each endpoint. For more information, see "[{% data variables.product.prodname_actions %} Documentation](/actions)." + + + diff --git a/content/rest/actions/oidc.md b/content/rest/actions/oidc.md index 1d1e84ab35..327105cc09 100644 --- a/content/rest/actions/oidc.md +++ b/content/rest/actions/oidc.md @@ -9,5 +9,9 @@ versions: fpt: '*' ghec: '*' ghes: '>=3.7' +autogenerated: true --- + + + diff --git a/content/rest/actions/permissions.md b/content/rest/actions/permissions.md index 1ed8011423..7bb77d93e9 100644 --- a/content/rest/actions/permissions.md +++ b/content/rest/actions/permissions.md @@ -10,8 +10,12 @@ versions: ghes: '*' ghae: '*' ghec: '*' +autogenerated: true --- ## About permissions for {% data variables.product.prodname_actions %} You can use the REST API to set permissions for the {% ifversion ghes or ghec or ghae %}enterprises, {% endif %}organizations and repositories that are allowed to run {% data variables.product.prodname_actions %}, and the actions{% ifversion actions-workflow-policy %} and reusable workflows{% endif %} that are allowed to run.{% ifversion fpt or ghec or ghes %} For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."{% endif %} + + + diff --git a/content/rest/actions/required-workflows.md b/content/rest/actions/required-workflows.md index 22eb573aa1..df03e91e1d 100644 --- a/content/rest/actions/required-workflows.md +++ b/content/rest/actions/required-workflows.md @@ -9,5 +9,9 @@ versions: fpt: '*' ghec: '*' ghes: '>=3.8' +autogenerated: true --- + + + diff --git a/content/rest/actions/secrets.md b/content/rest/actions/secrets.md index 53e4882bc4..bf059be99c 100644 --- a/content/rest/actions/secrets.md +++ b/content/rest/actions/secrets.md @@ -10,6 +10,7 @@ versions: ghes: '*' ghae: '*' ghec: '*' +autogenerated: true --- ## About secrets in {% data variables.product.prodname_actions %} @@ -17,3 +18,6 @@ versions: You can use the REST API to create, update, delete, and retrieve information about encrypted secrets that can be used in workflows in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-secrets %} For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)." {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `secrets` permission to use these endpoints. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + + diff --git a/content/rest/actions/self-hosted-runner-groups.md b/content/rest/actions/self-hosted-runner-groups.md index 991da3aae7..f903f507a4 100644 --- a/content/rest/actions/self-hosted-runner-groups.md +++ b/content/rest/actions/self-hosted-runner-groups.md @@ -7,6 +7,7 @@ versions: ghes: '*' ghae: '*' ghec: '*' +autogenerated: true --- ## About self-hosted runner groups in {% data variables.product.prodname_actions %} @@ -14,3 +15,6 @@ versions: You can use the REST API to manage groups of self-hosted runners in {% data variables.product.prodname_actions %}. For more information, see "[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups)." {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use these endpoints. + + + diff --git a/content/rest/actions/self-hosted-runners.md b/content/rest/actions/self-hosted-runners.md index 8a9e027ee7..7bd084869b 100644 --- a/content/rest/actions/self-hosted-runners.md +++ b/content/rest/actions/self-hosted-runners.md @@ -8,10 +8,14 @@ versions: ghes: '*' ghae: '*' ghec: '*' +autogenerated: true --- - + ## About self-hosted runners in {% data variables.product.prodname_actions %} You can use the REST API to register, view, and delete self-hosted runners in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-self-hosted-runners %} For more information, see "[Hosting your own runners](/actions/hosting-your-own-runners)." {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises to use these endpoints. + + + diff --git a/content/rest/actions/variables.md b/content/rest/actions/variables.md index 5e1ba44ac1..2e5e13989e 100644 --- a/content/rest/actions/variables.md +++ b/content/rest/actions/variables.md @@ -9,6 +9,7 @@ versions: fpt: '*' ghes: '>=3.8' ghec: '*' +autogenerated: true --- ## About variables in {% data variables.product.prodname_actions %} @@ -16,3 +17,6 @@ versions: You can use the REST API to create, update, delete, and retrieve information about variables that can be used in workflows in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-variables %} {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `actions_variables/environments/organization_actions_variables` permission to use these endpoints. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + + diff --git a/content/rest/actions/workflow-jobs.md b/content/rest/actions/workflow-jobs.md index eb23e78b82..aaf03ce8b1 100644 --- a/content/rest/actions/workflow-jobs.md +++ b/content/rest/actions/workflow-jobs.md @@ -8,6 +8,7 @@ versions: ghes: '*' ghae: '*' ghec: '*' +autogenerated: true --- ## About workflow jobs in {% data variables.product.prodname_actions %} @@ -15,3 +16,6 @@ versions: You can use the REST API to view logs and workflow jobs in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflow-jobs %} For more information, see "[Workflow syntax for GitHub Actions](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions)". {% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} + + + diff --git a/content/rest/actions/workflow-runs.md b/content/rest/actions/workflow-runs.md index e55ea684d1..6d07ed3df4 100644 --- a/content/rest/actions/workflow-runs.md +++ b/content/rest/actions/workflow-runs.md @@ -8,6 +8,7 @@ versions: ghes: '*' ghae: '*' ghec: '*' +autogenerated: true --- ## About workflow runs in {% data variables.product.prodname_actions %} @@ -15,3 +16,6 @@ versions: You can use the REST API to view, re-run, cancel, and view logs for workflow runs in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflow-runs %} For more information, see "[Managing a workflow run](/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run)." {% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} + + + diff --git a/content/rest/actions/workflows.md b/content/rest/actions/workflows.md index 14577e8fd5..69dce77d6c 100644 --- a/content/rest/actions/workflows.md +++ b/content/rest/actions/workflows.md @@ -8,6 +8,7 @@ versions: ghes: '*' ghae: '*' ghec: '*' +autogenerated: true --- ## About workflows in {% data variables.product.prodname_actions %} @@ -15,3 +16,6 @@ versions: You can use the REST API to view workflows for a repository in {% data variables.product.prodname_actions %}. {% data reusables.actions.about-workflows %} For more information, see "[Automating your workflow with GitHub Actions](/actions/automating-your-workflow-with-github-actions)." {% data reusables.actions.actions-authentication %} {% data reusables.actions.actions-app-actions-permissions-api %} + + + diff --git a/content/rest/activity/events.md b/content/rest/activity/events.md index 531010068e..875a4204be 100644 --- a/content/rest/activity/events.md +++ b/content/rest/activity/events.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About {% data variables.product.prodname_dotcom %} events @@ -33,3 +34,6 @@ $ -H 'If-None-Match: "a18c3bded88eb5dbb5c849a489412bf3"' ``` Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300). + + + diff --git a/content/rest/activity/feeds.md b/content/rest/activity/feeds.md index 12b4063e1d..6b955c44ab 100644 --- a/content/rest/activity/feeds.md +++ b/content/rest/activity/feeds.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About {% data variables.product.prodname_dotcom %} feeds @@ -78,3 +79,6 @@ xml:lang="en-US"> ``` + + + diff --git a/content/rest/activity/index.md b/content/rest/activity/index.md index 50a250c67b..d76a2939ab 100644 --- a/content/rest/activity/index.md +++ b/content/rest/activity/index.md @@ -18,5 +18,9 @@ children: - /notifications - /starring - /watching +autogenerated: true --- + + + diff --git a/content/rest/activity/notifications.md b/content/rest/activity/notifications.md index 26bbfd4363..671bacbfdb 100644 --- a/content/rest/activity/notifications.md +++ b/content/rest/activity/notifications.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About {% data variables.product.product_name %} notifications @@ -61,3 +62,6 @@ Reason Name | Description Note that the `reason` is modified on a per-thread basis, and can change, if the `reason` on a later notification is different. For example, if you are the author of an issue, subsequent notifications on that issue will have a `reason` of `author`. If you're then **@mentioned** on the same issue, the notifications you fetch thereafter will have a `reason` of `mention`. The `reason` remains as `mention`, regardless of whether you're ever mentioned again. + + + diff --git a/content/rest/activity/starring.md b/content/rest/activity/starring.md index 6cd166f779..4f744d327d 100644 --- a/content/rest/activity/starring.md +++ b/content/rest/activity/starring.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About starring @@ -30,3 +31,6 @@ There is one supported custom media type for these endpoints. When you use this application/vnd.github.star+json For more information about media types, see "[Custom media types](/rest/overview/media-types)." + + + diff --git a/content/rest/activity/watching.md b/content/rest/activity/watching.md index 779717e855..b320fef7eb 100644 --- a/content/rest/activity/watching.md +++ b/content/rest/activity/watching.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About watching @@ -16,3 +17,6 @@ miniTocMaxHeadingLevel: 3 You can use the REST API to subscribe to notifications for activity in a repository. To bookmark a repository instead, see "[Starring](/rest/reference/activity#starring)." + + + diff --git a/content/rest/announcement-banners/enterprises.md b/content/rest/announcement-banners/enterprises.md index 8c924a4b42..308d54453c 100644 --- a/content/rest/announcement-banners/enterprises.md +++ b/content/rest/announcement-banners/enterprises.md @@ -6,5 +6,9 @@ versions: ghec: '*' miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- + + + diff --git a/content/rest/announcement-banners/index.md b/content/rest/announcement-banners/index.md index ed54923c2b..8b2a7d149c 100644 --- a/content/rest/announcement-banners/index.md +++ b/content/rest/announcement-banners/index.md @@ -9,5 +9,9 @@ miniTocMaxHeadingLevel: 3 children: - /enterprises - /organizations +autogenerated: true --- + + + diff --git a/content/rest/announcement-banners/organizations.md b/content/rest/announcement-banners/organizations.md index de05518d45..283fd5bbc7 100644 --- a/content/rest/announcement-banners/organizations.md +++ b/content/rest/announcement-banners/organizations.md @@ -8,5 +8,9 @@ versions: ghae: '>=3.8' miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- + + + diff --git a/content/rest/apps/apps.md b/content/rest/apps/apps.md index 35af7a535c..f666f00be0 100644 --- a/content/rest/apps/apps.md +++ b/content/rest/apps/apps.md @@ -10,6 +10,7 @@ versions: ghes: '*' ghae: '*' ghec: '*' +autogenerated: true --- ## About {% data variables.product.prodname_github_apps %} @@ -19,3 +20,6 @@ versions: This page lists endpoints that you can access while authenticated as a {% data variables.product.prodname_github_app %}. For more information, see "[Authenticating as a GitHub App](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)". See ["GitHub App Installations"](/rest/reference/apps#installations) for a list of endpoints that require authentication as a {% data variables.product.prodname_github_app %} installation. + + + diff --git a/content/rest/apps/index.md b/content/rest/apps/index.md index 02747d75f5..a21c1b0439 100644 --- a/content/rest/apps/index.md +++ b/content/rest/apps/index.md @@ -18,5 +18,9 @@ children: - /marketplace - /oauth-applications - /webhooks +autogenerated: true --- + + + diff --git a/content/rest/apps/installations.md b/content/rest/apps/installations.md index 58556ca8d8..c72fdd1721 100644 --- a/content/rest/apps/installations.md +++ b/content/rest/apps/installations.md @@ -11,6 +11,7 @@ versions: ghes: '*' ghae: '*' ghec: '*' +autogenerated: true --- ## About {% data variables.product.prodname_github_app %} installations @@ -18,3 +19,6 @@ versions: A {% data variables.product.prodname_github_app %} installation refers to any user or organization account that has installed the app. For information on how to authenticate as an installation and limit access to specific repositories, see "[Authenticating as an installation](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)." To list all GitHub App installations for an organization, see "[List app installations for an organization](/rest/orgs/orgs#list-app-installations-for-an-organization)." + + + diff --git a/content/rest/apps/marketplace.md b/content/rest/apps/marketplace.md index 2490075693..14a4d15b10 100644 --- a/content/rest/apps/marketplace.md +++ b/content/rest/apps/marketplace.md @@ -9,6 +9,7 @@ miniTocMaxHeadingLevel: 3 versions: fpt: '*' ghec: '*' +autogenerated: true --- ## About {% data variables.product.prodname_marketplace %} @@ -24,3 +25,6 @@ You can [test your {% data variables.product.prodname_github_app %}](/marketplac To test with stubbed data, use a stubbed endpoint in place of its production counterpart. This allows you to test whether the API logic succeeds before listing {% data variables.product.prodname_github_apps %} on {% data variables.product.prodname_marketplace %}. Make sure to replace stubbed endpoints with production endpoints before deploying your {% data variables.product.prodname_github_app %}. + + + diff --git a/content/rest/apps/oauth-applications.md b/content/rest/apps/oauth-applications.md index 2a4c577a13..04b3fe300e 100644 --- a/content/rest/apps/oauth-applications.md +++ b/content/rest/apps/oauth-applications.md @@ -10,8 +10,12 @@ versions: ghes: '*' ghae: '*' ghec: '*' +autogenerated: true --- ## About {% data variables.product.prodname_oauth_apps %} You can use these endpoints to manage the OAuth tokens that {% data variables.product.prodname_oauth_app %} uses to access people's accounts on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}. + + + diff --git a/content/rest/apps/webhooks.md b/content/rest/apps/webhooks.md index def6d1991d..e7b80b6fda 100644 --- a/content/rest/apps/webhooks.md +++ b/content/rest/apps/webhooks.md @@ -11,8 +11,12 @@ versions: ghes: '*' ghae: '*' ghec: '*' +autogenerated: true --- ## About webhooks for {% data variables.product.prodname_github_apps %} A {% data variables.product.prodname_github_app %}'s webhook allows you to receive HTTP `POST` payloads whenever certain events happen for an app. {% data reusables.webhooks.webhooks-rest-api-links %} + + + diff --git a/content/rest/billing.md b/content/rest/billing.md index 162af80864..18993ff867 100644 --- a/content/rest/billing.md +++ b/content/rest/billing.md @@ -10,8 +10,12 @@ versions: ghes: '*' redirect_from: - /rest/reference/billing +autogenerated: true --- ## About billing You can get billing information for an enterprise. For more information, see "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#billing)." + + + diff --git a/content/rest/branches/branch-protection.md b/content/rest/branches/branch-protection.md index 5b661045e0..0df34e4cf5 100644 --- a/content/rest/branches/branch-protection.md +++ b/content/rest/branches/branch-protection.md @@ -10,5 +10,9 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- + + + diff --git a/content/rest/branches/branches.md b/content/rest/branches/branches.md index ba663344b5..ef9cddb86c 100644 --- a/content/rest/branches/branches.md +++ b/content/rest/branches/branches.md @@ -9,5 +9,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- + + + diff --git a/content/rest/branches/index.md b/content/rest/branches/index.md index 587702234d..7bd5542611 100644 --- a/content/rest/branches/index.md +++ b/content/rest/branches/index.md @@ -15,5 +15,9 @@ children: - /branch-protection redirect_from: - /rest/reference/branches +autogenerated: true --- + + + diff --git a/content/rest/checks/index.md b/content/rest/checks/index.md index a5823ab2e2..183dfd986d 100644 --- a/content/rest/checks/index.md +++ b/content/rest/checks/index.md @@ -15,6 +15,10 @@ miniTocMaxHeadingLevel: 3 children: - /runs - /suites +autogenerated: true --- You can create apps that perform continuous integration, code linting, or code scanning services and provide detailed feedback on commits. For more information, see "[Using the REST API to interact with checks](/rest/guides/using-the-rest-api-to-interact-with-checks)" and "[Creating CI tests with the Checks API](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/)." + + + diff --git a/content/rest/checks/runs.md b/content/rest/checks/runs.md index 72d94cb6f8..da1e5e32d9 100644 --- a/content/rest/checks/runs.md +++ b/content/rest/checks/runs.md @@ -10,5 +10,9 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- + + + diff --git a/content/rest/checks/suites.md b/content/rest/checks/suites.md index b13d435828..e957673c9f 100644 --- a/content/rest/checks/suites.md +++ b/content/rest/checks/suites.md @@ -10,6 +10,7 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- {% note %} @@ -17,3 +18,6 @@ allowTitleToDifferFromFilename: true **Note:** A GitHub App only receives one [`check_suite`](/webhooks/event-payloads/#check_suite) event per commit SHA, even if you push the commit SHA to more than one branch. To find out when a commit SHA is pushed to a branch, you can subscribe to branch [`create`](/webhooks/event-payloads/#create) events. {% endnote %} + + + diff --git a/content/rest/code-scanning.md b/content/rest/code-scanning.md index 966dc62810..e241cd92ec 100644 --- a/content/rest/code-scanning.md +++ b/content/rest/code-scanning.md @@ -13,6 +13,7 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/code-scanning +autogenerated: true --- {% data reusables.code-scanning.beta %} @@ -30,3 +31,6 @@ There is one supported custom media type for {% data variables.product.prodname_ You can use this with `GET` requests sent to the `/analyses/{analysis_id}` endpoint. For more information about this operation, see "[Get a {% data variables.product.prodname_code_scanning %} analysis for a repository](#get-a-code-scanning-analysis-for-a-repository)." When you use this media type with this operation, the response includes a subset of the actual data that was uploaded for the specified analysis, rather than the summary of the analysis that's returned when you use the default media type. The response also includes additional data such as the `github/alertNumber` and `github/alertUrl` properties. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). For more information, see "[Media types](/rest/overview/media-types)." + + + diff --git a/content/rest/codes-of-conduct.md b/content/rest/codes-of-conduct.md index 87aa60515f..504c6d7f15 100644 --- a/content/rest/codes-of-conduct.md +++ b/content/rest/codes-of-conduct.md @@ -11,5 +11,9 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/codes-of-conduct +autogenerated: true --- + + + diff --git a/content/rest/codespaces/codespaces.md b/content/rest/codespaces/codespaces.md index 06717f44fb..8b5688396f 100644 --- a/content/rest/codespaces/codespaces.md +++ b/content/rest/codespaces/codespaces.md @@ -7,8 +7,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About {% data variables.product.prodname_github_codespaces %} You can manage {% data variables.product.prodname_codespaces %} using the REST API. These endpoints are available for authenticated users, {% data variables.product.prodname_oauth_apps %}, and {% data variables.product.prodname_github_apps %}. For more information, see "[{% data variables.product.prodname_codespaces %}](/codespaces)." + + + diff --git a/content/rest/codespaces/index.md b/content/rest/codespaces/index.md index 1b89cba45b..bce148d4ba 100644 --- a/content/rest/codespaces/index.md +++ b/content/rest/codespaces/index.md @@ -16,5 +16,9 @@ children: - /secrets redirect_from: - /rest/reference/codespaces +autogenerated: true --- + + + diff --git a/content/rest/codespaces/machines.md b/content/rest/codespaces/machines.md index 3324e9c061..d1ffd52e3e 100644 --- a/content/rest/codespaces/machines.md +++ b/content/rest/codespaces/machines.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About {% data variables.product.prodname_codespaces %} machines @@ -16,3 +17,6 @@ miniTocMaxHeadingLevel: 3 You can determine which machine types are available to create a codespace, either on a given repository or as an authenticated user. For more information, see "[About machine types](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace#about-machine-types)." You can also use this information when changing the machine of an existing codespace by updating its `machine` property. The machine update will take place the next time the codespace is restarted. For more information, see "[Changing the machine type for your codespace](/codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace)." + + + diff --git a/content/rest/codespaces/organization-secrets.md b/content/rest/codespaces/organization-secrets.md index 307bfc1209..457ba20df5 100644 --- a/content/rest/codespaces/organization-secrets.md +++ b/content/rest/codespaces/organization-secrets.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- {% note %} @@ -16,3 +17,6 @@ miniTocMaxHeadingLevel: 3 **Note**: These endpoints are currently in public beta and subject to change. {% endnote %} + + + diff --git a/content/rest/codespaces/organizations.md b/content/rest/codespaces/organizations.md index b7b56106b3..972af3b9d1 100644 --- a/content/rest/codespaces/organizations.md +++ b/content/rest/codespaces/organizations.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About {% data variables.product.prodname_codespaces %} organizations @@ -17,3 +18,6 @@ You can manage {% data variables.product.prodname_codespaces %} billed to your organization. These endpoints are available for authenticated organization admins and OAuth Apps, but not GitHub Apps. For more information, see "[{% data variables.product.prodname_codespaces %}](/codespaces)." + + + diff --git a/content/rest/codespaces/repository-secrets.md b/content/rest/codespaces/repository-secrets.md index 5dd508ce64..b93dc4f717 100644 --- a/content/rest/codespaces/repository-secrets.md +++ b/content/rest/codespaces/repository-secrets.md @@ -10,8 +10,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About {% data variables.product.prodname_codespaces %} repository secrets You can create, list, and delete secrets (such as access tokens for cloud services) for repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." + + + diff --git a/content/rest/codespaces/secrets.md b/content/rest/codespaces/secrets.md index e34205a8b8..f2d843c8e0 100644 --- a/content/rest/codespaces/secrets.md +++ b/content/rest/codespaces/secrets.md @@ -9,8 +9,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About {% data variables.product.prodname_codespaces %} user secrets You can create, list, and delete secrets (such as access tokens for cloud services) as well as assign secrets to repositories that the user has access to. These secrets are made available to the codespace at runtime. For more information, see "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)." + + + diff --git a/content/rest/collaborators/collaborators.md b/content/rest/collaborators/collaborators.md index d877ac07b1..6173e36e48 100644 --- a/content/rest/collaborators/collaborators.md +++ b/content/rest/collaborators/collaborators.md @@ -9,5 +9,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- + + + diff --git a/content/rest/collaborators/index.md b/content/rest/collaborators/index.md index 8afb723244..08f0f63b70 100644 --- a/content/rest/collaborators/index.md +++ b/content/rest/collaborators/index.md @@ -15,5 +15,9 @@ children: - /invitations redirect_from: - /rest/reference/collaborators +autogenerated: true --- + + + diff --git a/content/rest/collaborators/invitations.md b/content/rest/collaborators/invitations.md index 580248af85..85f1427bcd 100644 --- a/content/rest/collaborators/invitations.md +++ b/content/rest/collaborators/invitations.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About repository invitations @@ -22,3 +23,6 @@ To add a user as a collaborator, use the Collaborators endpoints instead. For mo Note that the `repo:invite` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to invitations **without** also granting access to repository code, while the `repo` scope grants permission to code as well as invitations. + + + diff --git a/content/rest/commits/comments.md b/content/rest/commits/comments.md index a315d84d32..6279c2b472 100644 --- a/content/rest/commits/comments.md +++ b/content/rest/commits/comments.md @@ -10,6 +10,7 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About commit comments @@ -27,3 +28,6 @@ about the use of media types in the API [here](/rest/overview/media-types). application/vnd.github-commitcomment.full+json For more information, see "[Custom media types](/rest/overview/media-types)." + + + diff --git a/content/rest/commits/commits.md b/content/rest/commits/commits.md index 1404bd3d48..d4389b949e 100644 --- a/content/rest/commits/commits.md +++ b/content/rest/commits/commits.md @@ -9,5 +9,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- + + + diff --git a/content/rest/commits/index.md b/content/rest/commits/index.md index e9a620bbf1..3b6edd054f 100644 --- a/content/rest/commits/index.md +++ b/content/rest/commits/index.md @@ -16,5 +16,9 @@ children: - /statuses redirect_from: - /rest/reference/commits +autogenerated: true --- + + + diff --git a/content/rest/commits/statuses.md b/content/rest/commits/statuses.md index c9eceb75da..460515f17a 100644 --- a/content/rest/commits/statuses.md +++ b/content/rest/commits/statuses.md @@ -10,6 +10,7 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About commit statuses @@ -23,3 +24,6 @@ Statuses can include a `context` to indicate what service is providing that stat Note that the `repo:status` [OAuth scope](/developers/apps/scopes-for-oauth-apps) grants targeted access to statuses **without** also granting access to repository code, while the `repo` scope grants permission to code as well as statuses. If you are developing a GitHub App and want to provide more detailed information about an external service, you may want to use the REST API to manage checks. For more information, see "[Checks](/rest/reference/checks)." + + + diff --git a/content/rest/dependabot/alerts.md b/content/rest/dependabot/alerts.md index 7058e85330..62a59288f6 100644 --- a/content/rest/dependabot/alerts.md +++ b/content/rest/dependabot/alerts.md @@ -8,6 +8,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- {% note %} @@ -19,3 +20,6 @@ miniTocMaxHeadingLevel: 3 ## About {% data variables.product.prodname_dependabot_alerts %} You can view {% data variables.product.prodname_dependabot %} alerts for a repository and update individual alerts with the REST API. For more information, see "[About Dependabot alerts](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + + + diff --git a/content/rest/dependabot/index.md b/content/rest/dependabot/index.md index 3ece42993a..d93b8d7f0e 100644 --- a/content/rest/dependabot/index.md +++ b/content/rest/dependabot/index.md @@ -14,5 +14,9 @@ children: - /secrets redirect_from: - /rest/reference/dependabot +autogenerated: true --- + + + diff --git a/content/rest/dependabot/secrets.md b/content/rest/dependabot/secrets.md index 3bb287214e..38526c067c 100644 --- a/content/rest/dependabot/secrets.md +++ b/content/rest/dependabot/secrets.md @@ -9,6 +9,7 @@ versions: ghes: '*' ghec: '*' allowTitleToDifferFromFilename: true +autogenerated: true --- ## About {% data variables.product.prodname_dependabot %} secrets @@ -16,3 +17,6 @@ allowTitleToDifferFromFilename: true You can create, update, delete, and retrieve information about encrypted secrets using the REST API. {% data reusables.actions.about-secrets %} For more information, see "[Configuring access to private registries for {% data variables.product.prodname_dependabot %}](/code-security/dependabot/working-with-dependabot/configuring-access-to-private-registries-for-dependabot#storing-credentials-for-dependabot-to-use)." {% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `dependabot_secrets` permission to use these endpoints. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + + diff --git a/content/rest/dependency-graph/dependency-review.md b/content/rest/dependency-graph/dependency-review.md index 09c8aeee73..5e84d2341a 100644 --- a/content/rest/dependency-graph/dependency-review.md +++ b/content/rest/dependency-graph/dependency-review.md @@ -10,8 +10,12 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About dependency review You can use the REST API to view dependency changes, and the security impact of these changes, before you add them to your environment. You can view the diff of dependencies between two commits of a repository, including vulnerability data for any version updates with known vulnerabilities. For more information about dependency review, see "[About dependency review](/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review)." + + + diff --git a/content/rest/dependency-graph/dependency-submission.md b/content/rest/dependency-graph/dependency-submission.md index 569c5722a3..609e7d847a 100644 --- a/content/rest/dependency-graph/dependency-submission.md +++ b/content/rest/dependency-graph/dependency-submission.md @@ -4,6 +4,7 @@ intro: Use the REST API to submit dependencies. versions: feature: dependency-submission-api miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About dependency submissions @@ -15,3 +16,6 @@ miniTocMaxHeadingLevel: 3 You can submit dependencies in the form of a snapshot. A snapshot is a set of dependencies associated with a commit SHA and other metadata, that reflects the current state of your repository for a commit. You can choose to use pre-made actions or create your own actions to submit your dependencies in the required format each time your project is built. For more information, see "[Using the Dependency submission API](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api)." You can submit multiple sets of dependencies to be included in your dependency graph. The REST API uses the `job.correlator` property and the `detector.name` category of the snapshot to ensure the latest submissions for each workflow get shown. The `correlator` property itself is the primary field you will use to keep independent submissions distinct. An example `correlator` could be a simple combination of two variables available in actions runs: ` `. + + + diff --git a/content/rest/dependency-graph/index.md b/content/rest/dependency-graph/index.md index 96a2997bf0..0a3a88935f 100644 --- a/content/rest/dependency-graph/index.md +++ b/content/rest/dependency-graph/index.md @@ -14,5 +14,9 @@ children: - /dependency-submission redirect_from: - /rest/reference/dependency-graph +autogenerated: true --- + + + diff --git a/content/rest/deploy-keys.md b/content/rest/deploy-keys.md index cd22c51a97..328811fe13 100644 --- a/content/rest/deploy-keys.md +++ b/content/rest/deploy-keys.md @@ -12,6 +12,7 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true redirect_from: - /rest/reference/deploy_keys +autogenerated: true --- ## About deploy keys @@ -19,3 +20,6 @@ redirect_from: {% data reusables.repositories.deploy-keys %} Deploy keys can either be setup using the following API endpoints, or by using GitHub. To learn how to set deploy keys up in GitHub, see "[Managing deploy keys](/developers/overview/managing-deploy-keys)." + + + diff --git a/content/rest/deployments/branch-policies.md b/content/rest/deployments/branch-policies.md index 6137807af1..bed7c5fa10 100644 --- a/content/rest/deployments/branch-policies.md +++ b/content/rest/deployments/branch-policies.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About deployment branch policies @@ -18,3 +19,6 @@ miniTocMaxHeadingLevel: 3 You can use the REST API to specify custom name patterns that branches must match in order to deploy to an environment. The `deployment_branch_policy.custom_branch_policies` property for the environment must be set to `true` to use these endpoints. To update the `deployment_branch_policy` for an environment, see "[Create or update an environment](/rest/deployments/environments#create-or-update-an-environment)." For more information about restricting environment deployments to certain branches, see "[Using environments for deployment](/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-branches)." + + + diff --git a/content/rest/deployments/deployments.md b/content/rest/deployments/deployments.md index 89b72e09d4..168f1a021b 100644 --- a/content/rest/deployments/deployments.md +++ b/content/rest/deployments/deployments.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About deployments @@ -60,3 +61,6 @@ Note that the `repo_deployment` [OAuth scope](/developers/apps/scopes-for-oauth- When you set the state of a deployment to `success`, then all prior non-transient, non-production environment deployments in the same repository with the same environment name will become `inactive`. To avoid this, you can set `auto_inactive` to `false` when creating the deployment status. You can communicate that a transient environment no longer exists by setting its `state` to `inactive`. Setting the `state` to `inactive` shows the deployment as `destroyed` in {% data variables.product.prodname_dotcom %} and removes access to it. + + + diff --git a/content/rest/deployments/environments.md b/content/rest/deployments/environments.md index 4006351694..2f65d6546a 100644 --- a/content/rest/deployments/environments.md +++ b/content/rest/deployments/environments.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About deployment environments @@ -18,3 +19,6 @@ miniTocMaxHeadingLevel: 3 For more information about environments, see "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)." To manage environment secrets, see "[Secrets](/rest/reference/actions#secrets)." {% data reusables.gated-features.environments %} + + + diff --git a/content/rest/deployments/index.md b/content/rest/deployments/index.md index 640346a850..e922206fff 100644 --- a/content/rest/deployments/index.md +++ b/content/rest/deployments/index.md @@ -17,5 +17,9 @@ children: - /branch-policies redirect_from: - /rest/reference/deployments +autogenerated: true --- + + + diff --git a/content/rest/deployments/statuses.md b/content/rest/deployments/statuses.md index 18879c22ec..c4927b84cc 100644 --- a/content/rest/deployments/statuses.md +++ b/content/rest/deployments/statuses.md @@ -10,5 +10,9 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- + + + diff --git a/content/rest/emojis.md b/content/rest/emojis.md index ac6cf5bac1..a435771023 100644 --- a/content/rest/emojis.md +++ b/content/rest/emojis.md @@ -11,5 +11,9 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/emojis +autogenerated: true --- + + + diff --git a/content/rest/enterprise-admin/admin-stats.md b/content/rest/enterprise-admin/admin-stats.md index a95a17feff..3694fd63c1 100644 --- a/content/rest/enterprise-admin/admin-stats.md +++ b/content/rest/enterprise-admin/admin-stats.md @@ -8,6 +8,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About admin stats @@ -15,3 +16,6 @@ miniTocMaxHeadingLevel: 3 These endpoints are only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators. Normal users will receive a `404` response. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} + + + diff --git a/content/rest/enterprise-admin/announcement.md b/content/rest/enterprise-admin/announcement.md index ec0bf2c6c0..d0436310cf 100644 --- a/content/rest/enterprise-admin/announcement.md +++ b/content/rest/enterprise-admin/announcement.md @@ -7,6 +7,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About announcements @@ -14,3 +15,6 @@ miniTocMaxHeadingLevel: 3 You can use the REST API to manage the global announcement banner in your enterprise. For more information, see "[Customizing user messages for your enterprise](/admin/user-management/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)." {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} + + + diff --git a/content/rest/enterprise-admin/audit-log.md b/content/rest/enterprise-admin/audit-log.md index 8f20db4cf9..b855cd23b4 100644 --- a/content/rest/enterprise-admin/audit-log.md +++ b/content/rest/enterprise-admin/audit-log.md @@ -8,6 +8,10 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} + + + diff --git a/content/rest/enterprise-admin/billing.md b/content/rest/enterprise-admin/billing.md index f6e03b23ab..3f3fc3983d 100644 --- a/content/rest/enterprise-admin/billing.md +++ b/content/rest/enterprise-admin/billing.md @@ -7,6 +7,10 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} + + + diff --git a/content/rest/enterprise-admin/code-security-and-analysis.md b/content/rest/enterprise-admin/code-security-and-analysis.md index 2f6df8da08..86e5022b16 100644 --- a/content/rest/enterprise-admin/code-security-and-analysis.md +++ b/content/rest/enterprise-admin/code-security-and-analysis.md @@ -7,6 +7,10 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} + + + diff --git a/content/rest/enterprise-admin/global-webhooks.md b/content/rest/enterprise-admin/global-webhooks.md index 7d53a45fb7..94adc0ed77 100644 --- a/content/rest/enterprise-admin/global-webhooks.md +++ b/content/rest/enterprise-admin/global-webhooks.md @@ -7,6 +7,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About global webhooks @@ -18,3 +19,6 @@ Global webhooks are automatically installed on your enterprise. You can use glob Global webhooks can subscribe to the [organization](/developers/webhooks-and-events/webhook-events-and-payloads#organization), [user](/developers/webhooks-and-events/webhook-events-and-payloads#user), [repository](/developers/webhooks-and-events/webhook-events-and-payloads#repository), [team](/developers/webhooks-and-events/webhook-events-and-payloads#team), [member](/developers/webhooks-and-events/webhook-events-and-payloads#member), [membership](/developers/webhooks-and-events/webhook-events-and-payloads#membership), [fork](/developers/webhooks-and-events/webhook-events-and-payloads#fork), and [ping](/developers/webhooks-and-events/about-webhooks#ping-event) event types. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} + + + diff --git a/content/rest/enterprise-admin/index.md b/content/rest/enterprise-admin/index.md index 3631bc7233..a36b5f325e 100644 --- a/content/rest/enterprise-admin/index.md +++ b/content/rest/enterprise-admin/index.md @@ -31,6 +31,7 @@ children: - /repo-pre-receive-hooks - /users - /scim +autogenerated: true --- {% ifversion fpt or ghec %} @@ -84,3 +85,6 @@ You can also read the current version by calling the [meta endpoint](/rest/refer {% endif %} ## Endpoints + + + diff --git a/content/rest/enterprise-admin/ldap.md b/content/rest/enterprise-admin/ldap.md index 2cee1dfa31..e3e49c474a 100644 --- a/content/rest/enterprise-admin/ldap.md +++ b/content/rest/enterprise-admin/ldap.md @@ -6,6 +6,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About LDAP @@ -13,3 +14,6 @@ miniTocMaxHeadingLevel: 3 You can use these endpoints to update the Distinguished Name (DN) that a user or team maps to. Note that in most cases, you must have [LDAP Sync enabled](/enterprise/admin/authentication/using-ldap) for your {% data variables.product.product_name %} appliance. The ["Update LDAP mapping for a user"](#update-ldap-mapping-for-a-user) endpoint can be used when LDAP is enabled, even if LDAP Sync is disabled. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} + + + diff --git a/content/rest/enterprise-admin/license.md b/content/rest/enterprise-admin/license.md index 61bb244f51..cc9b2238eb 100644 --- a/content/rest/enterprise-admin/license.md +++ b/content/rest/enterprise-admin/license.md @@ -8,8 +8,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- These endpoints are only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators. Normal users will receive a `404` response. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} + + + diff --git a/content/rest/enterprise-admin/management-console.md b/content/rest/enterprise-admin/management-console.md index 19a04a4699..cebea25409 100644 --- a/content/rest/enterprise-admin/management-console.md +++ b/content/rest/enterprise-admin/management-console.md @@ -6,6 +6,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About the Management Console @@ -37,3 +38,6 @@ $ curl -L -u "api_key:YOUR_PASSWORD" 'https://HOSTNAME:ADMIN-PORT/setup/api' ``` {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} + + + diff --git a/content/rest/enterprise-admin/org-pre-receive-hooks.md b/content/rest/enterprise-admin/org-pre-receive-hooks.md index c26cf62c8b..e66685b8cc 100644 --- a/content/rest/enterprise-admin/org-pre-receive-hooks.md +++ b/content/rest/enterprise-admin/org-pre-receive-hooks.md @@ -7,6 +7,7 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About organization pre-receive hooks @@ -25,3 +26,6 @@ allowTitleToDifferFromFilename: true Possible values for `enforcement` are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. `configuration_url` may be a link to this endpoint or this hook's global configuration. Only site admins are able to access the global configuration. + + + diff --git a/content/rest/enterprise-admin/orgs.md b/content/rest/enterprise-admin/orgs.md index eccc2a925e..18b79451a8 100644 --- a/content/rest/enterprise-admin/orgs.md +++ b/content/rest/enterprise-admin/orgs.md @@ -8,6 +8,7 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About organization administration @@ -15,3 +16,6 @@ allowTitleToDifferFromFilename: true These endpoints are only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators. Normal users will receive a `404` response. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} + + + diff --git a/content/rest/enterprise-admin/pre-receive-environments.md b/content/rest/enterprise-admin/pre-receive-environments.md index 81c757d880..fcc52bfddf 100644 --- a/content/rest/enterprise-admin/pre-receive-environments.md +++ b/content/rest/enterprise-admin/pre-receive-environments.md @@ -7,6 +7,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About pre-receive environments @@ -36,3 +37,6 @@ These endpoints are only available to [authenticated](/rest/overview/resources-i | `message` | `string` | On failure, this will have any error messages produced. | Possible values for `state` are `not_started`, `in_progress`, `success`, `failed`. + + + diff --git a/content/rest/enterprise-admin/pre-receive-hooks.md b/content/rest/enterprise-admin/pre-receive-hooks.md index 4051c0ba67..92a555c7ba 100644 --- a/content/rest/enterprise-admin/pre-receive-hooks.md +++ b/content/rest/enterprise-admin/pre-receive-hooks.md @@ -6,6 +6,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About pre-receive hooks @@ -29,3 +30,6 @@ These endpoints are only available to [authenticated](/rest/overview/resources-i Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. + + + diff --git a/content/rest/enterprise-admin/repo-pre-receive-hooks.md b/content/rest/enterprise-admin/repo-pre-receive-hooks.md index a2918c2128..95c8eb0f56 100644 --- a/content/rest/enterprise-admin/repo-pre-receive-hooks.md +++ b/content/rest/enterprise-admin/repo-pre-receive-hooks.md @@ -7,6 +7,7 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About repository pre-receive hooks @@ -23,3 +24,6 @@ allowTitleToDifferFromFilename: true Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. `configuration_url` may be a link to this repository, it's organization owner or global configuration. Authorization to access the endpoint at `configuration_url` is determined at the owner or site admin level. + + + diff --git a/content/rest/enterprise-admin/scim.md b/content/rest/enterprise-admin/scim.md index 9ffb5313a0..9af2534e36 100644 --- a/content/rest/enterprise-admin/scim.md +++ b/content/rest/enterprise-admin/scim.md @@ -6,6 +6,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About SCIM @@ -72,3 +73,6 @@ The {% data variables.product.product_name %} instance links each user who authe | `externalId` | String | This identifier is generated by an IdP provider. You can find the `externalId` for a user either on the IdP, or by using the [List SCIM provisioned identities](#list-scim-provisioned-identities-for-an-enterprise) endpoint and filtering on other known attributes, such as a user's username or email address on the {% data variables.product.product_name %} instance. | | `id` | String | Identifier generated by the instance's SCIM endpoint. | | `active` | Boolean | Indicates whether the identity is active (`true`) or should be suspended (`false`). | + + + diff --git a/content/rest/enterprise-admin/users.md b/content/rest/enterprise-admin/users.md index 01dacf26ba..27ddd24b50 100644 --- a/content/rest/enterprise-admin/users.md +++ b/content/rest/enterprise-admin/users.md @@ -7,6 +7,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About user administration @@ -14,3 +15,6 @@ miniTocMaxHeadingLevel: 3 These endpoints are only available to [authenticated](/rest/overview/resources-in-the-rest-api#authentication) site administrators. Normal users will receive a `403` response. {% data reusables.user-settings.enterprise-admin-api-classic-pat-only %} + + + diff --git a/content/rest/gists/comments.md b/content/rest/gists/comments.md index 2bfe4dc2ed..a2f8d37a4d 100644 --- a/content/rest/gists/comments.md +++ b/content/rest/gists/comments.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About gist comments @@ -25,3 +26,6 @@ These are the supported media types for gist comments. application/vnd.github.VERSION.base64 For more information about media types, see "[Custom media types](/rest/overview/media-types)." + + + diff --git a/content/rest/gists/gists.md b/content/rest/gists/gists.md index 9ced74051c..eda841124e 100644 --- a/content/rest/gists/gists.md +++ b/content/rest/gists/gists.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About gists @@ -37,3 +38,6 @@ These are the supported media types for fetching gist contents. application/vnd.github.base64 For more information, see "[Media types](/rest/overview/media-types)." + + + diff --git a/content/rest/gists/index.md b/content/rest/gists/index.md index 5284c32917..c5d1f7c3e7 100644 --- a/content/rest/gists/index.md +++ b/content/rest/gists/index.md @@ -15,5 +15,9 @@ miniTocMaxHeadingLevel: 3 children: - /gists - /comments +autogenerated: true --- + + + diff --git a/content/rest/git/blobs.md b/content/rest/git/blobs.md index 1a7115eb2a..dfedb9c3d6 100644 --- a/content/rest/git/blobs.md +++ b/content/rest/git/blobs.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About Git blobs @@ -26,3 +27,6 @@ These are the supported media types for blobs. application/vnd.github.raw For more information, see "[Media types](/rest/overview/media-types)." + + + diff --git a/content/rest/git/commits.md b/content/rest/git/commits.md index 27c6056daa..9317290002 100644 --- a/content/rest/git/commits.md +++ b/content/rest/git/commits.md @@ -11,8 +11,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About Git commits A Git commit is a snapshot of the hierarchy ([Git tree](/rest/reference/git#trees)) and the contents of the files ([Git blob](/rest/reference/git#blobs)) in a Git repository. These endpoints allow you to read and write [commit objects](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects#_git_commit_objects) to your Git database on {% data variables.product.product_name %}. + + + diff --git a/content/rest/git/index.md b/content/rest/git/index.md index c05fb32d9d..5699402bdc 100644 --- a/content/rest/git/index.md +++ b/content/rest/git/index.md @@ -19,8 +19,12 @@ children: - /refs - /tags - /trees +autogenerated: true --- ## About Git database The REST API gives you access to read and write raw Git objects to your Git database on {% data variables.product.product_name %} and to list and update your references (branch heads and tags). For more information about using the REST API to interact with your Git database, see "[Getting started with the Git data API](/rest/guides/getting-started-with-the-git-database-api)." + + + diff --git a/content/rest/git/refs.md b/content/rest/git/refs.md index 95489bca38..70baac200c 100644 --- a/content/rest/git/refs.md +++ b/content/rest/git/refs.md @@ -11,8 +11,12 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About Git references A Git reference (`git ref`) is a file that contains a Git commit SHA-1 hash. When referring to a Git commit, you can use the Git reference, which is an easy-to-remember name, rather than the hash. The Git reference can be rewritten to point to a new commit. A branch is a Git reference that stores the new Git commit hash. These endpoints allow you to read and write [references](https://git-scm.com/book/en/v2/Git-Internals-Git-References) to your Git database on {% data variables.product.product_name %}. + + + diff --git a/content/rest/git/tags.md b/content/rest/git/tags.md index 0dda4b3920..091d50d6c9 100644 --- a/content/rest/git/tags.md +++ b/content/rest/git/tags.md @@ -11,8 +11,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About Git tags A Git tag is similar to a [Git reference](/rest/reference/git#refs), but the Git commit that it points to never changes. Git tags are helpful when you want to point to specific releases. These endpoints allow you to read and write [tag objects](https://git-scm.com/book/en/v2/Git-Internals-Git-References#_tags) to your Git database on {% data variables.product.product_name %}. The API only supports [annotated tag objects](https://git-scm.com/book/en/v2/Git-Internals-Git-References#_tags), not lightweight tags. + + + diff --git a/content/rest/git/trees.md b/content/rest/git/trees.md index 16f8c492cd..ec3e64e042 100644 --- a/content/rest/git/trees.md +++ b/content/rest/git/trees.md @@ -11,8 +11,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About Git trees A Git tree object creates the hierarchy between files in a Git repository. You can use the Git tree object to create the relationship between directories and the files they contain. These endpoints allow you to read and write [tree objects](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects#_tree_objects) to your Git database on {% data variables.product.product_name %}. + + + diff --git a/content/rest/gitignore.md b/content/rest/gitignore.md index 298c9b66f1..d8940e968f 100644 --- a/content/rest/gitignore.md +++ b/content/rest/gitignore.md @@ -11,6 +11,7 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/gitignore +autogenerated: true --- ## About gitignore @@ -18,3 +19,6 @@ redirect_from: When you create a new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} via the API, you can specify a [.gitignore template](/github/getting-started-with-github/ignoring-files) to apply to the repository upon creation. You can use the REST API to get .gitignore templates from the {% data variables.product.product_name %} [.gitignore repository](https://github.com/github/gitignore). You can use the `application/vnd.github.raw` custom media type when getting a gitignore template. For more information, see "[Media types](/rest/overview/media-types)." + + + diff --git a/content/rest/index.md b/content/rest/index.md index 552d5fe041..f5cde54bdd 100644 --- a/content/rest/index.md +++ b/content/rest/index.md @@ -81,5 +81,9 @@ children: - /teams - /users - /webhooks +autogenerated: true --- + + + diff --git a/content/rest/interactions/index.md b/content/rest/interactions/index.md index a11a7df3e6..09740c1462 100644 --- a/content/rest/interactions/index.md +++ b/content/rest/interactions/index.md @@ -15,8 +15,12 @@ children: - /orgs - /repos - /user +autogenerated: true --- ## About interactions Users interact with repositories by commenting, opening issues, and creating pull requests. You can use the REST API to allow people with owner or admin access to temporarily restrict interaction with public repositories to a certain type of user. + + + diff --git a/content/rest/interactions/orgs.md b/content/rest/interactions/orgs.md index b1c695e693..ff4ba1596b 100644 --- a/content/rest/interactions/orgs.md +++ b/content/rest/interactions/orgs.md @@ -9,6 +9,7 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About organization interactions @@ -20,3 +21,6 @@ Organization owners can temporarily restrict which type of user can comment, ope * {% data reusables.interactions.collaborator-user-limit-definition %} in the organization. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. To set different interaction limits for individual repositories owned by the organization, use the [Repository](#repository) interactions endpoints instead. + + + diff --git a/content/rest/interactions/repos.md b/content/rest/interactions/repos.md index b091f55826..bccadbf414 100644 --- a/content/rest/interactions/repos.md +++ b/content/rest/interactions/repos.md @@ -10,6 +10,7 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About repository interactions @@ -21,3 +22,6 @@ People with owner or admin access can use the REST API to temporarily restrict w * {% data reusables.interactions.collaborator-user-limit-definition %} in the repository. If an interaction limit is enabled for the user or organization that owns the repository, the limit cannot be changed for the individual repository. Instead, use the [User](#user) or [Organization](#organization) interactions endpoints to change the interaction limit. + + + diff --git a/content/rest/interactions/user.md b/content/rest/interactions/user.md index 327cb62de5..b13e370213 100644 --- a/content/rest/interactions/user.md +++ b/content/rest/interactions/user.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About user interactions @@ -20,3 +21,6 @@ You can use the REST API to temporarily restrict which type of user can comment, * {% data reusables.interactions.collaborator-user-limit-definition %} from interacting with your repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. To set different interaction limits for individual repositories owned by the user, use the [Repository](#repository) interactions endpoints instead. + + + diff --git a/content/rest/issues/assignees.md b/content/rest/issues/assignees.md index 4c3d97d2e3..0a9f75221a 100644 --- a/content/rest/issues/assignees.md +++ b/content/rest/issues/assignees.md @@ -11,8 +11,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About issue and pull request assignees You can use the REST API to view, add, and remove assignees on issues and pull requests. {% data reusables.pull_requests.issues-pr-shared-api %} + + + diff --git a/content/rest/issues/comments.md b/content/rest/issues/comments.md index 628d5021b3..4ae18f4192 100644 --- a/content/rest/issues/comments.md +++ b/content/rest/issues/comments.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About issue and pull request comments @@ -18,3 +19,6 @@ miniTocMaxHeadingLevel: 3 You can use the REST API to create and manage comments on issues and pull requests. {% data reusables.pull_requests.issues-pr-shared-api %} To manage pull request review comments, see "[Pull request review comments](/rest/pulls/comments)." {% data reusables.pull_requests.issues-media-types %} + + + diff --git a/content/rest/issues/events.md b/content/rest/issues/events.md index 2d8f407de3..f78ec3ae92 100644 --- a/content/rest/issues/events.md +++ b/content/rest/issues/events.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About events @@ -18,3 +19,6 @@ miniTocMaxHeadingLevel: 3 You can use the REST API to view different types of events triggered by activity in issues and pull requests. For more information about the specific events that you can receive, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." To view GitHub activity outside of issues and pull requests, you can use the [Events](/developers/webhooks-and-events/github-event-types) endpoints. {% data reusables.pull_requests.issues-pr-shared-api %} + + + diff --git a/content/rest/issues/index.md b/content/rest/issues/index.md index b457d4252f..8c3e65dc47 100644 --- a/content/rest/issues/index.md +++ b/content/rest/issues/index.md @@ -20,5 +20,9 @@ children: - /labels - /milestones - /timeline +autogenerated: true --- + + + diff --git a/content/rest/issues/issues.md b/content/rest/issues/issues.md index 2a8d3b5687..c3f92d9cda 100644 --- a/content/rest/issues/issues.md +++ b/content/rest/issues/issues.md @@ -9,8 +9,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About issues {% data reusables.pull_requests.issues-media-types %} + + + diff --git a/content/rest/issues/labels.md b/content/rest/issues/labels.md index dadf4b591f..f9082ebb81 100644 --- a/content/rest/issues/labels.md +++ b/content/rest/issues/labels.md @@ -9,8 +9,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About labels You can use the REST API to manage labels for a repository and add or remove labels to issues and pull requests. {% data reusables.pull_requests.issues-pr-shared-api %} + + + diff --git a/content/rest/issues/milestones.md b/content/rest/issues/milestones.md index 673a1c3c8b..e0bb30661d 100644 --- a/content/rest/issues/milestones.md +++ b/content/rest/issues/milestones.md @@ -9,5 +9,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- + + + diff --git a/content/rest/issues/timeline.md b/content/rest/issues/timeline.md index 8904295675..fcea204874 100644 --- a/content/rest/issues/timeline.md +++ b/content/rest/issues/timeline.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About timeline events @@ -20,3 +21,6 @@ You can use the REST API to view different types of events triggered by timeline You can use timeline events to display information about issues and pull requests or determine who should be notified of issue comments. {% data reusables.pull_requests.issues-pr-shared-api %} + + + diff --git a/content/rest/licenses.md b/content/rest/licenses.md index c6f3b41e26..26973a623e 100644 --- a/content/rest/licenses.md +++ b/content/rest/licenses.md @@ -11,6 +11,7 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/licenses +autogenerated: true --- ## About licenses @@ -35,3 +36,6 @@ GitHub is a lot of things, but it’s not a law firm. As such, {% data variables {% data variables.product.company_short %} created these endpoints to help users get information about open source licenses and the projects that use them. We hope it helps, but please keep in mind that we’re not lawyers (at least most of us aren't) and that we make mistakes like everyone else. For that reason, {% data variables.product.company_short %} provides the API on an "as-is" basis and makes no warranties regarding any information or licenses provided on or through it, and disclaims liability for damages resulting from using the API. {% endwarning %} + + + diff --git a/content/rest/markdown.md b/content/rest/markdown.md index 267f452db0..0430ccf502 100644 --- a/content/rest/markdown.md +++ b/content/rest/markdown.md @@ -11,5 +11,9 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/markdown +autogenerated: true --- + + + diff --git a/content/rest/meta.md b/content/rest/meta.md index ccb8b4f9ee..df52fa95e8 100644 --- a/content/rest/meta.md +++ b/content/rest/meta.md @@ -11,5 +11,9 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/meta +autogenerated: true --- + + + diff --git a/content/rest/metrics/community.md b/content/rest/metrics/community.md index 78eae188cf..13ee419dac 100644 --- a/content/rest/metrics/community.md +++ b/content/rest/metrics/community.md @@ -9,5 +9,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- + + + diff --git a/content/rest/metrics/index.md b/content/rest/metrics/index.md index 99e815b0fd..766ad27f5d 100644 --- a/content/rest/metrics/index.md +++ b/content/rest/metrics/index.md @@ -17,5 +17,9 @@ children: - /community - /statistics - /traffic +autogenerated: true --- + + + diff --git a/content/rest/metrics/statistics.md b/content/rest/metrics/statistics.md index 9ac83fad67..f5c3e31102 100644 --- a/content/rest/metrics/statistics.md +++ b/content/rest/metrics/statistics.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About repository statistics @@ -35,3 +36,6 @@ The statistics exposed by the API match the statistics shown by [different repos To summarize this: - All statistics exclude merge commits. - Contributor statistics also exclude empty commits. + + + diff --git a/content/rest/metrics/traffic.md b/content/rest/metrics/traffic.md index 0bbeda3172..bdc3f14f68 100644 --- a/content/rest/metrics/traffic.md +++ b/content/rest/metrics/traffic.md @@ -9,8 +9,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About repository traffic You can use these endpoints to retrieve information provided in your repository graph, for repositories that you have write access to. For more information, see "[Viewing traffic to a repository](/repositories/viewing-activity-and-data-for-your-repository/viewing-traffic-to-a-repository)". + + + diff --git a/content/rest/migrations/index.md b/content/rest/migrations/index.md index 89050aee87..b468b456d7 100644 --- a/content/rest/migrations/index.md +++ b/content/rest/migrations/index.md @@ -18,5 +18,9 @@ children: - /orgs - /source-imports - /users +autogenerated: true --- + + + diff --git a/content/rest/migrations/orgs.md b/content/rest/migrations/orgs.md index fb919f8e3f..a1e6ab5578 100644 --- a/content/rest/migrations/orgs.md +++ b/content/rest/migrations/orgs.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About organization migrations @@ -18,3 +19,6 @@ miniTocMaxHeadingLevel: 3 These endpoints are only available to authenticated organization owners. For more information, see "[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization#permission-levels-for-an-organization)" and "[Other authentication methods](/rest/overview/other-authentication-methods)." {% data variables.migrations.organization_migrations_intro %} + + + diff --git a/content/rest/migrations/source-imports.md b/content/rest/migrations/source-imports.md index b5d4607ed1..c1c0dd8e03 100644 --- a/content/rest/migrations/source-imports.md +++ b/content/rest/migrations/source-imports.md @@ -7,6 +7,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About source imports @@ -89,3 +90,6 @@ The following diagram provides a more detailed example: | | | | | | ``` + + + diff --git a/content/rest/migrations/users.md b/content/rest/migrations/users.md index cee8138647..64a25f8a25 100644 --- a/content/rest/migrations/users.md +++ b/content/rest/migrations/users.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About user migrations @@ -22,3 +23,6 @@ These endpoints are only available to authenticated account owners. For more inf To download an archive, you'll need to start a user migration first. Once the status of the migration is `exported`, you can download the migration. Once you've created a migration archive, it will be available to download for seven days. But, you can delete the user migration archive sooner if you'd like. You can unlock your repository when the migration is `exported` to begin using your repository again or delete the repository if you no longer need the source data. + + + diff --git a/content/rest/oauth-authorizations.md b/content/rest/oauth-authorizations.md index 90fc8af718..6b5e6cc9fc 100644 --- a/content/rest/oauth-authorizations.md +++ b/content/rest/oauth-authorizations.md @@ -8,6 +8,7 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/oauth-authorizations +autogenerated: true --- ## About OAuth authorizations @@ -15,3 +16,6 @@ redirect_from: You can use the REST API to manage the access OAuth applications have to your account. You can only access these endpoints via [Basic Authentication](/rest/overview/other-authentication-methods#basic-authentication) using your username and password, not tokens. If you or your users have two-factor authentication enabled, make sure you understand how to [work with two-factor authentication](/rest/overview/other-authentication-methods#working-with-two-factor-authentication). + + + diff --git a/content/rest/orgs/blocking.md b/content/rest/orgs/blocking.md index c1914e6db1..02708c71fc 100644 --- a/content/rest/orgs/blocking.md +++ b/content/rest/orgs/blocking.md @@ -8,8 +8,12 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About blocking users The token used to authenticate the call must have the `admin:org` scope in order to make any blocking calls for an organization. Otherwise, the response returns `HTTP 404`. + + + diff --git a/content/rest/orgs/custom-roles.md b/content/rest/orgs/custom-roles.md index 41380ac139..9caf6d1ca6 100644 --- a/content/rest/orgs/custom-roles.md +++ b/content/rest/orgs/custom-roles.md @@ -10,5 +10,9 @@ miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true redirect_from: - /rest/orgs/custom_roles +autogenerated: true --- + + + diff --git a/content/rest/orgs/index.md b/content/rest/orgs/index.md index b2f7589f34..7b4b7d074c 100644 --- a/content/rest/orgs/index.md +++ b/content/rest/orgs/index.md @@ -21,5 +21,9 @@ children: - /outside-collaborators - /security-managers - /webhooks +autogenerated: true --- + + + diff --git a/content/rest/orgs/members.md b/content/rest/orgs/members.md index 1cca96e6c8..874835d3b7 100644 --- a/content/rest/orgs/members.md +++ b/content/rest/orgs/members.md @@ -11,5 +11,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- + + + diff --git a/content/rest/orgs/orgs.md b/content/rest/orgs/orgs.md index 1b7b1e33d8..007b8fa6f6 100644 --- a/content/rest/orgs/orgs.md +++ b/content/rest/orgs/orgs.md @@ -10,5 +10,9 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- + + + diff --git a/content/rest/orgs/outside-collaborators.md b/content/rest/orgs/outside-collaborators.md index f94f5fdb2a..7110a9ddcf 100644 --- a/content/rest/orgs/outside-collaborators.md +++ b/content/rest/orgs/outside-collaborators.md @@ -9,5 +9,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- + + + diff --git a/content/rest/orgs/security-managers.md b/content/rest/orgs/security-managers.md index 15d5d575c0..52bf673f1e 100644 --- a/content/rest/orgs/security-managers.md +++ b/content/rest/orgs/security-managers.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About security managers @@ -16,3 +17,6 @@ miniTocMaxHeadingLevel: 3 {% data reusables.organizations.security-manager-beta-note %} {% data reusables.organizations.about-security-managers %} + + + diff --git a/content/rest/orgs/webhooks.md b/content/rest/orgs/webhooks.md index dc4acabbe0..732b0daeb2 100644 --- a/content/rest/orgs/webhooks.md +++ b/content/rest/orgs/webhooks.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About organization webhooks @@ -35,3 +36,6 @@ For more best practices, [see our guide](/guides/best-practices-for-integrators/ #### Webhook headers {% data variables.product.product_name %} will send along several HTTP headers to differentiate between event types and payload identifiers. See [webhook headers](/webhooks/event-payloads/#delivery-headers) for details. + + + diff --git a/content/rest/overview/endpoints-available-for-github-apps.md b/content/rest/overview/endpoints-available-for-github-apps.md index fab52f7c2c..fa29ee8f99 100644 --- a/content/rest/overview/endpoints-available-for-github-apps.md +++ b/content/rest/overview/endpoints-available-for-github-apps.md @@ -13,6 +13,9 @@ versions: topics: - API shortTitle: GitHub App-enabled endpoints +autogenerated: true --- + + diff --git a/content/rest/packages.md b/content/rest/packages.md index c30d35af66..d783aece99 100644 --- a/content/rest/packages.md +++ b/content/rest/packages.md @@ -9,6 +9,7 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/packages +autogenerated: true --- ## About {% data variables.product.prodname_registry %} @@ -23,3 +24,6 @@ To use the REST API to manage {% data variables.product.prodname_registry %}, yo If your package is in a registry that supports granular permissions, then your token does not need the `repo` scope to access or manage this package. If your package is in a registry that only supports repository-scoped permissions, then your token must also include the `repo` scope since your package inherits permissions from a {% data variables.product.prodname_dotcom %} repository. For a list of registries that only support repository-scoped permissions, see "[About permissions for {% data variables.product.prodname_registry %}](/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." To access resources in an organization with SSO enabled, you must enable SSO for your {% data variables.product.pat_v1 %}. For more information, see "[Authorizing a {% data variables.product.pat_generic %} for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on){% ifversion fpt %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %} + + + diff --git a/content/rest/pages.md b/content/rest/pages.md index fec2530f72..d0186131f5 100644 --- a/content/rest/pages.md +++ b/content/rest/pages.md @@ -11,5 +11,9 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/pages +autogenerated: true --- + + + diff --git a/content/rest/projects/cards.md b/content/rest/projects/cards.md index a17e4e0af9..dda63799d1 100644 --- a/content/rest/projects/cards.md +++ b/content/rest/projects/cards.md @@ -11,8 +11,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- {% data reusables.projects.projects-api %} {% data reusables.user-settings.classic-projects-api-classic-pat-only %} + + + diff --git a/content/rest/projects/collaborators.md b/content/rest/projects/collaborators.md index 7161cf157d..3d53658f0b 100644 --- a/content/rest/projects/collaborators.md +++ b/content/rest/projects/collaborators.md @@ -11,8 +11,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- {% data reusables.projects.projects-api %} {% data reusables.user-settings.classic-projects-api-classic-pat-only %} + + + diff --git a/content/rest/projects/columns.md b/content/rest/projects/columns.md index ad57e1fc56..0f4755c017 100644 --- a/content/rest/projects/columns.md +++ b/content/rest/projects/columns.md @@ -11,8 +11,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- {% data reusables.projects.projects-api %} {% data reusables.user-settings.classic-projects-api-classic-pat-only %} + + + diff --git a/content/rest/projects/index.md b/content/rest/projects/index.md index b506d46001..26052006f9 100644 --- a/content/rest/projects/index.md +++ b/content/rest/projects/index.md @@ -18,5 +18,9 @@ children: - /cards - /collaborators - /columns +autogenerated: true --- + + + diff --git a/content/rest/projects/projects.md b/content/rest/projects/projects.md index 668e117d21..862d6927d4 100644 --- a/content/rest/projects/projects.md +++ b/content/rest/projects/projects.md @@ -11,8 +11,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- {% data reusables.projects.projects-api %} {% data reusables.user-settings.classic-projects-api-classic-pat-only %} + + + diff --git a/content/rest/pulls/comments.md b/content/rest/pulls/comments.md index b7f8b00cb8..18c345d37a 100644 --- a/content/rest/pulls/comments.md +++ b/content/rest/pulls/comments.md @@ -11,6 +11,7 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About pull request review comments @@ -18,3 +19,6 @@ allowTitleToDifferFromFilename: true Pull request review comments are comments made on a portion of the unified diff during a pull request review. These are different from commit comments and issue comments in a pull request. For more information, see "[Commit comments](/rest/commits/comments)" and "[Issue comments](/rest/issues/comments)." {% data reusables.pull_requests.issues-media-types %} + + + diff --git a/content/rest/pulls/index.md b/content/rest/pulls/index.md index 4e18b4b661..29ecdca0d9 100644 --- a/content/rest/pulls/index.md +++ b/content/rest/pulls/index.md @@ -17,5 +17,9 @@ children: - /comments - /review-requests - /reviews +autogenerated: true --- + + + diff --git a/content/rest/pulls/pulls.md b/content/rest/pulls/pulls.md index 8dfc4f1330..10946b829b 100644 --- a/content/rest/pulls/pulls.md +++ b/content/rest/pulls/pulls.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About pull requests @@ -46,3 +47,6 @@ Name | Description `review_comment`| The [URL template](/rest#hypermedia) to construct the API location for a [Review comment](/rest/reference/pulls#comments) in this Pull Request's repository. `commits`|The API location of this Pull Request's [commits](#list-commits-on-a-pull-request). `statuses`| The API location of this Pull Request's [commit statuses](/rest/reference/commits#commit-statuses), which are the statuses of its `head` branch. + + + diff --git a/content/rest/pulls/review-requests.md b/content/rest/pulls/review-requests.md index bbfe8057e1..6810e39699 100644 --- a/content/rest/pulls/review-requests.md +++ b/content/rest/pulls/review-requests.md @@ -9,8 +9,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About review requests Pull request authors and repository owners and collaborators can request a pull request review from anyone with write access to the repository. Each requested reviewer will receive a notification asking them to review the pull request. + + + diff --git a/content/rest/pulls/reviews.md b/content/rest/pulls/reviews.md index 042d111d69..b9ecf716cd 100644 --- a/content/rest/pulls/reviews.md +++ b/content/rest/pulls/reviews.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About pull request reviews @@ -18,3 +19,6 @@ miniTocMaxHeadingLevel: 3 Pull Request Reviews are groups of pull request review comments on a pull request, grouped together with a state and optional body comment. {% data reusables.pull_requests.issues-media-types %} + + + diff --git a/content/rest/rate-limit.md b/content/rest/rate-limit.md index d23c23fd55..61e15bf292 100644 --- a/content/rest/rate-limit.md +++ b/content/rest/rate-limit.md @@ -11,6 +11,7 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/rate-limit +autogenerated: true --- ## About rate limits @@ -28,3 +29,6 @@ The REST API for searching items has a custom rate limit that is separate from t * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." For more information on the headers and values in the rate limit response, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limit-http-headers)." + + + diff --git a/content/rest/reactions.md b/content/rest/reactions.md index a3a3c1be43..88f84acc9f 100644 --- a/content/rest/reactions.md +++ b/content/rest/reactions.md @@ -11,6 +11,7 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/reactions +autogenerated: true --- ## About reactions @@ -18,3 +19,6 @@ redirect_from: You can create and manage reactions to comments, issues, pull requests, and discussions on {% data variables.product.prodname_dotcom %}. When creating a reaction, the allowed values for the `content` parameter are as follows (with the corresponding emoji for reference): {% data reusables.repositories.reaction_list %} + + + diff --git a/content/rest/releases/assets.md b/content/rest/releases/assets.md index 6e4f7d94cd..4dbeabed49 100644 --- a/content/rest/releases/assets.md +++ b/content/rest/releases/assets.md @@ -10,5 +10,9 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- + + + diff --git a/content/rest/releases/index.md b/content/rest/releases/index.md index fdab9d4c65..8c9e3ddd08 100644 --- a/content/rest/releases/index.md +++ b/content/rest/releases/index.md @@ -15,5 +15,9 @@ children: - /assets redirect_from: - /rest/reference/releases +autogenerated: true --- + + + diff --git a/content/rest/releases/releases.md b/content/rest/releases/releases.md index e6bd6ae29a..f1963131c7 100644 --- a/content/rest/releases/releases.md +++ b/content/rest/releases/releases.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- {% note %} @@ -16,3 +17,6 @@ miniTocMaxHeadingLevel: 3 **Note:** These endpoints replace the endpoints to manage downloads. You can retrieve the download count and browser download URL from these endpoints. {% endnote %} + + + diff --git a/content/rest/repos/autolinks.md b/content/rest/repos/autolinks.md index a0d46218c5..b821bc57b1 100644 --- a/content/rest/repos/autolinks.md +++ b/content/rest/repos/autolinks.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About repository autolinks @@ -18,3 +19,6 @@ miniTocMaxHeadingLevel: 3 To help streamline your workflow, you can use the REST API to add autolinks to external resources like JIRA issues and Zendesk tickets. For more information, see "[Configuring autolinks to reference external resources](/github/administering-a-repository/configuring-autolinks-to-reference-external-resources)." {% data variables.product.prodname_github_apps %} require repository administration permissions with read or write access to use these endpoints. + + + diff --git a/content/rest/repos/contents.md b/content/rest/repos/contents.md index cde9968590..5a2efefba4 100644 --- a/content/rest/repos/contents.md +++ b/content/rest/repos/contents.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About repository contents @@ -36,3 +37,6 @@ Use the `object` media type parameter to retrieve the contents in a consistent o for a directory, the response will be an object with an `entries` attribute containing the array of objects. You can read more about the use of media types in the API [here](/rest/overview/media-types). + + + diff --git a/content/rest/repos/forks.md b/content/rest/repos/forks.md index 578c4f0b6e..302e6267b1 100644 --- a/content/rest/repos/forks.md +++ b/content/rest/repos/forks.md @@ -9,5 +9,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- + + + diff --git a/content/rest/repos/index.md b/content/rest/repos/index.md index fcfad79324..07065e788a 100644 --- a/content/rest/repos/index.md +++ b/content/rest/repos/index.md @@ -20,5 +20,9 @@ children: - /forks - /lfs - /tags +autogenerated: true --- + + + diff --git a/content/rest/repos/lfs.md b/content/rest/repos/lfs.md index 03ac35ae24..625ce3b859 100644 --- a/content/rest/repos/lfs.md +++ b/content/rest/repos/lfs.md @@ -10,6 +10,7 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About {% data variables.large_files.product_name_short %} @@ -35,3 +36,6 @@ If you want to use these endpoints for a repository that belongs to an organizat {% endif %} {% endif %} + + + diff --git a/content/rest/repos/repos.md b/content/rest/repos/repos.md index ba85856fb1..4418e5af80 100644 --- a/content/rest/repos/repos.md +++ b/content/rest/repos/repos.md @@ -10,5 +10,9 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- + + + diff --git a/content/rest/repos/tags.md b/content/rest/repos/tags.md index 8e71d50a32..7f742e4ff7 100644 --- a/content/rest/repos/tags.md +++ b/content/rest/repos/tags.md @@ -10,5 +10,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- + + + diff --git a/content/rest/scim.md b/content/rest/scim.md index 6469227495..13885eead6 100644 --- a/content/rest/scim.md +++ b/content/rest/scim.md @@ -8,6 +8,7 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/scim +autogenerated: true --- ## About SCIM @@ -53,3 +54,6 @@ GET /scim/v2/organizations/{org}/Users/{scim_user_id} ``` {% endnote %} + + + diff --git a/content/rest/search.md b/content/rest/search.md index 87ed940c7c..39bba77379 100644 --- a/content/rest/search.md +++ b/content/rest/search.md @@ -11,6 +11,7 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/search +autogenerated: true --- ## About search @@ -184,3 +185,6 @@ The second text match occurred in the `body` property of one of the issue's comm ] } ``` + + + diff --git a/content/rest/secret-scanning.md b/content/rest/secret-scanning.md index 5fa1ded70e..a1241f983c 100644 --- a/content/rest/secret-scanning.md +++ b/content/rest/secret-scanning.md @@ -11,6 +11,7 @@ topics: miniTocMaxHeadingLevel: 3 redirect_from: - /rest/reference/secret-scanning +autogenerated: true --- {% data reusables.secret-scanning.api-beta %} @@ -23,3 +24,6 @@ You can use the API to: - Retrieve and update {% data variables.secret-scanning.alerts %} from a repository. For further details, see the sections below. For more information about {% data variables.product.prodname_secret_scanning %}, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." + + + diff --git a/content/rest/teams/discussion-comments.md b/content/rest/teams/discussion-comments.md index 3a875f1084..38f29f238a 100644 --- a/content/rest/teams/discussion-comments.md +++ b/content/rest/teams/discussion-comments.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- {% ifversion team-discussions-migration %} @@ -22,3 +23,6 @@ miniTocMaxHeadingLevel: 3 Any member of the team's [organization](/rest/reference/orgs) can create and read comments on a public discussion. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions/)." {% data reusables.organizations.team-api %} + + + diff --git a/content/rest/teams/discussions.md b/content/rest/teams/discussions.md index 941e1d4ae1..68f57092f9 100644 --- a/content/rest/teams/discussions.md +++ b/content/rest/teams/discussions.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- {% ifversion team-discussions-migration %} @@ -22,3 +23,6 @@ miniTocMaxHeadingLevel: 3 You can use team discussions to have conversations that are not specific to a repository or project. Any member of the team's [organization](/rest/reference/orgs) can create and read public discussion posts. For more details, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." To learn more about commenting on a discussion post, see "[Team discussion comments](/rest/teams/discussion-comments)." {% data reusables.organizations.team-api %} + + + diff --git a/content/rest/teams/external-groups.md b/content/rest/teams/external-groups.md index e79f367818..ad75255243 100644 --- a/content/rest/teams/external-groups.md +++ b/content/rest/teams/external-groups.md @@ -8,6 +8,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About external groups @@ -24,3 +25,6 @@ To use these endpoints, the authenticated user must be a team maintainer or an o {% endnote %} {% endif %} + + + diff --git a/content/rest/teams/index.md b/content/rest/teams/index.md index fe4ce8bbc8..11c0847255 100644 --- a/content/rest/teams/index.md +++ b/content/rest/teams/index.md @@ -19,5 +19,9 @@ children: - /external-groups - /members - /team-sync +autogenerated: true --- + + + diff --git a/content/rest/teams/members.md b/content/rest/teams/members.md index 6e04a328ac..06ec86b5a5 100644 --- a/content/rest/teams/members.md +++ b/content/rest/teams/members.md @@ -11,6 +11,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About team members @@ -25,3 +26,6 @@ miniTocMaxHeadingLevel: 3 {% endnote %} {% endif %} + + + diff --git a/content/rest/teams/team-sync.md b/content/rest/teams/team-sync.md index 327405606d..4615f794eb 100644 --- a/content/rest/teams/team-sync.md +++ b/content/rest/teams/team-sync.md @@ -7,6 +7,7 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About team synchronization @@ -20,3 +21,6 @@ You can manage {% data variables.product.product_name %} team members through yo **Note:** These endpoints cannot be used with {% data variables.product.prodname_emus %}. To learn more about managing an {% data variables.enterprise.prodname_emu_org %}, see "[External groups](/enterprise-cloud@latest/rest/teams/external-groups)". {% endnote %} + + + diff --git a/content/rest/teams/teams.md b/content/rest/teams/teams.md index d0adc57d53..93f104067f 100644 --- a/content/rest/teams/teams.md +++ b/content/rest/teams/teams.md @@ -9,8 +9,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About teams {% data reusables.organizations.team-api %} + + + diff --git a/content/rest/users/blocking.md b/content/rest/users/blocking.md index e72841a089..2523e68406 100644 --- a/content/rest/users/blocking.md +++ b/content/rest/users/blocking.md @@ -8,8 +8,12 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About blocking users {% data reusables.user-settings.user-api %} + + + diff --git a/content/rest/users/emails.md b/content/rest/users/emails.md index 4ffa41a10a..2090d4a29b 100644 --- a/content/rest/users/emails.md +++ b/content/rest/users/emails.md @@ -8,8 +8,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About email administration {% data reusables.user-settings.user-api %} + + + diff --git a/content/rest/users/followers.md b/content/rest/users/followers.md index cf303c8dc7..cf787a7d94 100644 --- a/content/rest/users/followers.md +++ b/content/rest/users/followers.md @@ -9,8 +9,12 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About follower administration {% data reusables.user-settings.user-api %} + + + diff --git a/content/rest/users/gpg-keys.md b/content/rest/users/gpg-keys.md index 4dd45e14a0..4847c1578a 100644 --- a/content/rest/users/gpg-keys.md +++ b/content/rest/users/gpg-keys.md @@ -9,6 +9,7 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- ## About user GPG key administration @@ -16,3 +17,6 @@ miniTocMaxHeadingLevel: 3 The data returned in the `public_key` response field is not a GPG formatted key. When a user uploads a GPG key, it is parsed and the cryptographic public key is extracted and stored. This cryptographic key is what the endpoints in this category will return. This key is not suitable for direct use in programs such as GPG. {% data reusables.user-settings.user-api %} + + + diff --git a/content/rest/users/index.md b/content/rest/users/index.md index d6fb3878a8..2e247e81e3 100644 --- a/content/rest/users/index.md +++ b/content/rest/users/index.md @@ -20,5 +20,9 @@ children: - /gpg-keys - /keys - /ssh-signing-keys +autogenerated: true --- + + + diff --git a/content/rest/users/keys.md b/content/rest/users/keys.md index 58a377aca9..ebca45c1a6 100644 --- a/content/rest/users/keys.md +++ b/content/rest/users/keys.md @@ -10,8 +10,12 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About Git SSH key administration {% data reusables.user-settings.user-api %} + + + diff --git a/content/rest/users/ssh-signing-keys.md b/content/rest/users/ssh-signing-keys.md index b3abec7312..1d3b8fe070 100644 --- a/content/rest/users/ssh-signing-keys.md +++ b/content/rest/users/ssh-signing-keys.md @@ -9,8 +9,12 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- ## About SSH signing key administration {% data reusables.user-settings.user-api %} + + + diff --git a/content/rest/users/users.md b/content/rest/users/users.md index 05a0d53654..b5282ed987 100644 --- a/content/rest/users/users.md +++ b/content/rest/users/users.md @@ -9,5 +9,9 @@ versions: topics: - API miniTocMaxHeadingLevel: 3 +autogenerated: true --- + + + diff --git a/content/rest/webhooks/index.md b/content/rest/webhooks/index.md index f6dc3f097f..4bc3215e8d 100644 --- a/content/rest/webhooks/index.md +++ b/content/rest/webhooks/index.md @@ -16,6 +16,7 @@ children: - /repos redirect_from: - /rest/reference/webhooks +autogenerated: true --- ## About repository webhooks @@ -79,3 +80,6 @@ Name | Type | Description ``hub.topic``|`string` |**Required**. The URI of the GitHub repository to subscribe to. The path must be in the format of `/{owner}/{repo}/events/{event}`. ``hub.callback``|`string` | The URI to receive the updates to the topic. ``hub.secret``|`string` | A shared secret key that generates a hash signature of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the {% ifversion fpt or ghes or ghec %}`X-Hub-Signature` or `X-Hub-Signature-256` headers{% elsif ghae %}`X-Hub-Signature-256` header{% endif %}. You can see [the PubSubHubbub documentation](https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify) for more details. + + + diff --git a/content/rest/webhooks/repo-config.md b/content/rest/webhooks/repo-config.md index 2371eb524b..55f5831b94 100644 --- a/content/rest/webhooks/repo-config.md +++ b/content/rest/webhooks/repo-config.md @@ -10,5 +10,9 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- + + + diff --git a/content/rest/webhooks/repo-deliveries.md b/content/rest/webhooks/repo-deliveries.md index 3ebf56765e..f76b096bcc 100644 --- a/content/rest/webhooks/repo-deliveries.md +++ b/content/rest/webhooks/repo-deliveries.md @@ -10,5 +10,9 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- + + + diff --git a/content/rest/webhooks/repos.md b/content/rest/webhooks/repos.md index fb757185d2..a9516ec4c6 100644 --- a/content/rest/webhooks/repos.md +++ b/content/rest/webhooks/repos.md @@ -10,5 +10,9 @@ topics: - API miniTocMaxHeadingLevel: 3 allowTitleToDifferFromFilename: true +autogenerated: true --- + + + diff --git a/lib/frontmatter.js b/lib/frontmatter.js index 6e27c7108b..2108e53240 100644 --- a/lib/frontmatter.js +++ b/lib/frontmatter.js @@ -231,6 +231,9 @@ export const schema = { 'ms.locfileid': { type: 'string', }, + autogenerated: { + type: 'boolean', + }, }, }