v2.0.0 - Githubissues

hubverse-org / schemas

JSON schemas for modeling hubs

Creative Commons Zero v1.0 Universal

4 stars 3 forks source link

v2.0.0 #59

Closed annakrystalli closed 1 year ago

annakrystalli commented 1 year ago

Major breaking change: Output type property type_id renamed to output_type_id for consistency in with changes in model output data (Resolves #55).
Added uniqueItem checks to all optional and required arrays (Resolves #43).
Added a schema to task_ids additionalProperty property instead of just setting it to true. This schema ensures that any custom task IDs added by hub administrators at least checked for being objects and having optional and required properties that are either arrays or null (Resolves #54).
Added standard task IDs forecast_date (equivalent to origin_date), target_end_date (equivalent to target_date) (Resolves #53).
Resolves #44
Resolves #29
Adds some better examples to target task ID.

annakrystalli commented 1 year ago

Let me know if you would also like me to include #29 in this PR.

I would particularly appreciate review on addition of forecast_date https://github.com/Infectious-Disease-Modeling-Hubs/schemas/blob/73b964ed73c5adc20a7a304fc59d89173c336032/v2.0.0/tasks-schema.json#L93-L134

and target_end_date https://github.com/Infectious-Disease-Modeling-Hubs/schemas/blob/73b964ed73c5adc20a7a304fc59d89173c336032/v2.0.0/tasks-schema.json#L360-L401

I've effectively assumed they are equivalent to origin_date and target_date so I have just slightly amended those task id descriptions. So please let me know if that is inaccurate and if so what better descriptions would be. 🙏

Also, if there are any data types associated with any of the current standard task IDs that don't look right / need changes also let me know.

And any other comments welcome! Good opportunity to correct anything that's been bugging us!

elray1 commented 1 year ago

would it be worth tackling #44 as part of this?

annakrystalli commented 1 year ago

OK! I've incorporated all issues I could. Note I had to backtrack on #44 (details in issue) but feel we should close it.

If you are happy, feel free to leave an approving review and I will go ahead and merge.

annakrystalli commented 1 year ago

Morning @nickreich & @elray1 ,

Any chance you could give the OK on this PR? I need to release this before I can update all test materials and test snapshots in hubUtils with respect to the breaking output_type_id change.

The most useful feedback would most likely be on this commit: 12a654f8b28f962a6978819c5fc8e6c9a9817fd8

Also, I'm hoping you're ok with addressing #48 in the next schema version after validation work?