vueda.release
Overview
Release management with model registration for the info API.
Submodules
register
Register a model so that it can be used with ModelInfoViewSet. You should do this in the ready method of an AppConfig, not as a side effect of importing viewsets or serializers.
:param canonical_serializer: The serializer to use as a reference for the model. Only a Meta.model is required; it does not need to inherit VuedaSerializer. The /info/ meta-API falls back to defaults for any VuedaExpandableFieldsSerializerMixin hooks (generate_expand_model_info, get_expand_model_info, get_field_model_info) the serializer doesn't define. :param canonical_viewset: The viewset to use as a reference for the model.
Signature
register(canonical_serializer, canonical_viewset)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| canonical_serializer | yes | ||
| canonical_viewset | yes |
Source
server/vueda/info/registration.py:24
register_serializer
Register a model so that it can be used with ModelInfoViewSet. You should do this in the ready method of an AppConfig, not as a side effect of importing viewsets or serializers.
Because there is no viewset, the info available will be limited to
:param canonical_serializer: The serializer to use as a reference for the model. Only a Meta.model is required; it does not need to inherit VuedaSerializer. The /info/ meta-API falls back to defaults for any VuedaExpandableFieldsSerializerMixin hooks (generate_expand_model_info, get_expand_model_info, get_field_model_info) the serializer doesn't define.
Signature
register_serializer(canonical_serializer)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| canonical_serializer | yes |
Source
server/vueda/info/registration.py:75
Source
server/vueda/release/__init__.py