rest_flex_fields2.config
========================

.. py:module:: rest_flex_fields2.config

.. autoapi-nested-parse::

   Runtime configuration for ``REST_FLEX_FIELDS2``.

   Reads the optional ``REST_FLEX_FIELDS2`` dict from Django settings and
   exposes validated constants used throughout the package.  Raises
   ``AssertionError`` or ``ValueError`` on invalid configuration so
   errors surface at import time rather than at request time.



Attributes
----------

.. autoapisummary::

   rest_flex_fields2.config.FLEX_FIELDS_OPTIONS
   rest_flex_fields2.config.EXPAND_PARAM
   rest_flex_fields2.config.FIELDS_PARAM
   rest_flex_fields2.config.OMIT_PARAM
   rest_flex_fields2.config.MAXIMUM_EXPANSION_DEPTH
   rest_flex_fields2.config.RECURSIVE_EXPANSION_PERMITTED
   rest_flex_fields2.config.WILDCARD_ALL
   rest_flex_fields2.config.WILDCARD_ASTERISK
   rest_flex_fields2.config.wildcard_values
   rest_flex_fields2.config.WILDCARD_VALUES


Module Contents
---------------

.. py:data:: FLEX_FIELDS_OPTIONS

   Raw ``REST_FLEX_FIELDS2`` dictionary from Django settings.

.. py:data:: EXPAND_PARAM

   Query parameter name used to request expandable fields.

.. py:data:: FIELDS_PARAM

   Query parameter name used to include only selected fields.

.. py:data:: OMIT_PARAM

   Query parameter name used to omit selected fields.

.. py:data:: MAXIMUM_EXPANSION_DEPTH

   Maximum nested expansion depth. ``None`` means unlimited.

.. py:data:: RECURSIVE_EXPANSION_PERMITTED

   Whether recursive field expansion is allowed.

.. py:data:: WILDCARD_ALL
   :value: '~all'


   Wildcard token that expands all fields.

.. py:data:: WILDCARD_ASTERISK
   :value: '*'


   Wildcard token alternative that expands all fields.

.. py:data:: wildcard_values

.. py:data:: WILDCARD_VALUES

   Allowed wildcard tokens for expansion, configurable via Django settings.