docs(agents): record how to retire a published endpoint past the contract gate - #83
Open
ExtraToast wants to merge 1 commit into
Open
ExtraToast wants to merge 1 commit into
ExtraToast wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
oasdiffguards. The gate has no waiver, so the answer is procedural: deprecate in one PR, remove in the next, because the base only gains thedeprecated: truemarker 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:ktlintCheckclean. Documentation only — no code, no spec, no workflow change.Notes
oasdiffagainst purpose-built fixtures: removing a deprecated path reports nothing, removing an undeprecated one reportsapi-path-removed-without-deprecation, and a brand-new path carrying a required header, a nullable property and a narrowermaxLengthreports nothing.refs #68