flexmeasures.api.v3_0
Modules
FlexMeasures API v3
Functions
- flexmeasures.api.v3_0.collapse_schema_to_field(spec: APISpec, schema_cls: Type[Schema], field_name: str) dict[str, Any]
Replace the OpenAPI component named after schema_cls with the OpenAPI schema generated for field_name inside that schema.
- flexmeasures.api.v3_0.create_openapi_specs(app: Flask)
Create OpenAPI specs for the API and save them to a JSON file in the static folder. This function should be called when generating docs (and needs extra dependencies).
- flexmeasures.api.v3_0.register_at(app: Flask)
This can be used to register this blueprint together with other api-related things
- flexmeasures.api.v3_0.register_swagger_ui(app: Flask)
Register the Swagger UI blueprint to view the OpenAPI specs.