foca.api package

Submodules

foca.api.register_openapi module

Register and modify OpenAPI specifications.

foca.api.register_openapi.register_openapi(app: FlaskApp, specs: List[SpecConfig]) → FlaskApp

Register OpenAPI specifications with Connexion application instance.

Parameters:

  • app – Connexion application instance.

  • specs – Sequence of foca.models.config.SpecConfig instances describing OpenAPI 2.x and/or 3.x specifications to be registered with app.

Returns:

Connexion application instance with registered OpenAPI specifications.

Raises:

  • OSError – Modified specification cannot be written.

  • yaml.YAMLError – Modified specification cannot be serialized.