Skip to content

fix(docs): build API doc fallback slugs the way docusaurus-openapi-docs does #45897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
villebro merged 1 commit into from
Oct 30, 2026
Merged

fix(docs): build API doc fallback slugs the way docusaurus-openapi-docs does #45897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions docs/scripts/generate-api-index.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import fs from 'fs';
import path from 'path';
import { createRequire } from 'module';
import { fileURLToPath } from 'url';
import kebabCase from 'lodash/kebabCase.js';

const require = createRequire(import.meta.url);
const __dirname = path.dirname(fileURLToPath(import.meta.url));
Expand Down Expand Up @@ -129,12 +130,9 @@ function buildSlugMap() {
return labelToSlug;
}

function slugify(text) {
return text
.toLowerCase()
.replace(/[^a-z0-9]+/g, '-')
.replace(/(^-|-$)/g, '');
}
// Same algorithm docusaurus-openapi-docs uses to name the endpoint pages, so a
// fallback slug matches the generated page (e.g. "OAuth2" -> "o-auth-2").
const slugify = text => kebabCase(text);

function main() {
console.log(`Reading OpenAPI spec from ${SPEC_PATH}`);
Expand Down
10 changes: 4 additions & 6 deletions docs/scripts/generate-api-tag-pages.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import fs from 'fs';
import path from 'path';
import { createRequire } from 'module';
import { fileURLToPath } from 'url';
import kebabCase from 'lodash/kebabCase.js';

const require = createRequire(import.meta.url);
const __dirname = path.dirname(fileURLToPath(import.meta.url));
Expand All @@ -43,12 +44,9 @@ const SPEC_PATH = path.join(
const API_DOCS_DIR = path.join(__dirname, '..', 'developer_docs', 'api');
const SIDEBAR_PATH = path.join(API_DOCS_DIR, 'sidebar.js');

function slugify(text) {
return text
.toLowerCase()
.replace(/[^a-z0-9]+/g, '-')
.replace(/(^-|-$)/g, '');
}
// Same algorithm docusaurus-openapi-docs uses to name the endpoint pages, so a
// fallback slug matches the generated page (e.g. "OAuth2" -> "o-auth-2").
const slugify = text => kebabCase(text);

/**
* Build a map from sidebar label → doc slug by reading the generated sidebar.
Expand Down
Loading