search

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

issues around required projections schema field "configuration" #206

Open dylanmcreynolds opened 3 years ago

dylanmcreynolds commented 3 years ago

The schema for projections requires a field called "configuration" be added at the top level of the projection: https://github.com/bluesky/event-model/blob/9d3651ef8a4d8e2c3f046524c92bd5ff0ceefa2d/event_model/schemas/run_start.json#L75.

This was intended to be a field to be used to help describe and potentially select a projection, but the fact that it required is a bit annoying and confusing to be implementing projections.

Either it should be better described in documentation or made not required.

danielballan commented 3 years ago

I would support making that optional.

I guess the tension is between "Make the minimal example simple" and "Avoid hiding features people might soon need when they get beyond the minimal example." But I lean toward making it optional in this case.