Skip to content

chore(docs): add docusaurus-plugin-openapi-docs , part 2 #118

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
merged 3 commits into from
Jun 13, 2025
Merged

chore(docs): add docusaurus-plugin-openapi-docs , part 2 #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ece5a1a
Add 'npm run gen-api-docs-all' to 'build' target
b-long Jun 13, 2025
fc0c5d5
Extract 'OUTPUT_PREFIX' variable
b-long Jun 13, 2025
f89e896
Set 'docs/OpenAPI-clients' as OUTPUT_PREFIX
b-long Jun 13, 2025
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
2 changes: 1 addition & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
specs-processed/
docs/SDK-OpenAPI/
docs/OpenAPI-clients/
docs/SDK-Samples/

# Dependencies
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "docusaurus build",
"build": "npm run gen-api-docs-all && docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
Expand Down
15 changes: 9 additions & 6 deletions preprocessing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ import type * as OpenApiPlugin from "docusaurus-plugin-openapi-docs";
// Boolean to control whether we add '[Preprocessed on' timestamp ']' to the description
const ADD_TIMESTAMP_TO_DESCRIPTION = false;

// The location prefix of built OpenAPI documentation
const OUTPUT_PREFIX = 'docs/OpenAPI-clients';

// Read BUILD_OPENAPI_SAMPLES once
const BUILD_OPENAPI_SAMPLES = process.env.BUILD_OPENAPI_SAMPLES === '1';

Expand All @@ -28,7 +31,7 @@ let openApiSpecsArray: ApiSpecDefinition[] = [
{
id: "Well-Known Configuration",
specPath: "./specs/wellknownconfiguration/wellknown_configuration.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/wellknownconfiguration",
outputDir: `${OUTPUT_PREFIX}/wellknownconfiguration`,
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "info",
Expand All @@ -37,7 +40,7 @@ let openApiSpecsArray: ApiSpecDefinition[] = [
{
id: "V1 Authorization",
specPath: "./specs/authorization/authorization.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/authorization/v1",
outputDir: `${OUTPUT_PREFIX}/authorization/v1`,
// specPathModified is auto-generated if not specified
sidebarOptions: {
groupPathsBy: "tag",
Expand All @@ -47,7 +50,7 @@ let openApiSpecsArray: ApiSpecDefinition[] = [
{
id: "V2 Authorization",
specPath: "./specs/authorization/v2/authorization.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/authorization/v2",
outputDir: `${OUTPUT_PREFIX}/authorization/v2`,
// Example of custom modified path:
specPathModified: "./specs-processed/authorization/v2/authorization.openapi.yaml",
sidebarOptions: {
Expand All @@ -58,7 +61,7 @@ let openApiSpecsArray: ApiSpecDefinition[] = [
{
id: "V1 Entity Resolution",
specPath: "./specs/entityresolution/entity_resolution.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/entityresolution/v1",
outputDir: `${OUTPUT_PREFIX}/entityresolution/v1`,
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "info",
Expand All @@ -67,7 +70,7 @@ let openApiSpecsArray: ApiSpecDefinition[] = [
{
id: "V2 Entity Resolution",
specPath: "./specs/entityresolution/v2/entity_resolution.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/entityresolution/v2",
outputDir: `${OUTPUT_PREFIX}/entityresolution/v2`,
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "info",
Expand All @@ -76,7 +79,7 @@ let openApiSpecsArray: ApiSpecDefinition[] = [
{
id: "kas",
specPath: "./specs/kas/kas.openapi.yaml",
outputDir: "docs/SDK-OpenAPI/kas",
outputDir: `${OUTPUT_PREFIX}/kas`,
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "info",
Expand Down