Skip to content

Commit 96fadd3

Browse files
committed
Added docs
1 parent 4eb75b3 commit 96fadd3

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/usage.md

+8
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,8 @@ When set to pluralize:
316316

317317
### Related fields
318318

319+
#### ResourceRelatedField
320+
319321
Because of the additional structure needed to represent relationships in JSON
320322
API, this package provides the `ResourceRelatedField` for serializers, which
321323
works similarly to `PrimaryKeyRelatedField`. By default,
@@ -427,6 +429,12 @@ class LineItemViewSet(viewsets.ModelViewSet):
427429
return queryset
428430
```
429431

432+
#### HyperLinkedRelatedField
433+
434+
In order to improve performance by saving some sql queries we can skip `data`
435+
key. Use `HyperLinkedRelatedField`. It works same as `ResourceRelatedField`
436+
but just skips `data` calculating.
437+
430438
### RelationshipView
431439
`rest_framework_json_api.views.RelationshipView` is used to build
432440
relationship views (see the

0 commit comments

Comments
 (0)