diff --git a/content/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md b/content/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md index ae54e9437d74..a474c2f2b691 100644 --- a/content/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md +++ b/content/apps/github-marketplace/using-the-github-marketplace-api-in-your-app/rest-endpoints-for-the-github-marketplace-api.md @@ -32,6 +32,6 @@ See these pages for details on how to authenticate when using the {% data variab {% note %} -**Note:** [Rate limits for the REST API](/rest/overview/rate-limits-for-the-rest-api) apply to all {% data variables.product.prodname_marketplace %} API endpoints. +**Note:** [Rate limits for the REST API](/rest/using-the-rest-api/rate-limits-for-the-rest-api) apply to all {% data variables.product.prodname_marketplace %} API endpoints. {% endnote %} diff --git a/content/rest/overview/about-the-openapi-description-for-the-rest-api.md b/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md similarity index 97% rename from content/rest/overview/about-the-openapi-description-for-the-rest-api.md rename to content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md index 7afa6d06f3ec..a3d04d7015b3 100644 --- a/content/rest/overview/about-the-openapi-description-for-the-rest-api.md +++ b/content/rest/about-the-rest-api/about-the-openapi-description-for-the-rest-api.md @@ -10,6 +10,7 @@ topics: - API redirect_from: - /rest/overview/openapi-description + - /rest/overview/about-the-openapi-description-for-the-rest-api --- ## About OpenAPI diff --git a/content/rest/overview/api-versions.md b/content/rest/about-the-rest-api/api-versions.md similarity index 98% rename from content/rest/overview/api-versions.md rename to content/rest/about-the-rest-api/api-versions.md index 9cb4ea02f20c..e767e7fd7262 100644 --- a/content/rest/overview/api-versions.md +++ b/content/rest/about-the-rest-api/api-versions.md @@ -4,6 +4,8 @@ shortTitle: API Versions intro: Learn how to specify which REST API version to use whenever you make a request to the REST API. versions: feature: api-date-versioning +redirect_from: + - /rest/overview/api-versions --- ## About API versioning diff --git a/content/rest/overview/breaking-changes.md b/content/rest/about-the-rest-api/breaking-changes.md similarity index 96% rename from content/rest/overview/breaking-changes.md rename to content/rest/about-the-rest-api/breaking-changes.md index 684729e4642e..619c3b9a2249 100644 --- a/content/rest/overview/breaking-changes.md +++ b/content/rest/about-the-rest-api/breaking-changes.md @@ -4,6 +4,8 @@ shortTitle: Breaking changes intro: Learn about breaking changes that were introduced in each REST API version. versions: feature: api-date-versioning +redirect_from: + - /rest/overview/breaking-changes --- ## About breaking changes in the REST API diff --git a/content/rest/overview/comparing-githubs-rest-api-and-graphql-api.md b/content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md similarity index 98% rename from content/rest/overview/comparing-githubs-rest-api-and-graphql-api.md rename to content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md index 4b66784181a1..5a676627702a 100644 --- a/content/rest/overview/comparing-githubs-rest-api-and-graphql-api.md +++ b/content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md @@ -8,6 +8,7 @@ redirect_from: - /github/extending-github/getting-started-with-the-api - /developers/overview/about-githubs-apis - /rest/overview/about-githubs-apis + - /rest/overview/comparing-githubs-rest-api-and-graphql-api versions: fpt: '*' ghes: '*' diff --git a/content/rest/about-the-rest-api/index.md b/content/rest/about-the-rest-api/index.md new file mode 100644 index 000000000000..4ecfeadf3479 --- /dev/null +++ b/content/rest/about-the-rest-api/index.md @@ -0,0 +1,19 @@ +--- +title: About the REST API +intro: 'Learn more about the {% data variables.product.prodname_dotcom %} REST API and what you can do with it.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +children: + - /comparing-githubs-rest-api-and-graphql-api + - /api-versions + - /breaking-changes + - /about-the-openapi-description-for-the-rest-api +autogenerated: rest +--- + + diff --git a/content/rest/overview/authenticating-to-the-rest-api.md b/content/rest/authentication/authenticating-to-the-rest-api.md similarity index 99% rename from content/rest/overview/authenticating-to-the-rest-api.md rename to content/rest/authentication/authenticating-to-the-rest-api.md index 4636a96d4855..1d34f2af4475 100644 --- a/content/rest/overview/authenticating-to-the-rest-api.md +++ b/content/rest/authentication/authenticating-to-the-rest-api.md @@ -4,6 +4,7 @@ intro: You can authenticate to the REST API to access more endpoints and have a redirect_from: - /v3/auth - /rest/overview/other-authentication-methods + - /rest/overview/authenticating-to-the-rest-api versions: fpt: '*' ghes: '*' diff --git a/content/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens.md b/content/rest/authentication/endpoints-available-for-fine-grained-personal-access-tokens.md similarity index 68% rename from content/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens.md rename to content/rest/authentication/endpoints-available-for-fine-grained-personal-access-tokens.md index daa5c382a8af..c3cdc9b21e3f 100644 --- a/content/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens.md +++ b/content/rest/authentication/endpoints-available-for-fine-grained-personal-access-tokens.md @@ -3,8 +3,10 @@ title: Endpoints available for fine-grained personal access tokens intro: 'Your {% data variables.product.pat_v2 %} can make requests to the following REST endpoints.' versions: feature: pat-v2 -shortTitle: 'Endpoints for fine-grained PATs' +shortTitle: Endpoints for fine-grained PATs autogenerated: github-apps +redirect_from: + - /rest/overview/endpoints-available-for-fine-grained-personal-access-tokens --- diff --git a/content/rest/overview/endpoints-available-for-github-app-installation-access-tokens.md b/content/rest/authentication/endpoints-available-for-github-app-installation-access-tokens.md similarity index 91% rename from content/rest/overview/endpoints-available-for-github-app-installation-access-tokens.md rename to content/rest/authentication/endpoints-available-for-github-app-installation-access-tokens.md index a9409a9b2291..9397d5b3958d 100644 --- a/content/rest/overview/endpoints-available-for-github-app-installation-access-tokens.md +++ b/content/rest/authentication/endpoints-available-for-github-app-installation-access-tokens.md @@ -7,6 +7,7 @@ redirect_from: - /v3/apps/available-endpoints - /rest/reference/endpoints-available-for-github-apps - /rest/overview/endpoints-available-for-github-apps + - /rest/overview/endpoints-available-for-github-app-installation-access-tokens versions: fpt: '*' ghes: '*' diff --git a/content/rest/overview/endpoints-available-for-github-app-user-access-tokens.md b/content/rest/authentication/endpoints-available-for-github-app-user-access-tokens.md similarity index 76% rename from content/rest/overview/endpoints-available-for-github-app-user-access-tokens.md rename to content/rest/authentication/endpoints-available-for-github-app-user-access-tokens.md index b6672fda18ee..b2970dd1f632 100644 --- a/content/rest/overview/endpoints-available-for-github-app-user-access-tokens.md +++ b/content/rest/authentication/endpoints-available-for-github-app-user-access-tokens.md @@ -1,7 +1,7 @@ --- title: Endpoints available for GitHub App user access tokens shortTitle: Endpoints for GitHub App user tokens -intro: 'Your GitHub App can make requests to the following REST endpoints with a user access token.' +intro: Your GitHub App can make requests to the following REST endpoints with a user access token. permissions: 'You can use a user access token to access these endpoints using your {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)."' versions: fpt: '*' @@ -12,6 +12,8 @@ topics: - API - GitHub Apps autogenerated: github-apps +redirect_from: + - /rest/overview/endpoints-available-for-github-app-user-access-tokens --- diff --git a/content/rest/overview/index.md b/content/rest/authentication/index.md similarity index 50% rename from content/rest/overview/index.md rename to content/rest/authentication/index.md index 1fa5e8699b09..ef89d85e04ce 100644 --- a/content/rest/overview/index.md +++ b/content/rest/authentication/index.md @@ -1,7 +1,7 @@ --- -title: REST API overview -shortTitle: Overview -intro: 'Learn about resources, libraries, previews and troubleshooting for {% data variables.product.prodname_dotcom %}''s REST API.' +title: Authenticating to the REST API +shortTitle: Authentication +intro: 'Learn how to authenticate your REST API requests.' versions: fpt: '*' ghes: '*' @@ -10,25 +10,11 @@ versions: topics: - API children: - - /comparing-githubs-rest-api-and-graphql-api - - /resources-in-the-rest-api - - /rate-limits-for-the-rest-api - - /api-versions - - /media-types - /authenticating-to-the-rest-api - /keeping-your-api-credentials-secure - - /troubleshooting-the-rest-api - - /libraries-for-the-rest-api - - /about-the-openapi-description-for-the-rest-api - - /issue-event-types - - /github-event-types - /endpoints-available-for-github-app-installation-access-tokens - /endpoints-available-for-github-app-user-access-tokens - /endpoints-available-for-fine-grained-personal-access-tokens - /permissions-required-for-github-apps - /permissions-required-for-fine-grained-personal-access-tokens - - /breaking-changes -redirect_from: - - /developers/overview --- - diff --git a/content/rest/overview/keeping-your-api-credentials-secure.md b/content/rest/authentication/keeping-your-api-credentials-secure.md similarity index 97% rename from content/rest/overview/keeping-your-api-credentials-secure.md rename to content/rest/authentication/keeping-your-api-credentials-secure.md index 95f6b39c6dc3..d0d3b0188c43 100644 --- a/content/rest/overview/keeping-your-api-credentials-secure.md +++ b/content/rest/authentication/keeping-your-api-credentials-secure.md @@ -1,7 +1,7 @@ --- title: Keeping your API credentials secure shortTitle: Keeping API credentials secure -intro: 'Follow these best practices to keep your API credentials and tokens secure.' +intro: Follow these best practices to keep your API credentials and tokens secure. versions: fpt: '*' ghes: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' topics: - API +redirect_from: + - /rest/overview/keeping-your-api-credentials-secure --- ## Choose an appropriate authentication method diff --git a/content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md b/content/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens.md similarity index 89% rename from content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md rename to content/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens.md index 4d65c545beb2..1a701245ce03 100644 --- a/content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md +++ b/content/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens.md @@ -3,8 +3,10 @@ title: Permissions required for fine-grained personal access tokens intro: 'These are the permissions required for a {% data variables.product.pat_v2 %} to use each REST API endpoint that works with {% data variables.product.pat_v2 %}s.' versions: feature: pat-v2 -shortTitle: 'Permissions for fine-grained PATs' +shortTitle: Permissions for fine-grained PATs autogenerated: github-apps +redirect_from: + - /rest/overview/permissions-required-for-fine-grained-personal-access-tokens --- ## About permissions required for {% data variables.product.pat_v2 %} diff --git a/content/rest/overview/permissions-required-for-github-apps.md b/content/rest/authentication/permissions-required-for-github-apps.md similarity index 96% rename from content/rest/overview/permissions-required-for-github-apps.md rename to content/rest/authentication/permissions-required-for-github-apps.md index 3f1ad9cbc437..4e9d7aa54a9d 100644 --- a/content/rest/overview/permissions-required-for-github-apps.md +++ b/content/rest/authentication/permissions-required-for-github-apps.md @@ -4,6 +4,7 @@ intro: 'These are the permissions required for a {% data variables.product.prodn redirect_from: - /v3/apps/permissions - /rest/reference/permissions-required-for-github-apps + - /rest/overview/permissions-required-for-github-apps versions: fpt: '*' ghes: '*' diff --git a/content/rest/guides/index.md b/content/rest/guides/index.md index c2ec86152c7e..d77919954ed8 100644 --- a/content/rest/guides/index.md +++ b/content/rest/guides/index.md @@ -12,16 +12,13 @@ versions: topics: - API children: - - /getting-started-with-the-rest-api - /scripting-with-the-rest-api-and-javascript - /scripting-with-the-rest-api-and-ruby - /discovering-resources-for-a-user - /delivering-deployments - /rendering-data-as-graphs - /working-with-comments - - /using-pagination-in-the-rest-api - /building-a-ci-server - - /best-practices-for-using-the-rest-api - /using-the-rest-api-to-interact-with-your-git-database - /using-the-rest-api-to-interact-with-checks - /encrypting-secrets-for-the-rest-api diff --git a/content/rest/index.md b/content/rest/index.md index 59946f3169c2..12a94b71f6ec 100644 --- a/content/rest/index.md +++ b/content/rest/index.md @@ -1,35 +1,35 @@ --- title: GitHub REST API documentation shortTitle: REST API -intro: >- - To create integrations, retrieve data, and automate your workflows, build with - the {% data variables.product.prodname_dotcom %} REST API. +intro: 'Create integrations, retrieve data, and automate your workflows with the {% data variables.product.prodname_dotcom %} REST API.' introLinks: quickstart: /rest/quickstart - overview: /rest/guides/getting-started-with-the-rest-api + overview: /rest/using-the-rest-api/getting-started-with-the-rest-api featuredLinks: startHere: - - /rest/guides/getting-started-with-the-rest-api - - /rest/overview/authenticating-to-the-rest-api - - /rest/guides/best-practices-for-using-the-rest-api - - /rest/guides/using-pagination-in-the-rest-api + - /rest/using-the-rest-api/getting-started-with-the-rest-api + - /rest/authentication/authenticating-to-the-rest-api + - /rest/using-the-rest-api/best-practices-for-using-the-rest-api + - /rest/using-the-rest-api/using-pagination-in-the-rest-api popular: - - /rest/overview/rate-limits-for-the-rest-api - - /rest/overview/api-versions - - /rest/overview/authenticating-to-the-rest-api - - /rest/overview/troubleshooting-the-rest-api + - /rest/using-the-rest-api/rate-limits-for-the-rest-api + - /rest/about-the-rest-api/api-versions + - /rest/authentication/authenticating-to-the-rest-api + - /rest/using-the-rest-api/troubleshooting-the-rest-api - /rest/guides/scripting-with-the-rest-api-and-javascript - - /rest/overview/keeping-your-api-credentials-secure + - /rest/authentication/keeping-your-api-credentials-secure guideCards: - /rest/guides/delivering-deployments - /rest/guides/using-the-rest-api-to-interact-with-checks - - /rest/guides/using-pagination-in-the-rest-api + - /rest/using-the-rest-api/using-pagination-in-the-rest-api changelog: label: 'api, apis' layout: product-landing redirect_from: - /v3 - /rest/reference + - /rest/overview + - /developers/overview versions: fpt: '*' ghes: '*' @@ -37,7 +37,9 @@ versions: ghec: '*' children: - /quickstart - - /overview + - /about-the-rest-api + - /using-the-rest-api + - /authentication - /guides - /actions - /activity diff --git a/content/rest/guides/best-practices-for-using-the-rest-api.md b/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md similarity index 99% rename from content/rest/guides/best-practices-for-using-the-rest-api.md rename to content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md index 0cec5eaf8734..e22bd616376c 100644 --- a/content/rest/guides/best-practices-for-using-the-rest-api.md +++ b/content/rest/using-the-rest-api/best-practices-for-using-the-rest-api.md @@ -5,6 +5,7 @@ redirect_from: - /guides/best-practices-for-integrators - /v3/guides/best-practices-for-integrators - /rest/guides/best-practices-for-integrators + - /rest/guides/best-practices-for-using-the-rest-api versions: fpt: '*' ghes: '*' diff --git a/content/rest/guides/getting-started-with-the-rest-api.md b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md similarity index 99% rename from content/rest/guides/getting-started-with-the-rest-api.md rename to content/rest/using-the-rest-api/getting-started-with-the-rest-api.md index aa7dc9790d36..39843d734456 100644 --- a/content/rest/guides/getting-started-with-the-rest-api.md +++ b/content/rest/using-the-rest-api/getting-started-with-the-rest-api.md @@ -1,6 +1,6 @@ --- title: Getting started with the REST API -shortTitle: Using the API +shortTitle: Getting started intro: 'Learn how to use the {% data variables.product.prodname_dotcom %} REST API.' versions: fpt: '*' @@ -9,6 +9,8 @@ versions: ghec: '*' topics: - API +redirect_from: + - /rest/guides/getting-started-with-the-rest-api --- ## Introduction diff --git a/content/rest/overview/github-event-types.md b/content/rest/using-the-rest-api/github-event-types.md similarity index 99% rename from content/rest/overview/github-event-types.md rename to content/rest/using-the-rest-api/github-event-types.md index 958462a5cae6..ec241435b105 100644 --- a/content/rest/overview/github-event-types.md +++ b/content/rest/using-the-rest-api/github-event-types.md @@ -7,6 +7,7 @@ redirect_from: - /developers/webhooks-and-events/events/github-event-types - /webhooks-and-events/events/github-event-types - /developers/webhooks-and-events/events + - /rest/overview/github-event-types versions: fpt: '*' ghes: '*' diff --git a/content/rest/using-the-rest-api/index.md b/content/rest/using-the-rest-api/index.md new file mode 100644 index 000000000000..3a4755645bec --- /dev/null +++ b/content/rest/using-the-rest-api/index.md @@ -0,0 +1,22 @@ +--- +title: Using the REST API +intro: 'Learn how to use the {% data variables.product.prodname_dotcom %} REST API, follow best practices, and troubleshoot problems.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - API +children: + - /getting-started-with-the-rest-api + - /rate-limits-for-the-rest-api + - /resources-in-the-rest-api + - /using-pagination-in-the-rest-api + - /libraries-for-the-rest-api + - /media-types + - /best-practices-for-using-the-rest-api + - /troubleshooting-the-rest-api + - /issue-event-types + - /github-event-types +--- diff --git a/content/rest/overview/issue-event-types.md b/content/rest/using-the-rest-api/issue-event-types.md similarity index 99% rename from content/rest/overview/issue-event-types.md rename to content/rest/using-the-rest-api/issue-event-types.md index 121c4fed8f1b..b36926590cd2 100644 --- a/content/rest/overview/issue-event-types.md +++ b/content/rest/using-the-rest-api/issue-event-types.md @@ -6,6 +6,7 @@ redirect_from: - /developers/webhooks-and-events/issue-event-types - /developers/webhooks-and-events/events/issue-event-types - /webhooks-and-events/events/issue-event-types + - /rest/overview/issue-event-types versions: fpt: '*' ghes: '*' diff --git a/content/rest/overview/libraries-for-the-rest-api.md b/content/rest/using-the-rest-api/libraries-for-the-rest-api.md similarity index 99% rename from content/rest/overview/libraries-for-the-rest-api.md rename to content/rest/using-the-rest-api/libraries-for-the-rest-api.md index 7fea288445d3..78f7705c9b76 100644 --- a/content/rest/overview/libraries-for-the-rest-api.md +++ b/content/rest/using-the-rest-api/libraries-for-the-rest-api.md @@ -6,6 +6,7 @@ redirect_from: - /libraries - /v3/libraries - /rest/overview/libraries + - /rest/overview/libraries-for-the-rest-api versions: fpt: '*' ghes: '*' diff --git a/content/rest/overview/media-types.md b/content/rest/using-the-rest-api/media-types.md similarity index 99% rename from content/rest/overview/media-types.md rename to content/rest/using-the-rest-api/media-types.md index a577a59d72a2..1e978757e3bd 100644 --- a/content/rest/overview/media-types.md +++ b/content/rest/using-the-rest-api/media-types.md @@ -3,6 +3,7 @@ title: Media types intro: Learn about media types for specifying the format of the data you want to consume. redirect_from: - /v3/media + - /rest/overview/media-types versions: fpt: '*' ghes: '*' diff --git a/content/rest/overview/rate-limits-for-the-rest-api.md b/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md similarity index 99% rename from content/rest/overview/rate-limits-for-the-rest-api.md rename to content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md index 42b314e33fd1..6fcaab4c98f7 100644 --- a/content/rest/overview/rate-limits-for-the-rest-api.md +++ b/content/rest/using-the-rest-api/rate-limits-for-the-rest-api.md @@ -9,6 +9,8 @@ versions: ghec: '*' topics: - API +redirect_from: + - /rest/overview/rate-limits-for-the-rest-api --- {% ifversion ghes %} diff --git a/content/rest/overview/resources-in-the-rest-api.md b/content/rest/using-the-rest-api/resources-in-the-rest-api.md similarity index 99% rename from content/rest/overview/resources-in-the-rest-api.md rename to content/rest/using-the-rest-api/resources-in-the-rest-api.md index e6b887f102fa..8904961ba10a 100644 --- a/content/rest/overview/resources-in-the-rest-api.md +++ b/content/rest/using-the-rest-api/resources-in-the-rest-api.md @@ -3,6 +3,7 @@ title: Resources in the REST API intro: 'Learn how to navigate the resources provided by the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API.' redirect_from: - /rest/initialize-the-repo + - /rest/overview/resources-in-the-rest-api versions: fpt: '*' ghes: '*' diff --git a/content/rest/overview/troubleshooting-the-rest-api.md b/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md similarity index 99% rename from content/rest/overview/troubleshooting-the-rest-api.md rename to content/rest/using-the-rest-api/troubleshooting-the-rest-api.md index 3a855334c804..75345d452a5f 100644 --- a/content/rest/overview/troubleshooting-the-rest-api.md +++ b/content/rest/using-the-rest-api/troubleshooting-the-rest-api.md @@ -5,6 +5,7 @@ intro: Learn how to diagnose and resolve common problems for the REST API. redirect_from: - /v3/troubleshooting - /rest/overview/troubleshooting + - /rest/overview/troubleshooting-the-rest-api versions: fpt: '*' ghes: '*' diff --git a/content/rest/guides/using-pagination-in-the-rest-api.md b/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md similarity index 99% rename from content/rest/guides/using-pagination-in-the-rest-api.md rename to content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md index 832d07bf1582..c1487dd2692e 100644 --- a/content/rest/guides/using-pagination-in-the-rest-api.md +++ b/content/rest/using-the-rest-api/using-pagination-in-the-rest-api.md @@ -5,6 +5,7 @@ redirect_from: - /guides/traversing-with-pagination - /v3/guides/traversing-with-pagination - /rest/guides/traversing-with-pagination + - /rest/guides/using-pagination-in-the-rest-api versions: fpt: '*' ghes: '*' diff --git a/src/fixtures/fixtures/content/rest/overview/about-githubs-apis.md b/src/fixtures/fixtures/content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md similarity index 100% rename from src/fixtures/fixtures/content/rest/overview/about-githubs-apis.md rename to src/fixtures/fixtures/content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md diff --git a/src/fixtures/fixtures/content/rest/overview/index.md b/src/fixtures/fixtures/content/rest/about-the-rest-api/index.md similarity index 84% rename from src/fixtures/fixtures/content/rest/overview/index.md rename to src/fixtures/fixtures/content/rest/about-the-rest-api/index.md index 3562c0e09636..36340c4bbdcf 100644 --- a/src/fixtures/fixtures/content/rest/overview/index.md +++ b/src/fixtures/fixtures/content/rest/about-the-rest-api/index.md @@ -8,5 +8,5 @@ versions: ghae: '*' ghec: '*' children: - - /about-githubs-apis + - /comparing-githubs-rest-api-and-graphql-api --- diff --git a/src/fixtures/fixtures/content/rest/index.md b/src/fixtures/fixtures/content/rest/index.md index 678acad855d3..e591e8931b27 100644 --- a/src/fixtures/fixtures/content/rest/index.md +++ b/src/fixtures/fixtures/content/rest/index.md @@ -5,10 +5,10 @@ intro: >- To create integrations, retrieve data, and automate your workflows, build with the {% data variables.product.prodname_dotcom %} REST API. introLinks: - quickstart: /rest/overview + quickstart: /rest featuredLinks: popular: - - /rest/overview/about-githubs-apis + - /rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api changelog: label: 'api, apis' layout: product-landing @@ -18,7 +18,7 @@ versions: ghae: '*' ghec: '*' children: - - /overview + - /about-the-rest-api - /actions --- diff --git a/src/fixtures/fixtures/rest-redirects.json b/src/fixtures/fixtures/rest-redirects.json index 9178ef1db688..94540bc4a297 100644 --- a/src/fixtures/fixtures/rest-redirects.json +++ b/src/fixtures/fixtures/rest-redirects.json @@ -393,7 +393,7 @@ "/v3/actions/workflow-jobs": "/en/rest/actions/workflow-jobs", "/v3/actions/workflow-runs": "/en/rest/actions/workflow-runs", "/v3/actions/workflows": "/en/rest/actions/workflows", - "/v3/activity/event_types": "/en/rest/overview/github-event-types", + "/v3/activity/event_types": "/en/rest/using-the-rest-api/github-event-types", "/v3/activity/events/types": "/en/webhooks/webhook-events-and-payloads", "/v3/activity/events": "/en/rest/activity/events", "/v3/activity/feeds": "/en/rest/activity/feeds", @@ -401,12 +401,12 @@ "/v3/activity/notifications": "/en/rest/activity/notifications", "/v3/activity/starring": "/en/rest/activity/starring", "/v3/activity/watching": "/en/rest/activity/watching", - "/v3/apps/available-endpoints": "/en/rest/overview/endpoints-available-for-github-app-installation-access-tokens", + "/v3/apps/available-endpoints": "/en/rest/authentication/endpoints-available-for-github-app-installation-access-tokens", "/v3/apps": "/en/rest/apps", "/v3/apps/installations": "/en/rest/apps/installations", "/v3/apps/marketplace": "/en/rest/apps/marketplace", "/v3/apps/oauth_applications": "/en/rest/apps/oauth-applications", - "/v3/apps/permissions": "/en/rest/overview/permissions-required-for-github-apps", + "/v3/apps/permissions": "/en/rest/authentication/permissions-required-for-github-apps", "/v3/checks": "/en/rest/checks", "/v3/checks/runs": "/en/rest/checks/runs", "/v3/checks/suites": "/en/rest/checks/suites", @@ -440,7 +440,7 @@ "/v3/issues/comments": "/en/rest/issues/comments", "/v3/issues/events": "/en/rest/issues/events", "/v3/issues": "/en/rest/issues", - "/v3/issues/issue-event-types": "/en/rest/overview/issue-event-types", + "/v3/issues/issue-event-types": "/en/rest/using-the-rest-api/issue-event-types", "/v3/issues/labels": "/en/rest/issues/labels", "/v3/issues/milestones": "/en/rest/issues/milestones", "/v3/issues/timeline": "/en/rest/issues/timeline", diff --git a/src/fixtures/tests/playwright-a11y.spec.ts b/src/fixtures/tests/playwright-a11y.spec.ts index 6813db989d0c..44957ed7e560 100644 --- a/src/fixtures/tests/playwright-a11y.spec.ts +++ b/src/fixtures/tests/playwright-a11y.spec.ts @@ -13,7 +13,7 @@ const pages: { [key: string]: string } = { productLanding: '/code-security', restCategory: '/rest/actions/artifacts', restLanding: '/rest', - restOverview: '/rest/overview/about-githubs-apis', + restOverview: '/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api', search: '/search?q=playwright', switchers: '/get-started/liquid/tool-platform-switcher', tableWithHeaders: '/get-started/liquid/table-row-headers', diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 81ea3eedec7e..4ef0ef64dc6e 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -1,5 +1,5 @@ { - "targetDirectory": "content/rest/overview", + "targetDirectory": "content/rest/authentication", "pages": { "server-to-server-rest": { "frontmatterDefaults": { @@ -11,7 +11,7 @@ }, "autogenerated": "github-apps" }, - "targetFilename": "content/rest/overview/endpoints-available-for-github-app-installation-access-tokens.md" + "targetFilename": "content/rest/authentication/endpoints-available-for-github-app-installation-access-tokens.md" }, "user-to-server-rest": { "frontmatterDefaults": { @@ -23,7 +23,7 @@ }, "autogenerated": "github-apps" }, - "targetFilename": "content/rest/overview/endpoints-available-for-github-app-user-access-tokens.md" + "targetFilename": "content/rest/authentication/endpoints-available-for-github-app-user-access-tokens.md" }, "server-to-server-permissions": { "frontmatterDefaults": { @@ -35,21 +35,21 @@ }, "autogenerated": "github-apps" }, - "targetFilename": "content/rest/overview/permissions-required-for-github-apps.md" + "targetFilename": "content/rest/authentication/permissions-required-for-github-apps.md" }, "fine-grained-pat": { "frontmatterDefaults": { "versions": "data/features/pat-v2.yml", "autogenerated": "github-apps" }, - "targetFilename": "content/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens.md" + "targetFilename": "content/rest/authentication/endpoints-available-for-fine-grained-personal-access-tokens.md" }, "fine-grained-pat-permissions": { "frontmatterDefaults": { "versions": "data/features/pat-v2.yml", "autogenerated": "github-apps" }, - "targetFilename": "content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md" + "targetFilename": "content/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens.md" } }, "api-versions": { diff --git a/src/pages/[versionId]/rest/overview/[...restPage].tsx b/src/pages/[versionId]/rest/about-the-rest-api/[...restPage].tsx similarity index 100% rename from src/pages/[versionId]/rest/overview/[...restPage].tsx rename to src/pages/[versionId]/rest/about-the-rest-api/[...restPage].tsx diff --git a/src/pages/[versionId]/rest/overview/index.tsx b/src/pages/[versionId]/rest/about-the-rest-api/index.tsx similarity index 100% rename from src/pages/[versionId]/rest/overview/index.tsx rename to src/pages/[versionId]/rest/about-the-rest-api/index.tsx diff --git a/src/pages/[versionId]/rest/authentication/[...restPage].tsx b/src/pages/[versionId]/rest/authentication/[...restPage].tsx new file mode 100644 index 000000000000..3544355f3fb1 --- /dev/null +++ b/src/pages/[versionId]/rest/authentication/[...restPage].tsx @@ -0,0 +1 @@ +export { default, getServerSideProps } from '../../[productId]/index' diff --git a/src/pages/[versionId]/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens.tsx b/src/pages/[versionId]/rest/authentication/endpoints-available-for-fine-grained-personal-access-tokens.tsx similarity index 100% rename from src/pages/[versionId]/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens.tsx rename to src/pages/[versionId]/rest/authentication/endpoints-available-for-fine-grained-personal-access-tokens.tsx diff --git a/src/pages/[versionId]/rest/overview/endpoints-available-for-github-app-installation-access-tokens.tsx b/src/pages/[versionId]/rest/authentication/endpoints-available-for-github-app-installation-access-tokens.tsx similarity index 100% rename from src/pages/[versionId]/rest/overview/endpoints-available-for-github-app-installation-access-tokens.tsx rename to src/pages/[versionId]/rest/authentication/endpoints-available-for-github-app-installation-access-tokens.tsx diff --git a/src/pages/[versionId]/rest/overview/endpoints-available-for-github-app-user-access-tokens.tsx b/src/pages/[versionId]/rest/authentication/endpoints-available-for-github-app-user-access-tokens.tsx similarity index 100% rename from src/pages/[versionId]/rest/overview/endpoints-available-for-github-app-user-access-tokens.tsx rename to src/pages/[versionId]/rest/authentication/endpoints-available-for-github-app-user-access-tokens.tsx diff --git a/src/pages/[versionId]/rest/authentication/index.tsx b/src/pages/[versionId]/rest/authentication/index.tsx new file mode 100644 index 000000000000..3544355f3fb1 --- /dev/null +++ b/src/pages/[versionId]/rest/authentication/index.tsx @@ -0,0 +1 @@ +export { default, getServerSideProps } from '../../[productId]/index' diff --git a/src/pages/[versionId]/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.tsx b/src/pages/[versionId]/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens.tsx similarity index 100% rename from src/pages/[versionId]/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.tsx rename to src/pages/[versionId]/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens.tsx diff --git a/src/pages/[versionId]/rest/overview/permissions-required-for-github-apps.tsx b/src/pages/[versionId]/rest/authentication/permissions-required-for-github-apps.tsx similarity index 100% rename from src/pages/[versionId]/rest/overview/permissions-required-for-github-apps.tsx rename to src/pages/[versionId]/rest/authentication/permissions-required-for-github-apps.tsx diff --git a/src/pages/[versionId]/rest/using-the-rest-api/[...restPage].tsx b/src/pages/[versionId]/rest/using-the-rest-api/[...restPage].tsx new file mode 100644 index 000000000000..3544355f3fb1 --- /dev/null +++ b/src/pages/[versionId]/rest/using-the-rest-api/[...restPage].tsx @@ -0,0 +1 @@ +export { default, getServerSideProps } from '../../[productId]/index' diff --git a/src/pages/[versionId]/rest/using-the-rest-api/index.tsx b/src/pages/[versionId]/rest/using-the-rest-api/index.tsx new file mode 100644 index 000000000000..3544355f3fb1 --- /dev/null +++ b/src/pages/[versionId]/rest/using-the-rest-api/index.tsx @@ -0,0 +1 @@ +export { default, getServerSideProps } from '../../[productId]/index' diff --git a/src/redirects/lib/static/redirect-exceptions.txt b/src/redirects/lib/static/redirect-exceptions.txt index 9b4c05dd1078..030054efae39 100644 --- a/src/redirects/lib/static/redirect-exceptions.txt +++ b/src/redirects/lib/static/redirect-exceptions.txt @@ -11,7 +11,7 @@ - /admin/enterprise-support/overview/about-github-premium-support-for-github-enterprise # FPT versioning was removed as part of github/docs-content#5166 -/rest/overview/resources-in-the-rest-api +/rest/using-the-rest-api/resources-in-the-rest-api - /rest/overview/api-previews /enterprise-server@latest/search-github/getting-started-with-searching-on-github/enabling-githubcom-repository-search-from-your-private-enterprise-environment diff --git a/src/rest/lib/config.js b/src/rest/lib/config.js index aab2e4510502..f72f164bc964 100644 --- a/src/rest/lib/config.js +++ b/src/rest/lib/config.js @@ -5,9 +5,15 @@ // in the JSON file. // These paths must match the paths in src/pages/[versionId]/rest -export const nonAutomatedRestPaths = ['/rest/guides', '/rest/quickstart', '/rest/overview'] +export const nonAutomatedRestPaths = [ + '/rest/quickstart', + '/rest/about-the-rest-api', + '/rest/using-the-rest-api', + '/rest/authentication', + '/rest/guides', +] // This path is used to set the page in the // src/rest/components/ApiVersionPicker.tsx component. That component // has a link to the page that describes what api versioning is. -export const apiVersionPath = '/rest/overview/api-versions' +export const apiVersionPath = '/rest/about-the-rest-api/api-versions' diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 7bd8e350ffff..c156cc2e61b5 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -34,10 +34,12 @@ "content/rest/index.md": { "startsWith": [ "quickstart", - "overview", + "about-the-rest-api", + "using-the-rest-api", + "authentication", "guides" ] } }, "sha": "1fd29675070876e3278e71b47f4f2606601bc698" -} \ No newline at end of file +} diff --git a/tests/fixtures/content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md b/tests/fixtures/content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md new file mode 100644 index 000000000000..c7af7b15be7b --- /dev/null +++ b/tests/fixtures/content/rest/about-the-rest-api/comparing-githubs-rest-api-and-graphql-api.md @@ -0,0 +1,13 @@ +--- +title: About GitHub's APIs +intro: 'Gentle and fun intro about APIs' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +--- + +## About {% data variables.product.company_short %}'s APIs + +First paragraph right here. diff --git a/tests/fixtures/content/rest/about-the-rest-api/index.md b/tests/fixtures/content/rest/about-the-rest-api/index.md new file mode 100644 index 000000000000..36340c4bbdcf --- /dev/null +++ b/tests/fixtures/content/rest/about-the-rest-api/index.md @@ -0,0 +1,12 @@ +--- +title: REST API overview +shortTitle: Overview +intro: 'Learn about resources, libraries, previews and troubleshooting for {% data variables.product.prodname_dotcom %}''s REST API.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +children: + - /comparing-githubs-rest-api-and-graphql-api +---