Add example using source=‘*’ to custom field docs.
#5688
Merged
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
tomchristie
reviewed
Dec 19, 2017
docs/api-guide/fields.md
Outdated
|
|
||
| The key points from the example, though, are: | ||
|
|
||
| * `to_representation` is passed the entire `DataPoint` object must map from that |
There was a problem hiding this comment.
to_representation is passed the entire DataPoint object , and must map from that
docs/api-guide/fields.md
Outdated
|
|
||
| Note that this example doesn't handle validation. Partly for that reason, in a | ||
| real project, the coordinate nesting might be better handled with a nested serialiser using two | ||
| `IntegerField` instances, each with `source='*'`. |
There was a problem hiding this comment.
Wondering if it'd be worth us demonstrating this at the end of this new section.
source='*' is confusing to folks, so hammering home how to use it in non-custom-fields too might be helpful?
There was a problem hiding this comment.
OK. I can add that example. 😃
carltongibson
force-pushed
the
374/source-star-example
branch
from
9a806bb to
5d40079
Compare
pchiquet
pushed a commit
to pchiquet/django-rest-framework
that referenced
this pull request
Nov 17, 2020
* Add example using `source=‘*’` to custom field docs. * Add nested serialiser example Closes encode#2032 closes encode#3066
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.
Closes #2032 closes #3066
Adds an example using
source='*'to create a nested representation from a flat object.Does that.