feat: OpenAPI spec

[leggetter]

TODO:

• Identify payloads that change based on type
• Add details for payloads based on type

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
outpost-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 14, 2025 0:03am
outpost-website	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 14, 2025 0:03am

[Copilot]

Copilot reviewed 3 out of 5 changed files in this pull request and generated no comments.

Files not reviewed (2)

• docs/pages/overview.mdx: Language not supported
• docs/pages/references/api.mdx: Language not supported

Comments suppressed due to low confidence (2)

docs/zudoku.config.ts:150

• Ensure that changing the sidebar API entry from type 'doc' to type 'link' is intentional and that the new configuration integrates correctly with the navigation system.

          {

README.md:11

• Confirm that the removal of the
  element does not adversely affect the intended layout or visual separation in the warning section.

-<br>

[leggetter]

@alexluong whilst creating the OpenAPI spec from the router, it seems that a lot of methods are mapped to the root of the API as well as /:tenantId. Which of these methods should we include in the OpenAPI spec and which should we hide as convenience methods? Or should we list everything for completeness?

See https://outpost-docs-git-feat-api-spec-hookdeck.vercel.app/docs/docs/api/health?_vercel_share=s3MpRPmywG67hbsA5fFUXoc59nGWElrx

Example for quick reference:

[alexluong]

Hmm it's a bit tricky to say. The ones which are mapped to root & tenants are root, with tenant being a helper endpoint for the portal.
I think we can just document the root ones since you don't really need the tenant ones. If you'd like, you can also mention it in the description or something if that helps?