audoma - API Automatic Documentation Maker
latest
Contents:
Installation
Usage
Contributing to audoma
License
Changelog
Overview
audoma - API Automatic Documentation Maker
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
_
__call__() (audoma.decorators.audoma_action method)
__init__() (audoma.decorators.audoma_action method)
_build_exclusive_fields_schema() (audoma.openapi.AudomaAutoSchema method)
_check_action_function() (audoma.drf.generics.GenericAPIView method)
_extract_action_function() (audoma.openapi.AudomaAutoSchema method)
_extract_audoma_action_operations() (audoma.openapi.AudomaAutoSchema method)
_extract_audoma_action_serializer() (audoma.drf.generics.GenericAPIView method)
_get_enum_choices_for_field() (audoma.openapi.AudomaAutoSchema method)
_get_link_choices_for_field() (audoma.openapi.AudomaAutoSchema method)
_get_permissions_description() (audoma.openapi.AudomaAutoSchema method)
_get_request_for_media_type() (audoma.openapi.AudomaAutoSchema method)
_get_response_for_code() (audoma.openapi.AudomaAutoSchema method)
_get_serializer() (audoma.openapi.AudomaAutoSchema method)
_handle_permission() (audoma.openapi.AudomaAutoSchema method)
_map_serializer() (audoma.openapi.AudomaAutoSchema method)
_map_serializer_field() (audoma.openapi.AudomaAutoSchema method)
_parse_action_errors() (audoma.openapi.AudomaAutoSchema method)
_parse_action_result_serializer() (audoma.openapi.AudomaAutoSchema method)
_parse_action_result_serializers() (audoma.openapi.AudomaAutoSchema method)
_parse_response_data() (audoma.drf.viewsets.GenericViewSet method)
_parse_single_response_data_item() (audoma.drf.viewsets.GenericViewSet method)
_retrieve_response_headers() (audoma.drf.generics.GenericAPIView method)
_simplify_validation_errors() (audoma.drf.viewsets.GenericViewSet method)
A
ActionModelMixin (class in audoma.drf.mixins)
add_currency_field() (audoma.django.db.fields.MoneyField method)
audoma.choices
module
audoma.django.db.fields
module
audoma.django.forms.fields
module
audoma.drf.decorators
module
audoma.drf.fields
module
audoma.drf.filters
module
audoma.drf.generics
module
audoma.drf.mixins
module
audoma.drf.serializers
module
audoma.drf.validators
module
audoma.drf.viewsets
module
audoma.hooks
module
audoma.mixins
module
audoma.openapi
module
audoma_example_class (audoma.mixins.Base64ExampleMixin attribute)
(audoma.mixins.DateExampleMixin attribute)
(audoma.mixins.DateTimeExampleMixin attribute)
(audoma.mixins.ExampleMixin attribute)
(audoma.mixins.NumericExampleMixin attribute)
(audoma.mixins.RangeExampleMixin attribute)
(audoma.mixins.RegexExampleMixin attribute)
(audoma.mixins.TimeExampleMixin attribute)
AudomaActionException (class in audoma.decorators)
AudomaArgs (class in audoma.decorators)
AudomaAutoSchema (class in audoma.openapi)
AudomaPagination (class in audoma.drf.viewsets)
AutoField (class in audoma.django.db.fields)
B
Base64ExampleMixin (class in audoma.mixins)
Base64FileField (class in audoma.drf.fields)
Base64ImageField (class in audoma.drf.fields)
BigAutoField (class in audoma.django.db.fields)
BigIntegerField (class in audoma.django.db.fields)
BinaryField (class in audoma.django.db.fields)
bind() (audoma.drf.fields.SerializerMethodField method)
BooleanField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
build_standard_field() (audoma.drf.serializers.ModelSerializer method)
bulk_update() (audoma.drf.mixins.BulkUpdateModelMixin method)
BulkCreateModelMixin (class in audoma.drf.mixins)
BulkListSerializer (class in audoma.drf.serializers)
BulkUpdateModelMixin (class in audoma.drf.mixins)
C
CharField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
child_class (audoma.drf.fields.DateRangeField attribute)
(audoma.drf.fields.DateTimeRangeField attribute)
(audoma.drf.fields.DecimalRangeField attribute)
(audoma.drf.fields.FloatRangeField attribute)
(audoma.drf.fields.IntegerRangeField attribute)
choice_link_schema_generator (audoma.openapi.AudomaAutoSchema attribute)
ChoiceField (class in audoma.drf.fields)
CommaSeparatedIntegerField (class in audoma.django.db.fields)
create() (audoma.drf.mixins.BulkCreateModelMixin method)
(audoma.drf.mixins.CreateModelMixin method)
CreateModelMixin (class in audoma.drf.mixins)
CurrencyField (class in audoma.django.db.fields)
D
DateExampleMixin (class in audoma.mixins)
DateField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
DateRangeField (class in audoma.drf.fields)
DateTimeExampleMixin (class in audoma.mixins)
DateTimeField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
DateTimeRangeField (class in audoma.drf.fields)
DecimalField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
DecimalRangeField (class in audoma.drf.fields)
DefaultMessageSerializer (class in audoma.drf.serializers)
destroy() (audoma.drf.mixins.DestroyModelMixin method)
DestroyModelMixin (class in audoma.drf.mixins)
DictField (class in audoma.drf.fields)
document_and_format() (in module audoma.drf.decorators)
DocumentedTypedChoiceFilter (class in audoma.drf.filters)
DurationField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
E
EmailField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
Example (class in audoma.examples)
ExampleMixin (class in audoma.mixins)
ExclusiveFieldsValidator (class in audoma.drf.validators)
F
Field (class in audoma.django.db.fields)
FileField (class in audoma.drf.fields)
FilePathField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
FloatField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
FloatRangeField (class in audoma.drf.fields)
formfield() (audoma.django.db.fields.MoneyField method)
G
generate_value() (audoma.examples.Example method)
(audoma.examples.NumericExample method)
(audoma.examples.RegexExample method)
GenericAPIView (class in audoma.drf.generics)
GenericIPAddressField (class in audoma.django.db.fields)
GenericViewSet (class in audoma.drf.viewsets)
get_audoma_action_config() (audoma.drf.generics.GenericAPIView method)
get_audoma_action_serializer_class() (audoma.drf.generics.GenericAPIView method)
get_default() (audoma.drf.fields.SerializerMethodField method)
get_description() (audoma.openapi.AudomaAutoSchema method)
get_object() (audoma.drf.mixins.BulkUpdateModelMixin method)
get_operation() (audoma.openapi.AudomaAutoSchema method)
get_operation_id() (audoma.openapi.AudomaAutoSchema method)
get_paginated_response() (audoma.drf.mixins.ListModelMixin method)
get_paginated_response_schema() (audoma.drf.viewsets.AudomaPagination method)
get_response_serializers() (audoma.openapi.AudomaAutoSchema method)
get_result_serializer() (audoma.drf.generics.GenericAPIView method)
get_serializer() (audoma.drf.generics.GenericAPIView method)
get_serializer_class() (audoma.drf.generics.GenericAPIView method)
get_success_headers() (audoma.drf.mixins.ActionModelMixin method)
get_value() (audoma.examples.Example method)
H
handle_exception() (audoma.drf.viewsets.GenericViewSet method)
HStoreField (class in audoma.drf.fields)
I
ImageField (class in audoma.drf.fields)
IntegerField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
IntegerRangeField (class in audoma.drf.fields)
IPAddressField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
J
JSONField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
L
list() (audoma.drf.mixins.ListModelMixin method)
ListField (class in audoma.drf.fields)
ListModelMixin (class in audoma.drf.mixins)
ListSerializer (class in audoma.drf.serializers)
M
MACAddressField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
make_choices() (in module audoma.choices)
max_page_size (audoma.drf.viewsets.AudomaPagination attribute)
message (audoma.drf.validators.ExclusiveFieldsValidator attribute)
message_required (audoma.drf.validators.ExclusiveFieldsValidator attribute)
ModelSerializer (class in audoma.drf.serializers)
module
audoma.choices
audoma.django.db.fields
audoma.django.forms.fields
audoma.drf.decorators
audoma.drf.fields
audoma.drf.filters
audoma.drf.generics
audoma.drf.mixins
audoma.drf.serializers
audoma.drf.validators
audoma.drf.viewsets
audoma.hooks
audoma.mixins
audoma.openapi
MoneyField (class in audoma.django.db.fields)
(class in audoma.django.forms.fields)
(class in audoma.drf.fields)
MultipleChoiceField (class in audoma.drf.fields)
N
NullBooleanField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
NumericExample (class in audoma.examples)
NumericExampleMixin (class in audoma.mixins)
P
page_size (audoma.drf.viewsets.AudomaPagination attribute)
pagination_class (audoma.drf.viewsets.GenericViewSet attribute)
partial_bulk_update() (audoma.drf.mixins.BulkUpdateModelMixin method)
perform_action() (audoma.drf.mixins.ActionModelMixin method)
perform_bulk_create() (audoma.drf.mixins.BulkCreateModelMixin method)
perform_bulk_update() (audoma.drf.mixins.BulkUpdateModelMixin method)
perform_update() (audoma.drf.mixins.BulkUpdateModelMixin method)
PhoneNumberField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
PositiveBigIntegerField (class in audoma.django.db.fields)
PositiveIntegerField (class in audoma.django.db.fields)
PositiveSmallIntegerField (class in audoma.django.db.fields)
postprocess_common_errors_section() (in module audoma.hooks)
prepare_value() (audoma.django.forms.fields.MoneyField method)
preprocess_include_path_format() (in module audoma.hooks)
R
range_type (audoma.drf.fields.DateRangeField attribute)
(audoma.drf.fields.DateTimeRangeField attribute)
(audoma.drf.fields.DecimalRangeField attribute)
(audoma.drf.fields.FloatRangeField attribute)
(audoma.drf.fields.IntegerRangeField attribute)
RangeExampleMixin (class in audoma.mixins)
RangeField (class in audoma.drf.fields)
ReadOnlyField (class in audoma.drf.fields)
RegexExample (class in audoma.examples)
RegexExampleMixin (class in audoma.mixins)
RegexField (class in audoma.drf.fields)
result_serializer_class() (in module audoma.drf.serializers)
ResultSerializerClassMixin (class in audoma.drf.serializers)
retrieve() (audoma.drf.mixins.RetrieveModelMixin method)
retrieve_instance() (audoma.drf.mixins.ActionModelMixin method)
RetrieveModelMixin (class in audoma.drf.mixins)
run_validation() (audoma.drf.fields.SerializerMethodField method)
S
Serializer (class in audoma.drf.serializers)
serializer_choice_field (audoma.drf.serializers.ModelSerializer attribute)
SerializerMethodField (class in audoma.drf.fields)
SlugField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
SmallAutoField (class in audoma.django.db.fields)
SmallIntegerField (class in audoma.django.db.fields)
T
TextField (class in audoma.django.db.fields)
TimeExampleMixin (class in audoma.mixins)
TimeField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
to_internal_value() (audoma.drf.fields.SerializerMethodField method)
to_representation() (audoma.drf.fields.SerializerMethodField method)
(audoma.examples.Example method)
U
UnknownExceptionContentTypeError
update() (audoma.drf.mixins.UpdateModelMixin method)
UpdateModelMixin (class in audoma.drf.mixins)
URLField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
UUIDField (class in audoma.django.db.fields)
(class in audoma.drf.fields)
Read the Docs
v: latest
Versions
latest
stable
0.6.0
0.5.1
0.5.0
0.4.14
0.4.13
0.4.12
0.4.11
0.4.10
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
Downloads
pdf
On Read the Docs
Project Home
Builds