[nasirudeenbadirudeen87-cloud]

Summary

• Add a Scalar-powered interactive API reference and a linked error catalogue to the VitePress docs site.
• Disable request execution and API-client downloads in the reference.
• Validate and copy docs/api/openapi.json during docs sync; fail clearly if the file is absent or is not a valid OpenAPI 3.x document.
• Keep the existing endpoint table as a narrative overview.

Closes #134

Dependency

This is a draft pending issue #112 / PR #184, which provides the OpenAPI generator and generated docs/api/openapi.json. The sync step intentionally fails until that dependency lands, so this branch is not ready to merge yet.

[drips-wave]

@nasirudeenbadirudeen87-cloud Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

[github-actions]

✅ Malware scan: clean

The earlier findings are resolved as of 3c88e56.

[afeezorobsco-cyber]

@nasirudeenbadirudeen87-cloud Thanks. I reviewed this by hand: the malware scan's HIGH flag on ApiReference.vue is a false positive (a Vue component legitimately contains a <script> block). The scanner fix is in #212, and I'll re-scan this PR once that merges. @scalar/api-reference checks out too.

One blocker before this can merge: the new code in docs/site/scripts/sync-docs.mjs throws if docs/api/openapi.json is missing, and that file isn't on main yet (it's generated by the OpenAPI work in #184, which is still open). Core PR CI doesn't build the docs site, so CI would stay green, but merging this first would break the docs deploy on main. Please either:

• wait for feat(api): generate OpenAPI 3.1 spec from Zod schemas with CI drift check #184 to land and rebase onto it, or
• make the interactive page degrade gracefully when the spec is absent (skip the copy with a warning and show a "spec not generated yet" note), and keep the hard failure for a spec that is present but invalid.

Also, please run cd docs/site && npm run build locally and confirm it passes before pushing.