Skip to content

OpenAPI Specification

Download the generated OpenAPI YAML or browse it in the Endpoint Explorer.

The authoritative source is freshly_cart_core/openapi/v1/openapi.yaml. This repository never maintains an independent copy. npm run sync:openapi reads $FRESHLYCART_CORE_PATH or the default sibling path, copies the contract, and records its SHA-256 checksum in generated/openapi/source.json.

The reference uses Scalar’s official Starlight integration. It supports OpenAPI 3.x, builds into the static site, needs no backend or mandatory hosted service, and is configured without live request execution.

CI builds from the checked generated artifact. A future approved read-only cross-repository GitHub mechanism can run npm run verify:openapi; personal tokens and unauthenticated private URLs are not accepted.