foca package
FOCA root package.
Subpackages
- foca.api package
- foca.config package
- foca.database package
- foca.errors package
- foca.factories package
- foca.models package
- Submodules
- foca.models.config module
APIConfigAccessControlConfigAccessControlConfig.api_specsAccessControlConfig.api_controllersAccessControlConfig.db_nameAccessControlConfig.collection_nameAccessControlConfig.modelAccessControlConfig.owner_headersAccessControlConfig.user_headersAccessControlConfig.api_controllersAccessControlConfig.api_specsAccessControlConfig.collection_nameAccessControlConfig.db_nameAccessControlConfig.modelAccessControlConfig.owner_headersAccessControlConfig.user_headersAccessControlConfig.validate_model_path()
AuthConfigAuthConfig.requiredAuthConfig.add_key_to_claimsAuthConfig.allow_expiredAuthConfig.audienceAuthConfig.claim_identityAuthConfig.claim_issuerAuthConfig.algorithmsAuthConfig.validation_methodsAuthConfig.validation_checksAuthConfig.add_key_to_claimsAuthConfig.algorithmsAuthConfig.allow_expiredAuthConfig.audienceAuthConfig.claim_identityAuthConfig.claim_issuerAuthConfig.requiredAuthConfig.validation_checksAuthConfig.validation_methods
CORSConfigCollectionConfigConfigDBConfigExceptionConfigExceptionConfig.required_membersExceptionConfig.extension_membersExceptionConfig.status_memberExceptionConfig.public_membersExceptionConfig.private_membersExceptionConfig.exceptionsExceptionConfig.loggingExceptionConfig.mappingExceptionConfig.exceptionsExceptionConfig.extension_membersExceptionConfig.loggingExceptionConfig.mappingExceptionConfig.private_membersExceptionConfig.public_membersExceptionConfig.required_membersExceptionConfig.status_memberExceptionConfig.validate_mapping()
ExceptionLoggingEnumFOCABaseConfigIndexConfigJobsConfigLogConfigLogFormatterConfigLogHandlerConfigLogRootConfigMongoConfigPymongoDirectionEnumPymongoDirectionEnum.ASCENDINGPymongoDirectionEnum.DESCENDINGPymongoDirectionEnum.GEO2DPymongoDirectionEnum.GEOHAYSTACKPymongoDirectionEnum.GEOSPHEREPymongoDirectionEnum.HASHEDPymongoDirectionEnum.TEXTPymongoDirectionEnum.ASCENDINGPymongoDirectionEnum.DESCENDINGPymongoDirectionEnum.GEO2DPymongoDirectionEnum.GEOHAYSTACKPymongoDirectionEnum.GEOSPHEREPymongoDirectionEnum.HASHEDPymongoDirectionEnum.TEXT
SecurityConfigServerConfigSpecConfigSpecConfig.pathSpecConfig.path_outSpecConfig.appendSpecConfig.add_operation_fieldsSpecConfig.add_security_fieldsSpecConfig.disable_authSpecConfig.connexionSpecConfig.add_operation_fieldsSpecConfig.add_security_fieldsSpecConfig.appendSpecConfig.connexionSpecConfig.disable_authSpecConfig.pathSpecConfig.path_outSpecConfig.set_abs_path()SpecConfig.set_default_out_path()
ValidationChecksEnumValidationMethodsEnum
- foca.security package
- foca.utils package
Submodules
foca.foca module
Class for setting up and initializing a FOCA-based microservice.
- class foca.foca.Foca(config_file: Path | None = None, custom_config_model: str | None = None)
Bases:
object- create_app() FlaskApp
Set up and initialize FOCA-based Connexion app.
- Returns:
Connexion application instance.
- create_celery_app() Celery
Set up and initialize FOCA-based Celery app.
- Returns:
Celery application instance.
foca.version module
Single source of truth for package version.