Skip to content

OpenAPI specification

The /v1 contract is generated from the code itself — it is not a hand-written description that can drift from actual behavior. You can fetch the full OpenAPI 3.1 document (paths, parameters, request and response schemas) at any time with:

GET https://api.hodeishield.com/v1/openapi.json

That path requires no authentication and always reflects the deployed version.

How to use it

  • Swagger UI / Redoc: point the tool at the URL above to browse the spec interactively.
  • Client generators (openapi-generator, orval, …): generate a typed client in your language directly from the document.
  • Postman / Insomnia: import the URL as a collection to try the operations without writing code.

What this page is NOT

The operations table in this guide summarizes the contract for human reading; the document generated at /v1/openapi.json is the authoritative source and takes precedence over any summary if the two disagree.