rest_flex_fields2.config

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

`FLEX_FIELDS_OPTIONS`	Raw `REST_FLEX_FIELDS2` dictionary from Django settings.
`EXPAND_PARAM`	Query parameter name used to request expandable fields.
`FIELDS_PARAM`	Query parameter name used to include only selected fields.
`OMIT_PARAM`	Query parameter name used to omit selected fields.
`MAXIMUM_EXPANSION_DEPTH`	Maximum nested expansion depth. `None` means unlimited.
`RECURSIVE_EXPANSION_PERMITTED`	Whether recursive field expansion is allowed.
`WILDCARD_ALL`	Wildcard token that expands all fields.
`WILDCARD_ASTERISK`	Wildcard token alternative that expands all fields.
`wildcard_values`
`WILDCARD_VALUES`	Allowed wildcard tokens for expansion, configurable via Django settings.

Module Contents

rest_flex_fields2.config.FLEX_FIELDS_OPTIONS: Raw REST_FLEX_FIELDS2 dictionary from Django settings.

rest_flex_fields2.config.EXPAND_PARAM: Query parameter name used to request expandable fields.

rest_flex_fields2.config.FIELDS_PARAM: Query parameter name used to include only selected fields.

rest_flex_fields2.config.OMIT_PARAM: Query parameter name used to omit selected fields.

rest_flex_fields2.config.MAXIMUM_EXPANSION_DEPTH: Maximum nested expansion depth. None means unlimited.

rest_flex_fields2.config.RECURSIVE_EXPANSION_PERMITTED: Whether recursive field expansion is allowed.

rest_flex_fields2.config.WILDCARD_ALL = '~all': Wildcard token that expands all fields.

rest_flex_fields2.config.WILDCARD_ASTERISK = '*': Wildcard token alternative that expands all fields.

rest_flex_fields2.config.wildcard_values

rest_flex_fields2.config.WILDCARD_VALUES: Allowed wildcard tokens for expansion, configurable via Django settings.