document api.doc parameter description via dict #495
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
jsvgoncalves
suggested changes
Mar 1, 2024
doc/swagger.rst
Outdated
| .. code-block:: python | ||
|
|
||
| @api.route('/my-resource/<id>', endpoint='my-resource') | ||
| @api.doc(params={'id': {'description': 'An ID', 'required': 'true', 'default': ''}}) |
There was a problem hiding this comment.
Cheers, this helped me. However, while the string value "true" is evaluated to True, so is the string value "false". "required" needs to be a boolean.
Suggested change
| @api.doc(params={'id': {'description': 'An ID', 'required': 'true', 'default': ''}}) | |
| @api.doc(params={'id': {'description': 'An ID', 'required': False, 'default': ''}}) |
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.
Have lost few hours before stumbled upon solution (#139) for describing parameters inside
api.docdecorator viadict. Wanted to to spare the time for the next one searching.