Review the schemas of Stream Resource and Stream Datum documents to facilitate storage and client access.
Description
[x] Remove path_semantics from Stream Resource and Stream Datum schemas.
[x] Replace root and resource_path with uri. It may be a path on the local filesystem, file://localhost/{path}, a path on a shared filesystem file://{host}/{path}, to be remapped at read time via local mount config, or a non-file-based resource like s3://....
[x] Rename spec to mimetype and use MIME type values like application/x-hdf5. It is expected that any information about options like SWMR will be passed in the resource_kwargs (parameters, see below).
[x] Rename resource_kwargs to parameters. The word resource_ is a bit redundant here, and the word kwargs is a Python-ism.
Motivation and Context
This PR is based on the discussion and agreed recommendations made in Issue #296. The main motivation is to simplify and future-proof the access to data by consumers and clients, such as Tiled.
How Has This Been Tested?
Using existing tests (with renamed/replaced variables).
Review the schemas of Stream Resource and Stream Datum documents to facilitate storage and client access.
Description
path_semantics
fromStream Resource
andStream Datum
schemas.root
andresource_path
withuri
. It may be a path on the local filesystem,file://localhost/{path}
, a path on a shared filesystemfile://{host}/{path}
, to be remapped at read time via local mount config, or a non-file-based resource likes3://...
.spec
tomimetype
and use MIME type values likeapplication/x-hdf5
. It is expected that any information about options like SWMR will be passed in theresource_kwargs
(parameters
, see below).resource_kwargs
toparameters
. The wordresource_
is a bit redundant here, and the wordkwargs
is a Python-ism.Motivation and Context
This PR is based on the discussion and agreed recommendations made in Issue #296. The main motivation is to simplify and future-proof the access to data by consumers and clients, such as Tiled.
How Has This Been Tested?
Using existing tests (with renamed/replaced variables).