ref(docs): Respect x-internal openapi spec attribute (#38255)

apps/docs/spec/common-api-sections.json

@@ -196,12 +196,6 @@
         "slug": "v1-apply-a-migration",
         "type": "operation"
       },
-      {
-        "id": "v1-create-restore-point",
-        "title": "Create restore point",
-        "slug": "v1-create-restore-point",
-        "type": "operation"
-      },
       {
         "id": "v1-disable-readonly-mode-temporarily",
         "title": "Disable readonly mode temporarily",
@@ -256,12 +250,6 @@
         "slug": "v1-get-readonly-mode-status",
         "type": "operation"
       },
-      {
-        "id": "v1-get-restore-point",
-        "title": "Get restore point",
-        "slug": "v1-get-restore-point",
-        "type": "operation"
-      },
       {
         "id": "v1-get-ssl-enforcement-config",
         "title": "Get ssl enforcement config",
@@ -310,12 +298,6 @@
         "slug": "v1-setup-a-read-replica",
         "type": "operation"
       },
-      {
-        "id": "v1-undo",
-        "title": "Undo",
-        "slug": "v1-undo",
-        "type": "operation"
-      },
       {
         "id": "v1-update-pooler-config",
         "title": "Update pooler config",
@@ -538,12 +520,6 @@
         "slug": "v1-exchange-oauth-token",
         "type": "operation"
       },
-      {
-        "id": "v1-oauth-authorize-project-claim",
-        "title": "Oauth authorize project claim",
-        "slug": "v1-oauth-authorize-project-claim",
-        "type": "operation"
-      },
       {
         "id": "v1-revoke-token",
         "title": "Revoke token",
@@ -556,12 +532,6 @@
     "type": "category",
     "title": "Organizations",
     "items": [
-      {
-        "id": "v1-claim-project-for-organization",
-        "title": "Claim project for organization",
-        "slug": "v1-claim-project-for-organization",
-        "type": "operation"
-      },
       {
         "id": "v1-create-an-organization",
         "title": "Create an organization",
@@ -574,12 +544,6 @@
         "slug": "v1-get-an-organization",
         "type": "operation"
       },
-      {
-        "id": "v1-get-organization-project-claim",
-        "title": "Get organization project claim",
-        "slug": "v1-get-organization-project-claim",
-        "type": "operation"
-      },
       {
         "id": "v1-list-all-organizations",
         "title": "List all organizations",
@@ -610,12 +574,6 @@
         "slug": "v1-create-a-project",
         "type": "operation"
       },
-      {
-        "id": "v1-create-project-claim-token",
-        "title": "Create project claim token",
-        "slug": "v1-create-project-claim-token",
-        "type": "operation"
-      },
       {
         "id": "v1-delete-a-project",
         "title": "Delete a project",
@@ -628,12 +586,6 @@
         "slug": "v1-delete-network-bans",
         "type": "operation"
       },
-      {
-        "id": "v1-delete-project-claim-token",
-        "title": "Delete project claim token",
-        "slug": "v1-delete-project-claim-token",
-        "type": "operation"
-      },
       {
         "id": "v1-get-network-restrictions",
         "title": "Get network restrictions",
@@ -658,12 +610,6 @@
         "slug": "v1-get-project",
         "type": "operation"
       },
-      {
-        "id": "v1-get-project-claim-token",
-        "title": "Get project claim token",
-        "slug": "v1-get-project-claim-token",
-        "type": "operation"
-      },
       {
         "id": "v1-get-services-health",
         "title": "Get services health",

apps/docs/spec/sections/generateMgmtApiSections.cts

@@ -41,6 +41,12 @@ function extractSectionsFromOpenApi(filePath, outputPath) {
         for (const route in openApiJson.paths) {
           const methods = openApiJson.paths[route]
           for (const method in methods) {
+            // We are using `x-internal` to hide endpoints from the docs,
+            // but still have them included in the spec so they generate types and can be used.
+            if (methods[method]['x-internal']) {
+              continue
+            }
+
             const tag = methods[method].tags?.[0]
             const operationId = methods[method].operationId
             // If operationId is not in the form of a slug ignore it.