Skip to content

Add ability to enumerate instances of types to returned JSONSchemas #518

@keithralphs

Description

@keithralphs

At the moment on the /plans and /plans/(name} endpoints, the returned JSONSchemas that describe the plan(s) provide the types of objects with bluesky interfaces (e.g. detectors, axes etc.) that represent items bluesky talks to rather than the enumerated names of these items. This is perfectly reasonable and suitable for the command line inteface, GDA etc., but is not ideal for generating basic UIs from plan descriptions via e.g. JSONForms. For this use case, a list of the names of the devices avaliable on the beamline rather than their type is what is required so that these can be automatically presented to the user for selection to be passed back when the form is submitted.

The capablity to present the information in this form should be added to the plans endpoints either as an option (.g. ?enumerated=true) or as a separate version of the endpoints to allow both the current and desired functionality to be supported. The extra information should probably be provided as well as rather than instead of the class names. This will allow the addition of a new plan to the beamline to automatically extend the range of basic web UIs available as well providing richer information for future fully fledged UIs, whilst still supporting existing interfaces.

Metadata

Metadata

Assignees

No one assigned

    Labels

    c: rest apiREST API changesc: uiTickets involved in producing a JSONForms UI from the plan schemasenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions