Skip to content

fix(0116): Making server owned field nullable is breaking #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lovisaberggren merged 2 commits into from
Mar 9, 2026
+5 −1
Merged

fix(0116): Making server owned field nullable is breaking #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
869d4b2
fix(0116): Making server owned field nullable is breaking
lovisaberggren Mar 6, 2026
75ad17c
fix: lint
lovisaberggren Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion ipa/general/0111.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ state-driven clients. These clients are often unable to tell when their desired
state matches the current state for these fields, as the rules by which a server
may modify and return values are complex, not public, and not repeatable.

:::warning[State]
:::info[State]

Adopt

Expand All @@ -28,6 +28,9 @@ Fields **must** have a single owner, whether that is the client or the server.
- In OpenAPI, server-owned fields **must** have `readOnly: true`
- Server-owned fields **must not** be accepted in request bodies for
[Create](0106.md) or [Update](0107.md) operations
- Server-owned fields **may** be omitted if appropriate to the API
- API Producers **should** document whether the server-owned field is
guaranteed, or if it can be omitted in the response
- **Client-owned fields** are fields that are controlled by the client
- All fields that are not explicitly documented as server-owned **must** be
considered client-owned
Expand Down
1 change: 1 addition & 0 deletions ipa/general/0116.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Changes considered breaking include:
- New required fields **must not** be added to an existing version of an API
- Optional fields **must not** be removed from the request or response of an
existing version of an API version
- Guaranteed output fields **must not** be omitted (become nullable)
- Existing API components **must not** be renamed or removed from an existing
version of an API
- Default values provided for a field **must not** change
Expand Down