Added Generated Scaffolder API Docs

Signed-off-by: Andre Wanlin <awanlin@spotify.com>
This commit is contained in:
Andre Wanlin
2025-09-15 15:50:51 -05:00
parent 89f191b72c
commit 391ce9fae5
2 changed files with 25 additions and 0 deletions
+5
View File
@@ -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,
},
},
],
+20
View File
@@ -14,6 +14,10 @@ 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 +233,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,
},
],
},
{