Skip to content

Commit f4364bc

Browse files
committed
Add adrf references to inform that async versions of these classes exist
1 parent 05d58ac commit f4364bc

File tree

3 files changed

+24
-1
lines changed

3 files changed

+24
-1
lines changed

docs/api-guide/serializers.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,10 @@ You can provide arbitrary additional context by passing a `context` argument whe
424424

425425
The context dictionary can be used within any serializer field logic, such as a custom `.to_representation()` method, by accessing the `self.context` attribute.
426426

427+
## Async Serializer
428+
429+
An async version of the `Serializer` class is available via the [adrf](https://github.com/em1208/adrf) package.
430+
427431
---
428432

429433
# ModelSerializer
@@ -661,6 +665,10 @@ Called to generate a serializer field for the serializer's own `url` field. The
661665
Called when the field name did not map to any model field or model property.
662666
The default implementation raises an error, although subclasses may customize this behavior.
663667

668+
## Async ModelSerializer
669+
670+
An async version of the `ModelSerializer` class is available via the [adrf](https://github.com/em1208/adrf) package.
671+
664672
---
665673

666674
# HyperlinkedModelSerializer
@@ -862,6 +870,11 @@ Occasionally you might need to explicitly specify how the child and parent class
862870
# Instantiate the parent list serializer.
863871
return CustomListSerializer(*args, **kwargs)
864872

873+
874+
## Async ListSerializer
875+
876+
An async version of the `ListSerializer` class is available via the [adrf](https://github.com/em1208/adrf) package.
877+
865878
---
866879

867880
# BaseSerializer
@@ -1005,6 +1018,10 @@ The following class is an example of a generic serializer that can handle coerci
10051018
output[attribute_name] = str(attribute)
10061019
return output
10071020

1021+
## Async BaseSerializer
1022+
1023+
An async version of the `BaseSerializer` class is available via the [adrf](https://github.com/em1208/adrf) package.
1024+
10081025
---
10091026

10101027
# Advanced serializer usage

docs/api-guide/views.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,8 @@ By default only `GET` methods will be accepted. Other methods will respond with
161161
return Response({"message": "Got some data!", "data": request.data})
162162
return Response({"message": "Hello, world!"})
163163

164+
### Async support
165+
An async version of the `@api_view` decorator is available via the [adrf](https://github.com/em1208/adrf) package.
164166

165167
## API policy decorators
166168

@@ -224,4 +226,3 @@ You may pass `None` in order to exclude the view from schema generation.
224226
[throttling]: throttling.md
225227
[schemas]: schemas.md
226228
[classy-drf]: http://www.cdrf.co
227-

docs/api-guide/viewsets.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,11 @@ Alternatively, you can use the `url_name` attribute set by the `@action` decorat
235235

236236
The `url_name` argument for `.reverse_action()` should match the same argument to the `@action` decorator. Additionally, this method can be used to reverse the default actions, such as `list` and `create`.
237237

238+
239+
## Async ViewSets
240+
241+
An async version of the `ViewSet` class is available via the [adrf](https://github.com/em1208/adrf) package.
242+
238243
---
239244

240245
# API Reference

0 commit comments

Comments
 (0)