Release History¶

v0.0.12 (2024-07-25)¶

Added ., @, -, and +, to the allowed character list of BasicAPIAccessControl and DictionaryAPIAccessControl username validations.

New API: /config_get, /queue/autostart, /environment/update, /kernel/interrupt.

The parameters passed using the environment variables QSERVER_ZMQ_CONTROL_ADDRESS, QSERVER_ZMQ_INFO_ADDRESS, QSERVER_ZMQ_PUBLIC_KEY and QSERVER_HTTP_CUSTOM_ROUTERS can now be passed in the configuration YML file.

New parameters of LDAPAuthenticator: connect_timeout, receive_timeout.
Implementation of framework for API and resource access control.
Implementation of simple API access control policies: BasicAPIAccessControl and DictionaryAPIAccessControl.
Implementation of a simple resource access control policy: DefaultResourceAccessControl.

LDAPAuthenticator is not blocking the server event loop while waiting for the response from the server.
LDAPAuthenticator now works with the pool of LDAP servers. The parameter server_address accepts a string representing a single server or a list of strings representing multiple servers.

Support for custom routers. The list of routers is provided by environment variable QSERVER_HTTP_CUSTOM_ROUTERS. A router is specified as <module_name>.<router_name>. Multiple routers are separated by colon or comma, e.g. QSERVER_HTTP_CUSTOM_ROUTERS=module.one.router:module.two.router:module.three.router. The server fails to start if loading of any of the listed routers fails.
Initial implementation of basic authentication. The authentication API may change in future releases.

Implemented support for standard environment variable names. Old names are deprecated and will be removed in the future. The following environment variables are supported:
- QSERVER_ZMQ_CONTROL_ADDRESS - address of the control socket of RE Manager;
- QSERVER_ZMQ_INFO_ADDRESS - address of the socket used for publishing console output;
- QSERVER_ZMQ_PUBLIC_KEY - public key for encrypted communication with RE Manager.
The server is now started a uvicorn bluesky_httpserver.server:app --host localhost --port 60610.
Prefix /api is added to all REST API, e.g. /status is now /api/status.
Changed /queue/item/get, /permissions/get, /task/status and /task/result API from POST to GET.

console_output_update endpoint for monitoring of console output in polling mode.

New API /re/runs, which combines already existing /re/runs/active, /re/runs/open and /re/runs/closed.
New API: The following API were added: plans_existing, devices_existing, permissions_get, permissions_set, script_upload, function_execute, task_status, task_result.
New API: /console_output and /console_output/uid for polling console output of RE Manager.

/plans/allowed API now accepts an optional parameter reduced. If "reduced": True, then the simplified version of plan descriptions that could be more convenient for web applications are returned, otherwise full descriptions are returned. Previously the API always returned simplified descriptions.
HTTP Server is now using bluesky-queueserver-api for most of communication with RE Manager.

New stream_console_output API for streaming console output captured by RE Manager.