links on /rest/overview/endpoints (#25771)

* links on /rest/overview/endpoints-available-for-github-apps

* tests

* remove unused code

Author: peterbe

content/rest/overview/endpoints-available-for-github-apps.md

@@ -14,19 +14,4 @@ topics:
 shortTitle: GitHub App-enabled endpoints
 ---
 
-You must use an installation access token to access endpoints using your {% data variables.product.prodname_github_app %}. For more information, see "[Authenticating with {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)."
-
-{% for thing in rest.operationsEnabledForGitHubApps[currentVersion] %}
-{% assign category = thing[0] %}
-{% assign operations = thing[1] %}
-{% if operations.size > 0 %}
-  <h3 id="{{category}}">
-    <a href="#{{category}}">{{ category }}</a>
-  </h3>  
-  <ul>
-  {% for operation in operations %}
-  <li><a href="/{{currentLanguage}}/rest/reference/{{operation.category}}#{{operation.slug}}"><code><span style="text-transform: uppercase">{{operation.verb}}</span> {{operation.requestPath}}</code></a></li>
-  {% endfor %}
-  </ul>
-{% endif %}
-{% endfor %}
+**The content of this page is rendered as a NextJS page component.**

pages/[versionId]/rest/overview/endpoints-available-for-github-apps.tsx

@@ -1,11 +1,13 @@
 import { GetServerSideProps } from 'next'
+import { useRouter } from 'next/router'
 import { MainContextT, MainContext, getMainContext } from 'components/context/MainContext'
 import {
   getArticleContextFromRequest,
   ArticleContextT,
   ArticleContext,
 } from 'components/context/ArticleContext'
 import { ArticlePage } from 'components/article/ArticlePage'
+import { Link } from 'components/Link'
 import { getEnabledForApps } from 'lib/rest/index.js'
 
 type OperationT = {
@@ -27,31 +29,27 @@ let enabledForApps: AppDataT | null = null
 type Props = {
   mainContext: MainContextT
   enabledForApps: EnabledAppCategoryT
-  userLanguage: string
   articleContext: ArticleContextT
 }
 
-export default function Category({
-  mainContext,
-  enabledForApps,
-  userLanguage,
-  articleContext,
-}: Props) {
-  const content = Object.keys(enabledForApps).map((category: string, index: Number) => (
-    <div key={`enabledAppCategory-${index}`}>
-      {enabledForApps[category].length > 0 ? (
+export default function Category({ mainContext, enabledForApps, articleContext }: Props) {
+  const { locale } = useRouter()
+
+  const content = Object.entries(enabledForApps).map(([category, operations]) => (
+    <div key={`enabledAppCategory-${category}`}>
+      {operations.length > 0 && (
         <h3 id={category}>
-          <a href={category}>{category}</a>
+          <Link href={`/${locale}/rest/reference/${category}`}>{category}</Link>
         </h3>
-      ) : null}
+      )}
       <ul>
-        {enabledForApps[category].map((operation: OperationT, index: Number) => (
-          <li key={`enabledAppOperation-${index}`}>
-            <a href={`${userLanguage}/rest/reference/${category}#${operation.slug}`}>
+        {operations.map((operation) => (
+          <li key={`enabledAppOperation-${operation.slug}`}>
+            <Link href={`/${locale}/rest/reference/${category}#${operation.slug}`}>
               <code>
                 <span className="text-uppercase">{operation.verb}</span> {operation.requestPath}
               </code>
-            </a>
+            </Link>
           </li>
         ))}
       </ul>
@@ -72,7 +70,6 @@ export const getServerSideProps: GetServerSideProps<Props> = async (context) =>
   const res = context.res as object
   const currentVersion = context.query.versionId as string
   const mainContext = getMainContext(req, res)
-  const userLanguage = context.locale || ''
 
   if (!enabledForApps) {
     enabledForApps = (await getEnabledForApps()) as AppDataT
@@ -82,7 +79,6 @@ export const getServerSideProps: GetServerSideProps<Props> = async (context) =>
     props: {
       mainContext,
       enabledForApps: enabledForApps[currentVersion],
-      userLanguage,
       articleContext: getArticleContextFromRequest(req),
     },
   }

tests/rendering/rest.js

@@ -70,11 +70,11 @@ describe('REST references docs', () => {
       const schemaSlugs = []
       // using the static file, generate the expected slug for each operation
       for (const [key, value] of Object.entries(enableForApps[version])) {
-        schemaSlugs.push(...value.map((item) => `en/rest/reference/${key}#${item.slug}`))
+        schemaSlugs.push(...value.map((item) => `/en/rest/reference/${key}#${item.slug}`))
       }
       // get all of the href attributes in the anchor tags
       const $ = await getDOM(`/en/${version}/rest/overview/endpoints-available-for-github-apps`)
-      const domH3Ids = $('a')
+      const domH3Ids = $('#article-contents a')
         .map((i, a) => $(a).attr('href'))
         .get()
       expect(schemaSlugs.every((slug) => domH3Ids.includes(slug))).toBe(true)