backend.src.libs.docs.docs_constants Namespace Reference

Data Structures
class	DocumentationProvider

Variables
Disp	IDISP = initialise_logger("docs_constants", False)
EnvLoader	ENV = EnvLoader()
TOMLLoader	TOML = TOMLLoader()
bool	ENABLE_REDOC = False
bool	ENABLE_EDITOR = "true"
bool	ENABLE_SCALAR = "true"
bool	ENABLE_SWAGGER = "true"
bool	ENABLE_RAPIDOC = "true"
bool	ENABLE_RAPIPDF = "true"
bool	ENABLE_EXPLORER = "true"
bool	ENABLE_ELEMENTS = "true"
list	_enabled_providers = []
tuple	DEFAULT_PROVIDERS
str	RAPIDOC_CDN_VERSION
str	SCALAR_CDN_VERSION
str	ELEMENTS_CDN_VERSION
str	EDITOR_CDN_VERSION
str	EXPLORER_CDN_VERSION
str	RAPIPDF_CDN_VERSION
str	OAUTH2_REDIRECT_URL
bool	ENABLE_OAUTH2_DOCS
dict	_DEFAULT_OAUTH2_SCOPES
dict	OAUTH2_SCOPES
str	OAUTH2_AUTHORIZATION_URL
str	OAUTH2_TOKEN_URL

Detailed Description

# +==== BEGIN CatFeeder =================+
# LOGO:
# ..............(..../\
# ...............)..(.')
# ..............(../..)
# ...............\‍(__)|
# Inspired by Joan Stark
# source https://www.asciiart.eu/
# animals/cats
# /STOP
# PROJECT: CatFeeder
# FILE: docs_constants.py
# CREATION DATE: 26-11-2025
# LAST Modified: 14:46:12 19-12-2025
# DESCRIPTION:
# This is the backend server in charge of making the actual website work.
# /STOP
# COPYRIGHT: (c) Cat Feeder
# PURPOSE: The file containing the constants for the documentation handler.
# // AR
# +==== END CatFeeder =================+

Variable Documentation

_DEFAULT_OAUTH2_SCOPES

dict backend.src.libs.docs.docs_constants._DEFAULT_OAUTH2_SCOPES

protected

Initial value:

=  {
    "read": "Read access to API resources",
    "write": "Write access to API resources",
    "admin": "Administrative access to API resources",
}

Definition at line 239 of file docs_constants.py.

_enabled_providers

list backend.src.libs.docs.docs_constants._enabled_providers = []

protected

Definition at line 189 of file docs_constants.py.

DEFAULT_PROVIDERS

tuple backend.src.libs.docs.docs_constants.DEFAULT_PROVIDERS

Initial value:

=  tuple(
    _enabled_providers)

Definition at line 207 of file docs_constants.py.

EDITOR_CDN_VERSION

str backend.src.libs.docs.docs_constants.EDITOR_CDN_VERSION

Initial value:

=  TOML.get_toml_variable(
    "Documentation.cdn_versions", "editor", "5.0.0"
)

Definition at line 220 of file docs_constants.py.

ELEMENTS_CDN_VERSION

str backend.src.libs.docs.docs_constants.ELEMENTS_CDN_VERSION

Initial value:

=  TOML.get_toml_variable(
    "Documentation.cdn_versions", "elements", "8.4.7"
)

Definition at line 217 of file docs_constants.py.

ENABLE_EDITOR

bool backend.src.libs.docs.docs_constants.ENABLE_EDITOR = "true"

Definition at line 119 of file docs_constants.py.

ENABLE_ELEMENTS

bool backend.src.libs.docs.docs_constants.ENABLE_ELEMENTS = "true"

Definition at line 179 of file docs_constants.py.

ENABLE_EXPLORER

bool backend.src.libs.docs.docs_constants.ENABLE_EXPLORER = "true"

Definition at line 169 of file docs_constants.py.

ENABLE_OAUTH2_DOCS

