docs(ipa0132): Require core metadata fields in the correct example - #128
Merged
Conversation
julius-jogela
requested review from
andmatei,
andreaangiolillo,
drinkbird,
lovisaberggren,
matt-condon,
saisundar and
wtrocki
August 17, 2026 09:27
| and record timestamps, so generic clients and tooling can identify the | ||
| operation, understand what kind of work it represents, and tell when its | ||
| status last changed. | ||
| status last changed. The four core fields are declared required, while |
Collaborator
There was a problem hiding this comment.
how about "status" being a required field?
Collaborator
Author
There was a problem hiding this comment.
Good point, added it to the status enum guideline. The spectral rule checks the required membership too now.
yelizhenden-mdb
approved these changes
Aug 17, 2026
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
2 participants
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.
Summary
Aligns the IPA-132 guideline examples with what the guidelines themselves state, so the spectral rules implementing them (mongodb/openapi#1435, #1437) do not flag the guidelines' own correct examples:
IPA-132-operation-response-must-include-core-metadata: the statement and workflow sayoperationId,operationType,createdAtandupdatedAtare required, but the correct example defined norequiredarray. Added it, deliberately excludingcustomMethodsince it applies only toCUSTOMoperations and must not be always-required.IPA-132-operation-status-must-use-the-standard-status-enum: addedrequired: [status]to the correct example — an OperationResponse that can legally omitstatusdefeats polling. The spectral rule checks this too.IPA-132-list-method-must-not-be-lro: the incorrect example used the single-resource path/orders/{orderId}withoperationId: listOrders; a List belongs on the collection path/orders.Test plan
npx prettier . --check— cleannpm run lint— cleannpm test— 34/34 passingnpm run docusaurus:build— succeeds