CLOUDP-302984: IPA rule Get methods should return data for a single resource #463
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
lovisaberggren
commented
Feb 27, 2025
| */ | ||
| export function getAllSuccessfulGetResponseSchemas(pathObject) { | ||
| const responses = pathObject['get']['responses']; | ||
| export function getAllSuccessfulResponseSchemas(operationObject) { |
There was a problem hiding this comment.
Updated this one to return successful response schemas for any operation, so we can reuse it more. Also returning the path for each schema, to be used in rule evaluations
wtrocki
reviewed
Feb 27, 2025
|
|
||
| if (hasException(responseObject, RULE_NAME)) { | ||
| collectException(responseObject, RULE_NAME, fullPath); | ||
| } else if (schemaIsPaginated(schema) || schemaIsArray(schema)) { |
There was a problem hiding this comment.
Question - when we have PR level job does this validator runs against dev or production schema?
There was a problem hiding this comment.
It will be for the dev schema
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
Adds new IPA rule
xgen-IPA-104-get-method-returns-single-resourceto check that get operations don't return paginated or array responses. Applied toGETfor standard resources and singleton resources.Jira ticket: CLOUDP-302984
Testing
See all violations: https://github.com/mongodb/openapi/pull/463/checks?check_run_id=37928281663
Example violation: