Repo sync

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 %}

content/rest/overview/about-the-openapi-description-for-the-rest-api.md → 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

content/rest/overview/api-versions.md → 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

content/rest/overview/breaking-changes.md → 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

content/rest/overview/comparing-githubs-rest-api-and-graphql-api.md → 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: '*'

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
+---
+
+<!-- Content after this section is automatically generated -->

content/rest/overview/authenticating-to-the-rest-api.md → 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: '*'

content/rest/overview/endpoints-available-for-fine-grained-personal-access-tokens.md → 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
 ---
 
 <!-- The content of this page is rendered as a NextJS page component. -->

content/rest/overview/endpoints-available-for-github-app-installation-access-tokens.md → 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: '*'

content/rest/overview/endpoints-available-for-github-app-user-access-tokens.md → 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
 ---
 
 

content/rest/overview/index.md → 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
 ---
-

content/rest/overview/keeping-your-api-credentials-secure.md → content/rest/authentication/keeping-your-api-credentials-secure.md

@@ -1,14 +1,16 @@
 ---
 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: '*'
   ghae: '*'
   ghec: '*'
 topics:
   - API
+redirect_from:
+  - /rest/overview/keeping-your-api-credentials-secure
 ---
 
 ## Choose an appropriate authentication method

content/rest/overview/permissions-required-for-fine-grained-personal-access-tokens.md → 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 %}

content/rest/overview/permissions-required-for-github-apps.md → 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: '*'

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

content/rest/index.md

@@ -1,43 +1,45 @@
 ---
 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: '*'
   ghae: '*'
   ghec: '*'
 children:
   - /quickstart
-  - /overview
+  - /about-the-rest-api
+  - /using-the-rest-api
+  - /authentication
   - /guides
   - /actions
   - /activity

content/rest/guides/best-practices-for-using-the-rest-api.md → 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: '*'

content/rest/guides/getting-started-with-the-rest-api.md → 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

content/rest/overview/github-event-types.md → 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: '*'

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
+---

content/rest/overview/issue-event-types.md → 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: '*'

content/rest/overview/libraries-for-the-rest-api.md → 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: '*'

content/rest/overview/media-types.md → 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: '*'

content/rest/overview/rate-limits-for-the-rest-api.md → 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 %}

content/rest/overview/resources-in-the-rest-api.md → 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: '*'

content/rest/overview/troubleshooting-the-rest-api.md → 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: '*'

content/rest/guides/using-pagination-in-the-rest-api.md → 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: '*'

src/fixtures/fixtures/content/rest/overview/index.md → 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
 ---