mxcubecore.queuelib.json_schema#

Generates the JSON Schema for the queue JSON format.

See JSON_FORMAT.md in this package for the format documentation. The schema returned by get_json_schema() is generated directly from the PyDantic models in models.py (via model_json_schema()).

Functions

get_json_schema()

Return the JSON Schema for queue_to_dict()'s root ("get the whole queue") response.

mxcubecore.queuelib.json_schema.get_json_schema() → dict[source]#

Return the JSON Schema for queue_to_dict()’s root (“get the whole queue”) response.

Returns:: a JSON Schema (draft 2020-12) dict.
Return type:: dict