CLOUDP-271997: IPA 108 - delete method schema #483
Merged
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
tools/spectral/ipa/__tests__/deleteMethodResponseShouldNotHaveSchema.test.js
Show resolved
Hide resolved
gssbzn
approved these changes
Mar 6, 2025
tools/spectral/ipa/rulesets/functions/deleteMethodResponseShouldNotHaveSchema.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/rulesets/functions/deleteMethodResponseShouldNotHaveSchema.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/rulesets/functions/deleteMethodResponseShouldNotHaveSchema.js
Outdated
Show resolved
Hide resolved
Co-authored-by: Lovisa Berggren <59226031+lovisaberggren@users.noreply.github.com>
tools/spectral/ipa/rulesets/functions/deleteMethodResponseShouldNotHaveSchema.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/rulesets/functions/deleteMethodResponseShouldNotHaveSchema.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/rulesets/functions/deleteMethodResponseShouldNotHaveSchema.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/rulesets/functions/deleteMethodResponseShouldNotHaveSchema.js
Outdated
Show resolved
Hide resolved
Co-authored-by: Yeliz Henden <165907936+yelizhenden-mdb@users.noreply.github.com>
tools/spectral/ipa/rulesets/functions/deleteMethodResponseShouldNotHaveSchema.js
Outdated
Show resolved
Hide resolved
tools/spectral/ipa/rulesets/functions/deleteMethodResponseShouldNotHaveSchema.js
Show resolved
Hide resolved
lovisaberggren
approved these changes
Mar 7, 2025
wtrocki
commented
Mar 7, 2025
tools/spectral/ipa/rulesets/functions/deleteMethodResponseShouldNotHaveSchema.js
Outdated
Show resolved
Hide resolved
wtrocki
commented
Mar 7, 2025
| } | ||
| } | ||
| } catch (e) { | ||
| return ['Internal Rule Error without reporting violation' + e]; |
There was a problem hiding this comment.
We can get different error when rule missbehaves. That gives us:
- Ability to understand the issue at runtime and tests instead of getting generic
AggregateError: Error running Nimma - Protect production failure to break entire validation. Users will be able to add exception until we fix problem in single rule but other rules will still work.
There was a problem hiding this comment.
Moved to helper for reuse.
wtrocki
commented
Mar 7, 2025
tools/spectral/ipa/rulesets/functions/deleteMethodResponseShouldNotHaveSchema.js
Outdated
Show resolved
Hide resolved
| delete: { | ||
| responses: { | ||
| 204: { | ||
| 'application/vnd.atlas.2023-01-01+json': { |
yelizhenden-mdb
approved these changes
Mar 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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
CLOUDP-271997
Changes Overview
This first PR implements OpenAPI specification validation for IPA-108 guidelines related to DELETE operations. The implementation adds linting rules that verify DELETE methods follow REST API best practices.
Components Implemented
Rule: xgen-IPA-108-delete-response-should-be-empty