Configuration Reference

Configuration Reference

• Applies to: Flask and FastAPI
• Best sources: safrs/config.py, README.md
• Related pages: Sorting, Pagination, and Sparse Fieldsets, Debug Logs

Current configuration strategy

Current SAFRS code prefers application configuration and environment variables. The compatibility layer in safrs/config.py still exists, but most settings are treated as backward-compatible fallbacks.

Pagination-related settings

• DEFAULT_PAGE_LIMIT
• MAX_PAGE_LIMIT
• MAX_PAGE_OFFSET
• BIG_QUERY_THRESHOLD

URL and naming settings

• OBJECT_ID_SUFFIX
• RESOURCE_URL_FMT
• INSTANCE_URL_FMT
• related endpoint-format settings

Relationship settings

• ENABLE_RELATIONSHIPS

Logging and debug behavior

Debug behavior is tied to log-level handling. See Debug Logs.

Practical guidance

• prefer app.config where possible
• use environment variables as deployment overrides
• treat older config module constants as compatibility support, not the main extension surface