Merge pull request #31153 from awanlin/docs/scaffolder-api-docs

Docs - Added Generated Scaffolder API Docs

microsite/docusaurus.config.ts

@@ -297,6 +297,11 @@ const config: Config = {
             specPath: '../plugins/search-backend/src/schema/openapi.yaml',
             outputDir: '../docs/features/search/api',
           } satisfies OpenApiPlugin.Options,
+          scaffolder: {
+            ...defaultOpenApiOptions,
+            specPath: '../plugins/scaffolder-backend/src/schema/openapi.yaml',
+            outputDir: '../docs/features/software-templates/api',
+          } satisfies OpenApiPlugin.Options,
         },
       },
     ],

microsite/sidebars.ts

@@ -14,6 +14,9 @@ const catalogSidebar = tryToLoadCustomSidebar(
 const searchSidebar = tryToLoadCustomSidebar(
   '../docs/features/search/api/sidebar.ts',
 );
+const scaffolderSidebar = tryToLoadCustomSidebar(
+  '../docs/features/software-templates/api/sidebar.ts',
+);
 
 export default {
   docs: {
@@ -229,6 +232,22 @@ export default {
           'features/software-templates/dry-run-testing',
           'features/software-templates/experimental',
           'features/software-templates/templating-extensions',
+          {
+            type: 'category',
+            label: 'API',
+            link:
+              scaffolderSidebar.length > 0
+                ? {
+                    type: 'generated-index',
+                    title: 'Scaffolder API',
+                    slug: '/category/scaffolder-api',
+                  }
+                : {
+                    type: 'doc',
+                    id: 'openapi/generated-docs/404',
+                  },
+            items: scaffolderSidebar,
+          },
         ],
       },
       {