bool backend.src.libs.docs.docs_constants.ENABLE_OAUTH2_DOCS

Initial value:

=  TOML.get_toml_variable(
    "Documentation", "enable_oauth2", False
)

Definition at line 234 of file docs_constants.py.

ENABLE_RAPIDOC

bool backend.src.libs.docs.docs_constants.ENABLE_RAPIDOC = "true"

Definition at line 149 of file docs_constants.py.

ENABLE_RAPIPDF

bool backend.src.libs.docs.docs_constants.ENABLE_RAPIPDF = "true"

Definition at line 159 of file docs_constants.py.

ENABLE_REDOC

bool backend.src.libs.docs.docs_constants.ENABLE_REDOC = False

Definition at line 113 of file docs_constants.py.

ENABLE_SCALAR

bool backend.src.libs.docs.docs_constants.ENABLE_SCALAR = "true"

Definition at line 129 of file docs_constants.py.

ENABLE_SWAGGER

bool backend.src.libs.docs.docs_constants.ENABLE_SWAGGER = "true"

Definition at line 139 of file docs_constants.py.

ENV

EnvLoader backend.src.libs.docs.docs_constants.ENV = EnvLoader()

Definition at line 33 of file docs_constants.py.

EXPLORER_CDN_VERSION

str backend.src.libs.docs.docs_constants.EXPLORER_CDN_VERSION

Initial value:

=  TOML.get_toml_variable(
    "Documentation.cdn_versions", "explorer", "0.0.58"
)

Definition at line 223 of file docs_constants.py.

IDISP

Disp backend.src.libs.docs.docs_constants.IDISP = initialise_logger("docs_constants", False)

Definition at line 30 of file docs_constants.py.

OAUTH2_AUTHORIZATION_URL

str backend.src.libs.docs.docs_constants.OAUTH2_AUTHORIZATION_URL

Initial value:

=  ENV.get_environment_variable(
        "DOCS_OAUTH2_AUTHORIZATION_URL"
    )

Definition at line 250 of file docs_constants.py.

OAUTH2_REDIRECT_URL

str backend.src.libs.docs.docs_constants.OAUTH2_REDIRECT_URL

Initial value:

=  TOML.get_toml_variable(
    "Documentation", "oauth2_redirect_url", "/docs/oauth2-redirect"
)

Definition at line 231 of file docs_constants.py.

OAUTH2_SCOPES

dict backend.src.libs.docs.docs_constants.OAUTH2_SCOPES

Initial value:

=  TOML.get_toml_variable(
    "Documentation", "oauth2_scopes", _DEFAULT_OAUTH2_SCOPES
)

Definition at line 244 of file docs_constants.py.

OAUTH2_TOKEN_URL

str backend.src.libs.docs.docs_constants.OAUTH2_TOKEN_URL

Initial value:

=  ENV.get_environment_variable(
        "DOCS_OAUTH2_TOKEN_URL"
    )

Definition at line 260 of file docs_constants.py.

RAPIDOC_CDN_VERSION

str backend.src.libs.docs.docs_constants.RAPIDOC_CDN_VERSION

Initial value:

=  TOML.get_toml_variable(
    "Documentation.cdn_versions", "rapidoc", "9.3.4"
)

Definition at line 211 of file docs_constants.py.

RAPIPDF_CDN_VERSION

str backend.src.libs.docs.docs_constants.RAPIPDF_CDN_VERSION

Initial value:

=  TOML.get_toml_variable(
    "Documentation.cdn_versions", "rapipdf", "2.2.1"
)

Definition at line 226 of file docs_constants.py.

SCALAR_CDN_VERSION

str backend.src.libs.docs.docs_constants.SCALAR_CDN_VERSION

Initial value:

=  TOML.get_toml_variable(
    "Documentation.cdn_versions", "scalar", "1.24.0"
)

Definition at line 214 of file docs_constants.py.

TOML

TOMLLoader backend.src.libs.docs.docs_constants.TOML = TOMLLoader()

Definition at line 36 of file docs_constants.py.