Apps for YAML schemas
We need to ensure that app definitions targeting quantities in YAML schemas can be created.
Tasks
-
An app definition should be able to explicitly say which YAML schema(s) it depends on -
When loading the app, the referenced definitions will be fetched over the network and added to the available filters -
The final API call will need contain the data type (int, float, str, datetime), because our backend is stateless and does not have the definitions for YAML schemas loaded to know the data type. -
Widgets can be configured for scalar quantities within a schema -
Result columns can target scalar quantities -
Result columns can be sorted by scalar quantity
Thoughts
- When the app is required to explicitly specify the YAML schema(s) it depends on, loading the definitions (=downloading typically on smallish .yaml file) should be perfectly doable during the app boot-up. Once we have the full definition available, we will know the types, descriptions etc. and in the UI we can treat the quantities just like quantities coming from python schemas. Only the underlying API call / URL serialization will differ as it will include the data type in the quantity name.
- Quantities from YAML schemas will not be visible in apps that do not target them explicitly. Maybe this is better as we don't clutter the suggestions etc. as much?
- The API expects that any references to YAML quantities in the request include the data type. This way it can fetch all information on the fly without loading any definitions. Note that in the response, the data type is not used.
Edited by Lauri Himanen