Skip to content

Commit 520df1b

Browse files
committed
chore(changeset): the /docs viewer retirement ships as patch, a non-protocol change
The retirement changes what a REST caller is served, not what a metadata author can write, so the changeset declares Metadata-protocol: none and ships @objectstack/rest at patch. The BREAKING banner, the ADR-0087 disposition and the migration line stay. Claude-Session: https://claude.ai/code/session_01LmjU2x1faLZ39DVTFyVca6 Co-authored-by: Claude <noreply@anthropic.com>
1 parent 1379d30 commit 520df1b

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

‎.changeset/25104-rest-docs-viewer-retired.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
2-
'@objectstack/rest': minor
2+
'@objectstack/rest': patch
33
---
44

55
feat(rest)!: `GET {base}/docs`, the OpenAPI document's HTML viewer page, is retired; `GET {base}/openapi.json` stays
66

77
Clause-②: no (narrowing)
8+
Metadata-protocol: none
89

910
<!-- adr-0087: not-required (no-migration-prescription) A runtime route retirement in RestServer.registerOpenApiEndpoints, not a metadata change. No spec key, export, option, config field, response field or stored shape is removed, renamed or re-shaped: the page was an HTML answer on one REST path, and `objectstack migrate meta` has nothing to rewrite. The machine-readable document, its `api.enableOpenApi` gate and its answer are unchanged. The other categories are closed on facts: the package publishes (not unpublished); no ADR-0087 id covers this route and this diff adds none (not registered / already-registered); and no published interface or type changes (not runtime-interface-only / type-surface-only / runtime-export-retired). -->
1011

11-
**BREAKING** (a published route stops being served), shipped as `minor` under the launch-window convention for breaking changes.
12+
**BREAKING** (a published route stops being served), shipped as `patch` because it is a non-protocol change: it changes what a REST caller is served, not what a metadata author can write.
1213

1314
`RestServer.registerOpenApiEndpoints` mounted two routes on every base: the OpenAPI document and an HTML viewer page for it. The viewer page is retired on both route shapes, the unscoped `{base}/docs` and the environment-scoped `{base}/environments/:environmentId/docs`. Nothing read it, and the API origin serves no HTML viewer.
1415

0 commit comments

Comments
 (0)