Configuration reference

Every class attribute, option, parameter, setting, command flag, error code and system check, with its type, default and meaning.

Generated from the code

These pages are produced by tools/generate_docs.py from the source: types and defaults exactly as written, descriptions from docstrings. A test fails when they are out of date, so they always match the installed version.

Page	Covers	Guide
Controllers and operations	Controller attributes, as_router(), ControllerOptions, OperationOptions, RouteOptions, mount(), use_case(), hooks	Controllers, Mounting
CRUD	ModelController and list attributes, generated schemas, bulk, ExpandRule, nested writes, transitions, MetaMixin, AggregateMixin, import/export, sharing, SoftDelete, Parent, ETag, offset and cursor pagination, parameter annotations	CRUD, Nested writes, Transitions, Query tuning, API surface
Permissions and visibility	built-in permissions and their arguments, as_permission(), ObjectPermissions, backends and shortcuts, VisibleTo, Expandable, Sensitive	Permissions, Object permissions, Visibility, Operations
Middleware, health and rendering	middleware, QueryExplainMiddleware, VersionedResponseMixin, RequestLogMiddleware/RequestLogPlugin, HealthController and checks, renderers, OpenTelemetry	Middleware and operations, Operations, Query tuning
API keys, audit log, webhooks, uploads, jobs	the ninja_devx.contrib apps, redis_throttle, nplusone	API keys, Audit, Webhooks, Uploads, Jobs, Operations, N+1 detection and devx_doctor
Dependency injection	Container methods, Inject, Resolve, request_context(), dishka, svcs	Dependency injection
Tenancy, caching, throttling	current_tenant(), conditional(), throttles, throttle storage, idempotent()	Multi-tenancy, HTTP caching, Throttling, Operations
Errors	ErrorMap.map(), mask_validation_input(), DomainError, built-in error codes, exceptions and warnings	Errors
Settings	every NINJA_DEVX key	Settings
Testing	pytest fixtures and options, test helpers, contract testing	Testing
Commands and checks	devx_scaffold, devx_openapi, devx_inspect, devx_doctor, devx_startapp, devx_startproject, devx_apikey, devx_webhooks, devx_jobs, unasync, system check ids	Code generation, Starting a project, System checks, Inspecting, N+1 detection and devx_doctor

The API reference renders every public module's docstrings.