fix: use InvalidDocumentException instead of ValueError #2376
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #2376 +/- ##
===========================================
+ Coverage 93.58% 94.37% +0.78%
===========================================
Files 90 98 +8
Lines 6124 7194 +1070
Branches 1260 1482 +222
===========================================
+ Hits 5731 6789 +1058
- Misses 183 196 +13
+ Partials 210 209 -1
Continue to review full report at Codecov.
|
| """ | ||
| if not OpenApiEditor.is_valid(doc): | ||
| raise ValueError( | ||
| raise InvalidDocumentException( |
There was a problem hiding this comment.
Thank you! We should probably do another pass and stop throwing generic python errors/exceptions.
| :param dict doc: OpenApi document as a dictionary | ||
| :raises ValueError: If the input OpenApi document does not meet the basic OpenApi requirements. | ||
| :raises InvalidDocumentException: If the input OpenApi document does not meet the basic OpenApi requirements. |
There was a problem hiding this comment.
Should this be InvalidDocument or InvalidResource?
There was a problem hiding this comment.
We can throw InvalidResource but we need logical id of the resource.
There was a problem hiding this comment.
Got it. That gets me thinking but nothing specific for this PR.
4 participants
Issue #, if available:
N/A
Description of changes:
Replaced
ValueErrorexceptions withInvalidDocumentExceptionwhich should help SAM Transform to gracefully exit execution for invalid Swagger/OpenAPI inputs.Checklist:
make prpassesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.