docs-mintlify/api-reference/api.yaml is stale against the current Console Server public OpenAPI spec.
The API standardized list responses on items + pageInfo, keeping data/count/pagination only as deprecated aliases, and gave every list endpoint first/after. The committed reference predates that:
DeploymentVersionsResponse is still documented as { data } — a field that no longer exists on that endpoint (it was reworked to items + pageInfo only, a deliberate break on an unreleased response).- ~30 list endpoints are missing
items, pageInfo, and the first/after query params.
Nothing in this repo's CI checks the reference for drift, so it went unnoticed. Regenerating touches api.yaml, docs.json, and introduction.mdx, which is why it was kept out of the Rust-only fix in #11582:
cd docs-mintlify && SRC_SPEC=/path/to/cubejs-enterprise/packages/console-server/open-api-spec-public-v3.1.yaml yarn api:extract
The spec is generated in cubejs-enterprise/packages/console-server via yarn generate:open-api:spec-public. yarn api:check verifies the committed artifacts without writing — worth wiring into CI here so this can't go stale again.
Context: #11582.
docs-mintlify/api-reference/api.yamlis stale against the current Console Server public OpenAPI spec.The API standardized list responses on
items+pageInfo, keepingdata/count/paginationonly as deprecated aliases, and gave every list endpointfirst/after. The committed reference predates that:DeploymentVersionsResponseis still documented as{ data }— a field that no longer exists on that endpoint (it was reworked toitems+pageInfoonly, a deliberate break on an unreleased response).items,pageInfo, and thefirst/afterquery params.Nothing in this repo's CI checks the reference for drift, so it went unnoticed. Regenerating touches
api.yaml,docs.json, andintroduction.mdx, which is why it was kept out of the Rust-only fix in #11582:The spec is generated in
cubejs-enterprise/packages/console-serverviayarn generate:open-api:spec-public.yarn api:checkverifies the committed artifacts without writing — worth wiring into CI here so this can't go stale again.Context: #11582.