Remove Actions REST enterprise subcategory (moved to Actions page) (github#25065)

Co-authored-by: Rachael Sewell <[email protected]>

Author: lucascosti

.github/actions-scripts/openapi-schema-branch.js

@@ -36,7 +36,7 @@ const changedFiles = execSync('git diff --name-only HEAD').toString()
 if (changedFiles !== '') {
   console.log(`These files were changed:\n${changedFiles}`)
   console.log(
-    `🚧⚠️ Your decorated and dereferenced schema files don't match. Ensure you're using decorated and dereferenced schemas from the automatically created pull requests by the 'github-openapi-bot' user. \n\n If this test is failing after updates to the script/rest directory, run script/rest/update-files.js --decorate-only to re-generate the decorated files from the existing dereferenced files and check those in. \n\n If this test is failing after an update to a package, check the changes the new package makes to the decorated files by running script/rest/update-files.js --decorate-only. If the changes are small style changes that don't impact the overall experience, check the updated decorated file in. Otherwise, more work may be needed to be compatible with the updated package. \n\n For more information, see 'script/rest/README.md'. 🛑`
+    `🚧⚠️ Your decorated and dereferenced schema files don't match. Ensure you're using decorated and dereferenced schemas from the automatically created pull requests by the 'github-openapi-bot' user. \n\n If this test is failing after updates to the script/rest directory, run script/rest/update-files.js --decorate-only to re-generate the decorated files from the existing dereferenced files and check those in. \n\n If this test is failing after an update to a package, check the changes the new package makes to the decorated files by running script/rest/update-files.js --decorate-only.\n\nIf you updated script/rest/utils/rest-api-overrides.json, you'll need to run script/rest/update-files.js --decorate-only to regenerate the decorated file and redirects file (check in the changed lib/rest/static/decorated files).\n\nIf the changes are small style changes that don't impact the overall experience, check the updated decorated file in. Otherwise, more work may be needed to be compatible with the updated package. \n\n For more information, see 'script/rest/README.md'. 🛑`
   )
   process.exit(1)
 }

components/DefaultLayout.tsx

@@ -6,7 +6,7 @@ import { SmallFooter } from 'components/page-footer/SmallFooter'
 import { ScrollButton } from 'components/ui/ScrollButton'
 import { SupportSection } from 'components/page-footer/SupportSection'
 import { DeprecationBanner } from 'components/page-header/DeprecationBanner'
-import { RestRepoBanner } from 'components/page-header/RestRepoBanner'
+import { RestBanner } from 'components/page-header/RestBanner'
 import { useMainContext } from 'components/context/MainContext'
 import { useTranslation } from 'components/hooks/useTranslation'
 import { useRouter } from 'next/router'
@@ -89,7 +89,7 @@ export const DefaultLayout = (props: Props) => {
         <Header />
         <main id="main-content">
           <DeprecationBanner />
-          <RestRepoBanner />
+          <RestBanner />
 
           {props.children}
         </main>

components/article/ArticlePage.tsx

@@ -107,7 +107,11 @@ export const ArticlePage = () => {
     // In the future there might be more.
     // Hopefully, we can some day delete all of this and no longer
     // be dependent on the URL hash to do the redirect.
-    if (hash && pathname.endsWith('/rest/reference/repos')) {
+    if (
+      hash &&
+      (pathname.endsWith('/rest/reference/repos') ||
+        pathname.endsWith('/rest/reference/enterprise-admin'))
+    ) {
       setLoadClientsideRedirectExceptions(true)
     }
   }, [])

components/page-header/RestBanner.tsx

@@ -0,0 +1,81 @@
+import React from 'react'
+import { Flash } from '@primer/components'
+import { useRouter } from 'next/router'
+import { Link } from 'components/Link'
+
+const restRepoDisplayPages = [
+  '/rest/reference/branches',
+  '/rest/reference/collaborators',
+  '/rest/reference/commits',
+  '/rest/reference/deployments',
+  '/rest/reference/pages',
+  '/rest/reference/releases',
+  '/rest/reference/repos',
+  '/rest/reference/metrics',
+  '/rest/reference/webhooks',
+]
+const restEnterpriseDisplayPages = ['/rest/reference/enterprise-admin']
+const restRepoCategoryExceptionsTitles = {
+  branches: 'Branches',
+  collaborators: 'Collaborators',
+  commits: 'Commits',
+  deployments: 'Deployments',
+  pages: 'GitHub Pages',
+  releases: 'Releases',
+  metrics: 'Metrics',
+  webhooks: 'Webhooks',
+}
+
+export const RestBanner = () => {
+  const router = useRouter()
+  const restPage = (router.query.restPage as string[]) || []
+  const asPathRoot = `/${router.query.productId}/${restPage.join('/')}`
+  if (
+    !restRepoDisplayPages.includes(asPathRoot) &&
+    !restEnterpriseDisplayPages.includes(asPathRoot)
+  ) {
+    return null
+  }
+
+  let noticeString
+
+  if (restRepoDisplayPages.includes(asPathRoot)) {
+    const pages = Object.keys(restRepoCategoryExceptionsTitles) as Array<
+      keyof typeof restRepoCategoryExceptionsTitles
+    >
+    const newRestPagesText = pages.map((page, i) => [
+      <React.Fragment key={page}>
+        <Link href={`/${router.locale}/rest/reference/${page}`}>
+          {restRepoCategoryExceptionsTitles[page]}
+        </Link>
+        {i < pages.length - 1 && ', '}
+      </React.Fragment>,
+    ])
+
+    noticeString = (
+      <React.Fragment>
+        If you can't find what you're looking for, you might try the new {newRestPagesText} REST API
+        pages.
+      </React.Fragment>
+    )
+  } else if (restEnterpriseDisplayPages.includes(asPathRoot)) {
+    noticeString = (
+      <React.Fragment>
+        If you can't find what you're looking for, you might try the{' '}
+        <Link href={`/${router.locale}/rest/reference/actions`}>Actions</Link> REST API page.
+      </React.Fragment>
+    )
+  }
+
+  return (
+    <div data-testid="rest-api-repos-banner" className="container-xl mt-3 mx-auto p-responsive">
+      <Flash variant="warning">
+        <p>
+          <b className="text-bold">
+            <span>We've recently moved some of the REST API documentation. {noticeString}</span>
+          </b>{' '}
+        </p>
+      </Flash>
+    </div>
+  )
+}

components/page-header/RestRepoBanner.tsx

@@ -85,7 +85,7 @@ You can add self-hosted runners at the organization level, where they can be use
 New runners are assigned to the default group. You can modify the runner's group after you've registered the runner. For more information, see "[Managing access to self-hosted runners](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)."
 
 {% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %}
-To add a self-hosted runner to an enterprise account, you must be an enterprise owner. For information about how to add a self-hosted runner with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions).
+To add a self-hosted runner to an enterprise account, you must be an enterprise owner. For information about how to add a self-hosted runner with the REST API,  see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runners).
 
 {% data reusables.enterprise-accounts.access-enterprise %}
 {% data reusables.enterprise-accounts.policies-tab %}

