fix: Add handling for OpenApi definition that has tags with invalid format #2295
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
Codecov Report
@@ Coverage Diff @@
## develop #2295 +/- ##
===========================================
+ Coverage 93.58% 94.39% +0.81%
===========================================
Files 90 97 +7
Lines 6124 7088 +964
Branches 1260 1435 +175
===========================================
+ Hits 5731 6691 +960
+ Misses 183 181 -2
- Partials 210 216 +6
Continue to review full report at Codecov.
|
hoffa
reviewed
Jan 17, 2022
samtranslator/open_api/open_api.py
Outdated
| [ | ||
| InvalidTemplateException( | ||
| "Tags in open api definition needs to be a list. {} is a {} not a list.".format( | ||
| self.tags, type(self.tags) |
There was a problem hiding this comment.
Perhaps better to get rid of the weird Pythonism (<class 'dict'>)?
Suggested change
| self.tags, type(self.tags) | |
| self.tags, type(self.tags).__name__ |
There was a problem hiding this comment.
Sure yes that makes the message more readable! Will add in this change
hawflau
approved these changes
Jan 18, 2022
hoffa
approved these changes
Jan 20, 2022
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.
Issue #, if available:
N.A.
Description of changes:
If the tags in the definition body is not a list, the tags parsing will cause iteration errors.
Description of how you validated changes:
Added a check for the validity of the definition body that has tags specified.
Checklist:
make prpassesExamples?
Please reach out in the comments, if you want to add an example. Examples will be
added to
sam initthrough https://github.com/awslabs/aws-sam-cli-app-templates/By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.