Skip to Content
API Changelog

API changelog

The shipped OpenAPI document (same as GET /openapi.json on a running API) is version 0.1.0 (IDeliver API).

How we version today

  • Source of truth: apps/api/src/openapi.ts — edit there, then run npm run openapi:dump --workspace=@ideliver/api.
  • Consumer checks: npm run test:openapi-consumer-contract and npm run test:consumer-contract in CI.
  • SDKs: npm run codegen:sdk at repo root refreshes packages/sdk-node and packages/sdk-php.
  • Docs snippets: npm run codegen:snippets refreshes apps/web-docs/generated/snippets.json.

Automation

This page is generated by scripts/generate-api-changelog.mjs. Run it after dumping OpenAPI (e.g. npm run codegen:docs-artifacts at repo root).

Last generated from openapi.snapshot.json.