fix(problem)!: adding a problem code no longer changes an API's OpenAPI types - #6
Merged
Merged
Conversation
Merged
3 tasks done
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
humaproblem.Documentlisted every code as anenumonProblem.codeandFieldError.code. That made each new code a change to the OpenAPI document and to SDKs generated from it: strictly typed clients see a new enum value, and every branch that adds a code edits the same lines of a checked-in spec.RFC 9457 treats problem types as an open set, and clients here already fall back to the status for a code they don't know. So
codeis now an open string, documented as such, and the catalog at/problems/remains the list of codes.Breaking:
humaproblem.Documentis removed. Delete the call; nothing replaces it.Testing
make checkTestSchemaLeavesCodesOpenchecks neither schema has an enum and the default response is still problem+json.Checklist
make checkpassespackages/problem/src/messages/(none changed)