mex.editor.api package

Submodules

mex.editor.api.main module

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

Bases: BaseModel

Response model for system status check.

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)}

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

This replaces Model.__fields__ from Pydantic V1.

status: str

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

Check that the backend server is healthy and responsive.

Module contents