Repository navigation
feat(ipa): forbid custom methods on Operations endpoints - #1446
Merged
Merged
Conversation
Add xgen-IPA-132-operations-endpoint-must-not-define-custom-methods: custom method paths whose resource identifier is an Operations endpoint are violations. Control actions such as cancel require mutating methods, which the read-only Operations resource does not allow. The rule name matches the guideline proposed in mongodb/ipa#126.
julius-jogela
force-pushed
the
feat-ipa-132-no-custom-methods
branch
from
August 21, 2026 13:30
0c7450c to
32a2415
Compare
julius-jogela
marked this pull request as ready for review
August 21, 2026 13:32
julius-jogela
requested review from
andmatei,
andreaangiolillo,
drinkbird,
lovisaberggren,
saisundar,
wtrocki and
yelizhenden-mdb
August 21, 2026 13:32
yelizhenden-mdb
approved these changes
Aug 21, 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
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.
Proposed changes
This PR adds the IPA-132 rule forbidding custom methods on Operations endpoints. The Operations resource is read-only, and control actions require mutating methods, so any
:customMethodpath attached to an Operations endpoint is a violation.Jira ticket: CLOUDP-435356
Rules added
At
warnseverity, given$.pathswith@key:xgen-IPA-132-operations-endpoint-must-not-define-custom-methods:customMethod) whose resource identifier is an Operations endpoint — the Operations collection (.../operations) or a single Operation (.../operations/{operationId}) — is a violationPaths with
x-xgen-IPA-exceptionfor the rule are excluded from validation. The rule name matches the guideline added in mongodb/ipa#126.Testing
gen-ipa-docs, prettier and eslint clean.spectral lint openapi/.raw/v2.yamlwith the full ruleset: 0xgen-IPA-132-*findings — no custom methods exist on Operations endpoints in the current spec.Checklist