Skip to content

format api sidebards and remove unused sections #115

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
b-long merged 1 commit into from
Jun 12, 2025
Merged

format api sidebards and remove unused sections #115

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
50 changes: 16 additions & 34 deletions preprocessing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,57 +26,48 @@ interface ApiSpecDefinition {
// Define all your OpenAPI specifications here
let openApiSpecsArray: ApiSpecDefinition[] = [
{
id: "authorization",
specPath: "./specs/authorization/authorization.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/authorization",
// specPathModified is auto-generated if not specified
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag",
},
},
{
id: "authorization_v2",
specPath: "./specs/authorization/v2/authorization.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/authorization_v2",
// Example of custom modified path:
specPathModified: "./specs-processed/authorization/v2/authorization.openapi.yaml",
id: "Well-Known Configuration",
specPath: "./specs/wellknownconfiguration/wellknown_configuration.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/wellknownconfiguration",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag",
},
},
{
id: "common",
specPath: "./specs/common/common.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/common",
id: "V1 Authorization",
specPath: "./specs/authorization/authorization.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/authorization/v1",
// specPathModified is auto-generated if not specified
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag",
},
},
{
id: "entity",
specPath: "./specs/entity/entity.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/entity",
id: "V2 Authorization",
specPath: "./specs/authorization/v2/authorization.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/authorization/v2",
// Example of custom modified path:
specPathModified: "./specs-processed/authorization/v2/authorization.openapi.yaml",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag",
},
},
{
id: "entityresolution",
id: "V1 Entity Resolution",
specPath: "./specs/entityresolution/entity_resolution.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/entityresolution",
outputDir: "docs/SDK-OpenAPI/entityresolution/v1",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag",
},
},
{
id: "entityresolution_v2",
id: "V2 Entity Resolution",
specPath: "./specs/entityresolution/v2/entity_resolution.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/entityresolution_v2",
outputDir: "docs/SDK-OpenAPI/entityresolution/v2",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag",
Expand All @@ -91,15 +82,6 @@ let openApiSpecsArray: ApiSpecDefinition[] = [
categoryLinkSource: "tag",
},
},
{
id: "wellknownconfiguration",
specPath: "./specs/wellknownconfiguration/wellknown_configuration.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/wellknownconfiguration",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag",
},
},
// Add more entries here for other OpenAPI specs
];

Expand Down