Skip to content

feat(ipa): Sharpen side-effect prohibition and require object response bodies in IPA-103 and IPA-004#58

Open
AgustinBettati wants to merge 1 commit into
mainfrom
CLOUDP-412564-ipa-103-side-effects-response-bodies
Open

feat(ipa): Sharpen side-effect prohibition and require object response bodies in IPA-103 and IPA-004#58
AgustinBettati wants to merge 1 commit into
mainfrom
CLOUDP-412564-ipa-103-side-effects-response-bodies

Conversation

@AgustinBettati

@AgustinBettati AgustinBettati commented Jun 12, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Summary

Two IPA-103 amendments plus the paired IPA-004 glossary alignment:

  • IPA-103 — side effects. Mutating client-owned fields of any resource other than the request target is a side effect; the dependent mutation must go through the dependent resource's own endpoint, or be modeled as a custom method when the operation is fundamentally multi-resource. Side effects limited to read-only or effective values of another resource may occur.
  • IPA-103 — Response bodies (new subsection). Every endpoint must support a versioned JSON content type; JSON response bodies must be objects with a fixed set of named properties at the root (no top-level arrays, primitives, or dynamic keys); collections use the standard envelope.
  • IPA-004 — Side Effects glossary updated to cover mutating client-owned fields of resources unrelated to the request target.

Part of the CLOUDP-356095 epic. Resolves CLOUDP-412564.

@AgustinBettati
feat(ipa): Sharpen side-effect prohibition and require object respons…
7d4c2d9 
…e bodies in IPA-103 and IPA-004

Clarifies that mutating client-owned fields of any resource other than
the request target is a side effect that must go through the dependent
resource's own endpoint or a custom method, and requires JSON response
bodies to be typed objects at the root so schema-based clients and
codegen can consume them. Aligns the IPA-004 Side Effects glossary entry
to cover cross-resource client-owned field mutation.

CLOUDP-412564
@AgustinBettati AgustinBettati force-pushed the CLOUDP-412564-ipa-103-side-effects-response-bodies branch from 2a20511 to 7d4c2d9 Compare June 12, 2026 14:15
@AgustinBettati AgustinBettati marked this pull request as ready for review June 12, 2026 14:36
@AgustinBettati AgustinBettati requested a review from a team as a code owner June 12, 2026 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wtrocki wtrocki Awaiting requested review from wtrocki wtrocki is a code owner automatically assigned from mongodb/apix-platform

@drinkbird drinkbird Awaiting requested review from drinkbird drinkbird is a code owner automatically assigned from mongodb/apix-platform

@andreaangiolillo andreaangiolillo Awaiting requested review from andreaangiolillo andreaangiolillo is a code owner automatically assigned from mongodb/apix-platform

@saisundar saisundar Awaiting requested review from saisundar saisundar is a code owner automatically assigned from mongodb/apix-platform

@matt-condon matt-condon Awaiting requested review from matt-condon matt-condon is a code owner automatically assigned from mongodb/apix-platform

@andmatei andmatei Awaiting requested review from andmatei andmatei is a code owner automatically assigned from mongodb/apix-platform

@yelizhenden-mdb yelizhenden-mdb Awaiting requested review from yelizhenden-mdb yelizhenden-mdb is a code owner automatically assigned from mongodb/apix-platform

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@AgustinBettati