Repository navigation
Stop mandating an error format; mandate the error conditions - #7
Merged
Merged
Conversation
SPEC §8 required RFC 9457 Problem Details with media type application/problem+json. That is a wire-format requirement on an API's whole error surface, imposed by a predicate grammar that has no business there: an API with an established error envelope had to carry a second one for a single endpoint. What a client actually branches on is *which* of the five conditions failed — malformed-query, unknown-field, unsupported-operator, invalid-operand, query-too-complex — so that, plus 400 Bad Request, is what §8 now requires. RFC 9457 stays as the RECOMMENDED default where an API has no format of its own, and the type URIs, `pointer` and the recovery members are unchanged as its encoding. Both worked examples still use it. This relaxes a requirement, so nothing that conformed before stops conforming. The schema is untouched and its $id still names v0.4.0. The rest of the repo follows: README §Errors and COMPARISON §4 no longer claim Problem Details is the format, the OpenAPI examples say in a comment that the shape they model is the recommended one rather than the required one, and prose that said "problem" now names the condition. Co-Authored-By: Claude <noreply@anthropic.com>
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.
SPEC §8 required RFC 9457 Problem Details with media type application/problem+json. That is a wire-format requirement on an API's whole error surface, imposed by a predicate grammar that has no business there: an API with an established error envelope had to carry a second one for a single endpoint.
What a client actually branches on is which of the five conditions failed — malformed-query, unknown-field, unsupported-operator, invalid-operand, query-too-complex — so that, plus 400 Bad Request, is what §8 now requires. RFC 9457 stays as the RECOMMENDED default where an API has no format of its own, and the type URIs,
pointerand the recovery members are unchanged as its encoding. Both worked examples still use it.This relaxes a requirement, so nothing that conformed before stops conforming. The schema is untouched and its $id still names v0.4.0.
The rest of the repo follows: README §Errors and COMPARISON §4 no longer claim Problem Details is the format, the OpenAPI examples say in a comment that the shape they model is the recommended one rather than the required one, and prose that said "problem" now names the condition.