reserve time and seq_num keys

bluesky / event-model

data model for event-based data collection and analysis

https://blueskyproject.io/event-model

BSD 3-Clause "New" or "Revised" License

13 stars 30 forks source link

reserve time and seq_num keys #223

Open gwbischof opened 2 years ago

gwbischof commented 2 years ago

user-defined data_keys called "time" or "seq_num" conflict with with bluesky generated keys of the same name. This PR reserves this keys, preventing users from using them.

gwbischof commented 2 years ago

This is a useful stackoverflow post about using not in jsonschema: https://stackoverflow.com/questions/61059683/how-to-conditionally-forbid-properties-based-on-presence-of-other-properties-in/61062869#61062869

tacaswell commented 2 years ago

Do we have any users currently using them?

dmgav commented 2 years ago

@tacaswell https://github.com/NSLS-II-SRX/profile_collection/blob/06b6d22ba27f75ff1b775c794f68889a02278be3/startup/32-zebra.py#L847

danielballan commented 2 years ago

The intent is to pair this with a migration tool (similar to "shape fixer") to alter the names on existing data.

danielballan commented 1 year ago

This needs:

[ ] a substantial rebase, as the system for encoding schemas has evolved substantially
[ ] a clear story for how to deal with existing usage