content/actions/hosting-your-own-runners/adding-self-hosted-runners.md

@@ -96,6 +96,6 @@ To  authenticate using a {% data variables.product.prodname_dotcom %} App, it mu
 - For repositories, assign the `administration` permission.
 - For organizations, assign the `organization_self_hosted_runners` permission.
 
-You can register and delete enterprise self-hosted runners using [the API](/rest/reference/enterprise-admin#github-actions). To authenticate to the API, your autoscaling implementation can use an access token.
+You can register and delete enterprise self-hosted runners using [the API](/rest/reference/actions#self-hosted-runners). To authenticate to the API, your autoscaling implementation can use an access token.
 
 Your access token will require the `manage_runners:enterprise` scope.

content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md

@@ -87,7 +87,7 @@ When creating a group, you must choose a policy that defines which repositories
 
 ## Creating a self-hosted runner group for an enterprise
 
-Enterprises can add their self-hosted runners to groups for access management. Enterprises can create groups of self-hosted runners that are accessible to specific organizations in the enterprise account. Organization admins can then assign additional granular repository access policies to the enterprise runner groups. For information about how to create a self-hosted runner group with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions).
+Enterprises can add their self-hosted runners to groups for access management. Enterprises can create groups of self-hosted runners that are accessible to specific organizations in the enterprise account. Organization admins can then assign additional granular repository access policies to the enterprise runner groups. For information about how to create a self-hosted runner group with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runner-groups).
 
 Self-hosted runners are automatically assigned to the default group when created, and can only be members of one group at a time. You can assign the runner to a specific group during the registration process, or you can later move the runner from the default group to a custom group.
 

content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md

@@ -85,7 +85,7 @@ If you use {% data variables.product.prodname_ghe_cloud %}, you can also remove
 
 {% endnote %}
 
-To remove a self-hosted runner from an enterprise, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see the [Enterprise Administration GitHub Actions APIs](/rest/reference/enterprise-admin#github-actions).
+To remove a self-hosted runner from an enterprise, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/reference/actions#self-hosted-runners).
 
 {% data reusables.github-actions.self-hosted-runner-reusing %}
 {% ifversion ghec or ghes > 3.3 or ghae-issue-5091 %}

content/actions/hosting-your-own-runners/removing-self-hosted-runners.md

@@ -33,9 +33,7 @@ The Artifacts API allows you to download, delete, and retrieve information about
 {% ifversion fpt or ghes > 2.22 or ghae or ghec %}
 ## Permissions
 
-The Permissions API allows you to set permissions for what organizations and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions 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 %}
-
-You can also set permissions for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#github-actions)" REST API.
+The Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions 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 %}
 
 {% for operation in currentRestOperations %}
   {% if operation.subcategory == 'permissions' %}{% include rest_operation %}{% endif %}
@@ -58,9 +56,7 @@ The Secrets API lets you create, update, delete, and retrieve information about
 
 The Self-hosted Runners API allows you to register, view, and delete self-hosted runners. {% 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 or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to the repository or organization to use this API.
-
-You can manage self-hosted runners for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#github-actions)" REST API.
+{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_apps %} must have the `administration` permission for repositories 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 this API.
 
 {% for operation in currentRestOperations %}
   {% if operation.subcategory == 'self-hosted-runners' %}{% include rest_operation %}{% endif %}
@@ -72,9 +68,7 @@ You can manage self-hosted runners for an enterprise. For more information, see
 
 The Self-hosted Runners Groups API allows you manage groups of self-hosted runners. 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 the repository or organization to use this API.
-
-You can manage self-hosted runner groups for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin##github-actions)" REST API.
+{% 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 this API.
 
 {% for operation in currentRestOperations %}
   {% if operation.subcategory == 'self-hosted-runner-groups' %}{% include rest_operation %}{% endif %}