docs/content/rest
Sarah Edwards d2a2113c11
REST new user guidance (#29642)
2022-08-23 19:31:01 +00:00
..
actions
activity
apps
branches
checks
codespaces
collaborators
commits
dependabot
dependency-graph
deployments
enterprise-admin
gists
git
guides
interactions
issues
metrics
migrations
orgs
overview
projects
pulls
releases
repos
teams
users
webhooks
README.md
billing.md
code-scanning.md
codes-of-conduct.md
deploy-keys.md
emojis.md
gitignore.md
index.md
licenses.md
markdown.md
meta.md
oauth-authorizations.md
packages.md
pages.md
quickstart.md
rate-limit.md
reactions.md
scim.md
search.md
secret-scanning.md

README.md

REST

The /content/rest directory is where the GitHub REST API docs live!

  • The /content/rest/guides and /content/rest/overview directories contain regular articles. These are human-editable.

  • The /content/rest/reference directory contains an article for each group of endpoints in the GitHub REST API. Most of the content in this directory is rendered using include tags.

    The content rendered by include tags is sourced from the /lib/rest/static directory, which is automatically generated from the API source code internally in GitHub, and should not be edited by a human. For more information, see the /lib/rest/README.md.

    We cannot accept changes to content that is rendered by include tags. However, you can open an issue describing the changes you would like to see.