Skip to content

info.checks ​

Overview ​

System checks for the model, serializer, and viewset configuration that model info metadata reads.

check_column_totals_configuration ​

Report viewsets whose column_totals declaration or total names are invalid (vueda_info.E013, W002).

Signature ​

check_column_totals_configuration(app_configs, kwargs)

Parameters ​

NameTypeRequiredDefaultDescription
app_configsyes
kwargsno

Source ​

server/vueda/info/checks.py:2225

check_field_source_resolution ​

Warn about serializer fields whose source model info cannot resolve to a model field (vueda_info.W001).

Signature ​

check_field_source_resolution(app_configs, kwargs)

Parameters ​

NameTypeRequiredDefaultDescription
app_configsyes
kwargsno

Source ​

server/vueda/info/checks.py:2337

check_filter_query_param_configuration ​

Report filtersets whose filters bind the same public query parameter.

Signature ​

check_filter_query_param_configuration(app_configs, kwargs)

Parameters ​

NameTypeRequiredDefaultDescription
app_configsyes
kwargsno

Source ​

server/vueda/info/checks.py:1711

check_formatted_name_configuration ​

Report models whose formatted_name or <field>_lookup_expression configuration cannot resolve (vueda_info.E001 to E005, E008, E011).

Signature ​

check_formatted_name_configuration(app_configs, kwargs)

Parameters ​

NameTypeRequiredDefaultDescription
app_configsyes
kwargsno

Source ​

server/vueda/info/checks.py:530

check_ordering_configuration ​

Report viewset and model ordering that model info cannot describe (vueda_info.E006, E007, E010, E015).

Signature ​

check_ordering_configuration(app_configs, kwargs)

Parameters ​

NameTypeRequiredDefaultDescription
app_configsyes
kwargsno

Source ​

server/vueda/info/checks.py:1685

check_search_queryset_configuration ​

Report viewsets whose multi-valued search cannot run against the search queryset (vueda_info.E014).

Signature ​

check_search_queryset_configuration(app_configs, kwargs)

Parameters ​

NameTypeRequiredDefaultDescription
app_configsyes
kwargsno

Source ​

server/vueda/info/checks.py:1865

Source ​

server/vueda/info/checks.py