Skip to content

docs(agents): record how to retire a published endpoint past the contract gate - #83

Open
ExtraToast wants to merge 1 commit into
mainfrom
docs/retiring-a-published-endpoint
Open

ExtraToast wants to merge 1 commit into
mainfrom
docs/retiring-a-published-endpoint

Conversation

@ExtraToast

Copy link
Copy Markdown
Contributor

Summary

Records the mechanic that let #79 go from 17 contract findings to zero, so the next person retiring a published endpoint does not have to rediscover it.

Nothing in the repo said how to remove an endpoint that oasdiff guards. The gate has no waiver, so the answer is procedural: deprecate in one PR, remove in the next, because the base only gains the deprecated: true marker once the first lands. A path absent from the base is then free to introduce in any shape.

Also records two smaller traps: a required header added to an existing endpoint is breaking even when the endpoint needs auth it never had (declare it optional and refuse on absence), and oasdiff's real behaviour is worth checking against the binary with two fixtures rather than reasoning from its documentation.

Validation

:api:ktlintCheck clean. Documentation only — no code, no spec, no workflow change.

Notes

refs #68

@ExtraToast ExtraToast added type: docs Documentation-only change. area: agents Agent runtime, agent APIs, tools, prompts, or UI. labels Sep 17, 2026
@ExtraToast ExtraToast self-assigned this Sep 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: agents Agent runtime, agent APIs, tools, prompts, or UI. type: docs Documentation-only change.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant