CLOUDP-306573: IPA rule - plaintext repsonse has example #628
Conversation
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
|
IPA failure related to |
| with: | ||
| file_glob: v2.yaml | ||
| spectral_ruleset: tools/spectral/ipa/ipa-spectral.yaml | ||
| run: npx spectral lint v2.yaml --ruleset=./tools/spectral/ipa/ipa-spectral.yaml |
| message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-117-plaintext-response-must-have-example' | ||
| severity: warn | ||
| given: | ||
| - '$.paths[*][get,put,post,delete,options,head,patch,trace].responses[*].content' |
There was a problem hiding this comment.
Q: I know this comes a long way but.. Do we need to specify them? Do you remember what is the reason behind specifying HTTP methods?
There was a problem hiding this comment.
Yes, if we don't specify them this will also target other things like extension properties as well. For this line specifically the risk is pretty low to have an extension with responses and content, but just as a safe-guard
wtrocki
approved these changes
Mar 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Proposed changes
New rule
xgen-IPA-117-plaintext-response-must-have-examplechecks that 2xx responses (non-json and non-yaml) have examples in the object or in the schema.Also updated the IPA validation that runs on the PRs to use the spectral CLI instead of the action, since the action runs on a downloaded spec it can't show the annotations in the PR as a result. The spectral CLI output is a bit more useful as it shows all warnings/errors and the component that is violating.
Before:
After:
Jira ticket: CLOUDP-306573