Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7k
Add note to tutorial about required request in serializer context when usingHyperlinkedModelSerializer#9732
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
looks good
| @@ -94,6 +94,16 @@ Notice that we've also added a new `'highlight'` field. This field is of the sa | |||
| Because we've included format suffixed URLs such as `'.json'`, we also need to indicate on the `highlight` field that any format suffixed hyperlinks it returns should use the `'.html'` suffix. | |||
| **Important:** | |||
| When you are manually instantiating these serializers inside your views (e.g., in `SnippetDetail` or `SnippetList`), you **must** pass `context={'request': request}` so the serializer knows how to build absolute URLs. | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I believe that by this point, theSnippetDetail andSnippetList both inheritGenericAPIView, which has aget_serializer_context() method. Perhaps this would be a good moment to mention this method.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Shouldn't we write this in the documentation that when using APIView instead of GenericAPIView you should pass the context to avoid any errors.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Yes, perhaps. What I'm suggesting is to add a reminder that if you use one of the generic views, you have a method to build the context data that you should use instead of creating the whole dict literal
| @@ -94,6 +94,16 @@ Notice that we've also added a new `'highlight'` field. This field is of the sa | |||
| Because we've included format suffixed URLs such as `'.json'`, we also need to indicate on the `highlight` field that any format suffixed hyperlinks it returns should use the `'.html'` suffix. | |||
| **Important:** | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
These kind of paragraphs are usually**Note:** and wrapped with horizontal lines (---) before and after.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
These kind of paragraphs are usually
**Note:**and wrapped with horizontal lines (---) before and after.
Sure i will take care of this in my next commits.
Uh oh!
There was an error while loading.Please reload this page.
Co-authored-by: Bruno Alla <browniebroke@users.noreply.github.com>
Uh oh!
There was an error while loading.Please reload this page.
HyperlinkedModelSerializer@browniebroke The changes are approved but not merged yet. Is there specific reason behind this? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
lgtm
2ae8c11 intoencode:masterUh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
This PR updates the Tutorial 5 Relationships & Hyperlinked APIs documentation to include an important note:
When using HyperlinkedModelSerializer inside manually instantiated serializers in views (e.g., SnippetDetail), you must pass context={'request': request} to ensure URL fields resolve correctly.
Without this context, developers following the tutorial as written will encounter errors like:
Motivation:
This omission frequently confuses beginners and is a common source of errors. Including this note will:
Fix#9729