Include filter fields' help text as coreapi descriptions #563
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
Version 0.14 Release
0.15.1 Release
Version 0.15.2
Version 0.15.3
rpkilby
reviewed
Nov 16, 2016
| compat.coreapi.Field(name=field_name, required=False, location='query') | ||
| for field_name in filter_class().filters.keys() | ||
| compat.coreapi.Field( | ||
| name=field_name, required=False, location='query', description=str(field.field.help_text)) |
There was a problem hiding this comment.
I would probably use six.text_type instead of str.
There was a problem hiding this comment.
Good point! We switched to python3 two months ago and I have already forgotten about the whole unicode/str thing.
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.
This will make it a lot simpler to get the parameter descriptions when using DRF and Swagger, as it gets fed in automatically.