mex.editor.api package

Submodules

mex.editor.api.main module

mex.editor.api.main.check_system_status() → SystemStatus

Check that the editor server is healthy and responsive.

mex.editor.api.main.get_prometheus_metrics() → str

Get connector metrics for prometheus.

mex.editor.api.models module

class mex.editor.api.models.SystemStatus(*, status: str, version: str)

Bases: BaseModel

Model for system status responses.

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[Dict[str, FieldInfo]] = {'status': FieldInfo(annotation=str, required=True), 'version': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

status: str

version: str

Module contents