You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It seems the right answer for many cases is the string 'external': 'FILESTORE:'
but I don't see this in the documentation. I would edit myself in a PR, but I don't know all the things that this was intended to take. The way I read datbroker.core._documents_to_xarray, it maybe doesn't matter what the value is, just that the field is there.
The text was updated successfully, but these errors were encountered:
dylanmcreynolds
changed the title
event descriptor documentation about external field
[DOCUMENTATION] event descriptor documentation about external field
Sep 30, 2020
The presence of the key 'external' indicates that the Events’ 'image' contains a reference to an asset outside the documents. (The value of that key is not currently used by any part of the system; only its existence is checked for. The value may be used in the futue as a hook for integration with outside systems.)
The description in the schema should be updated to reflect this.
Two pieces of documentation in this report could be clearer.
event-model/event_model/schemas/event_descriptor.json
Line 21 in 14b0826
https://github.com/bluesky/event-model/blob/master/docs/source/event-descriptors.rst
(optional) external --- a string specifying where external data, such as a large image array, is stored
It seems the right answer for many cases is the string
'external': 'FILESTORE:'
but I don't see this in the documentation. I would edit myself in a PR, but I don't know all the things that this was intended to take. The way I read datbroker.core._documents_to_xarray, it maybe doesn't matter what the value is, just that the field is there.
The text was updated successfully, but these errors were encountered: