CLOUDP-305831: Fix IPA validation failed on OAS release #509
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
Mar 11, 2025
Comment on lines
+54
to
+56
| 401: { | ||
| $ref: '#/components/schemas/BadRequest', | ||
| }, |
There was a problem hiding this comment.
Example of what caused the failure, since this rule operates on the unresolved schema, this will end up as undefined, since we're trying to get the schema ref inside of /content/version. Also moved the check for 2xx response first to not evaluate these
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.
Proposed changes
Optional validations failed in OAS release due to bug in rule
xgen-IPA-104-get-method-returns-response-suffixed-object. When resolving a schema for non-2xx responses, it's undefined and wasn't checked for before checking if it has a schema.Also added a test that will catch this if it happens again.
See failures: https://github.com/mongodb/openapi/actions/runs/13786521109
Jira ticket: CLOUDP-305831