Skip to content

docs(api): say that a request body refuses a property it does not declare - #39

Merged
mokevnin merged 1 commit into
mainfrom
docs/closed-request-bodies
Nov 16, 2026
Merged

mokevnin merged 1 commit into
mainfrom
docs/closed-request-bodies

Conversation

@mokevnin

Copy link
Copy Markdown
Contributor

The API now refuses a request body property it does not declare, at any depth, with a 400 whose errors names the property's path (getsphericon/sphericon#1486). Responses stay open (getsphericon/sphericon#1488).

  • The 400 row of the guide's status table now covers an unknown property.
  • A paragraph with an example problem says which maps stay open (customFields, properties, variables) and that a client ignores a response property it does not know.

🤖 Generated with Claude Code

…lare

A request body of the API is a closed object at every depth: a property it does not declare is a
400 whose `errors` names the property's path, not a field silently ignored. The maps whose keys are
the caller's stay open, and so do responses, which a later release may add properties to.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mokevnin
mokevnin merged commit 8e2314d into main Nov 16, 2026
2 checks passed
@mokevnin
mokevnin deleted the docs/closed-request-bodies branch November 16, 2026 03:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant