docs: a body naming a field the api does not have is a 400 - #69
Open
olavgg wants to merge 1 commit into
Open
Conversation
Platform PR #324 (feat(api): reject request bodies naming fields the api does not have) switches the request-body reader from dropping unknown properties to refusing them: a 400 problem document of type .../errors/unreadable-request-body with one errors entry per offender, each a JSON Pointer plus the names its position accepts. Malformed JSON answers with the same type, and a line and column. Two pages here still described the old behaviour as a trap. events.md said a client sending the retired relatedResourceIds names got a 200 with its relations silently dropped; datasets.md said the api drops unknown keys, so a filter still carrying writeProtected looked like it was narrowing and was not. Both now say the request is refused and link to a new section on the client page that documents the response shape once, since it applies to every endpoint that reads a JSON body. Verified: npm run build succeeds. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Signed-off-by: Olav Gjerde <olav@intellistream.ai>
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
1 participant
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.
Platform PR #324 (feat(api): reject request bodies naming fields the api does not have) switches the request-body reader from dropping unknown properties to refusing them: a 400 problem document of type .../errors/unreadable-request-body with one errors entry per offender, each a JSON Pointer plus the names its position accepts. Malformed JSON answers with the same type, and a line and column.
Two pages here still described the old behaviour as a trap. events.md said a client sending the retired relatedResourceIds names got a 200 with its relations silently dropped; datasets.md said the api drops unknown keys, so a filter still carrying writeProtected looked like it was narrowing and was not. Both now say the request is refused and link to a new section on the client page that documents the response shape once, since it applies to every endpoint that reads a JSON body.
Verified: npm run build succeeds.