pjandro/OmniRoute
1
0
Fork 0
mirror of https://github.com/diegosouzapw/OmniRoute.git synced 2026-07-31 04:12:10 +03:00
Code Issues Packages Projects Releases Wiki Activity

feat(api-docs): Redoc-rendered /api/docs + consolidate OpenAPI spec to docs/openapi.yaml (#4781)

Browse Source 
Redoc /api/docs + OpenAPI spec consolidated to docs/openapi.yaml (canonical 201-path complete spec; old path → legacy fallback). All refs/gates/tests/CI updated. Integrated into release/v3.8.35.
This commit is contained in:
KooshaPari
2026-06-23 06:29:40 -07:00
committed by GitHub
parent 34a4645646
commit 463565c71a
94 changed files with 6923 additions and 110 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
scripts/docs/gen-openapi-module.mjs
View File

@@ -1,6 +1,6 @@
#!/usr/bin/env node
/**
* gen-openapi-module.mjs — build helper that reads docs/reference/openapi.yaml,
* gen-openapi-module.mjs — build helper that reads docs/openapi.yaml,
* flattens the path/method matrix, and emits
* src/app/docs/lib/openapi.generated.ts so the Api Explorer client can
* iterate endpoints without parsing YAML at runtime.
@@ -23,7 +23,7 @@ import * as yaml from "js-yaml";
const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const ROOT = path.resolve(__dirname, "..", "..");
const OPENAPI_PATH = path.join(ROOT, "docs", "reference", "openapi.yaml");
const OPENAPI_PATH = path.join(ROOT, "docs", "openapi.yaml");
const OUT_PATH = path.join(ROOT, "src", "app", "docs", "lib", "openapi.generated.ts");
const HTTP_METHODS = ["get", "post", "put", "delete", "patch", "options", "head"];
@@ -108,7 +108,7 @@ async function main() {
const header = `// AUTO-GENERATED by scripts/docs/gen-openapi-module.mjs — DO NOT EDIT MANUALLY
// Regenerate with: node scripts/docs/gen-openapi-module.mjs
//
// Source of truth: docs/reference/openapi.yaml
// Source of truth: docs/openapi.yaml
//
// The Api Explorer consumes \`OPENAPI_ENDPOINTS\`; the spec metadata
// (\`OPENAPI_VERSION\`, \`OPENAPI_TITLE\`) is surfaced in the page header.