patch: More verbose yaml errors #84
Open
Conversation
This file contains 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
When the docstring is invalid yaml/swagger, the generated swagged documentation just shows: ``` Invalid Swagger ⚠ Swagger document could not be loaded from docstring ⚠ ``` This change makes the docstring parsing step a bit more verbose to indicate that there are problems. It is still not ideal but it is an improvement over guessing/ copy-pasta into a validator. How to test that this is working: 1) create a aiohttp route with docstring, add it to the app with the swagger plugin 2) start the app 3) navigate to the /api/doc page and find the route observe that the route is displayed correctly in the swagger page 4) change the docstring to invalid yaml (e.g. by indenting with tabs) 5) (re) start the app observe that there is more verbose output 6) (re) navigat ot the /api/doc page and find the route observe that the route now probably is labeled as 'Invalid Swagger'
Codecov Report
@@ Coverage Diff @@
## master #84 +/- ##
=========================================
- Coverage 94.73% 91.3% -3.44%
=========================================
Files 4 4
Lines 133 138 +5
=========================================
Hits 126 126
- Misses 7 12 +5
Continue to review full report at Codecov.
|
goranpavlovic
force-pushed
the
master
branch
2 times, most recently
from
10303be
to
ea32115
Compare
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.
When the docstring is invalid yaml/swagger, the generated swagged documentation
just shows:
This change makes the docstring parsing step a bit more verbose to indicate that
there are problems. It is still not ideal but it is an improvement over guessing/
copy-pasta into a validator.
How to test that this is working:
observe that the route is displayed correctly in the swagger page
observe that there is more verbose output
observe that the route now probably is labeled as 'Invalid Swagger'