Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Schema] Hazard object (i.e. hazard type and process) required in both event_set and event? #188

Closed
odscjen opened this issue Aug 10, 2023 · 3 comments

Comments

@odscjen
Copy link
Contributor

odscjen commented Aug 10, 2023

EDIT: a number of these where already being addressed in another PR #181

Noting a number of necessary minor schema changes that testing of the spreadsheet conversion has brought up.

* change version type from "number" to "string"

event_set.hazard_type is down as required, but it's not actually a field within event_set rather its a field within Hazard which is referenced in event_set.hazards. event.hazard is also down as required and events is required in event_set. We needed this info at both event_set and event level (as discussed in #91) but by having both as required it does mean we're asking people to duplicate info in multiple places in situations where the hazard type and process and intensity measure are the same for every event in the event_set. But maybe that's a price we have to pay to ensure it's included in at least one place? @matamadio @stufraser1 @duncandewhurst thoughts?

* Hazard has process as required but the field is actually processes

@odscjen odscjen created this issue from a note in 2023/24 Standard Development (Agreed and ready ) Aug 10, 2023
@odscjen odscjen moved this from Agreed and ready to Under discussion in 2023/24 Standard Development Aug 10, 2023
@duncandewhurst
Copy link
Contributor

These issues are addressed in #181. However, you're right that we do need to decide what to do about making hazards required on Event_set.

Personally, I favour fewer required fields to avoid creating unintended barriers to publication. Therefore, I would remove make hazards optional.

@odscjen odscjen changed the title [Schema] fixes from spreadsheet testing [Schema] Hazard object (i.e. hazard type and process) required in both event_set and event? Aug 11, 2023
@duncandewhurst
Copy link
Contributor

From today's check-in call with @matamadio and @odscrachel, we agreed that Event_set.hazards should be required and that it is OK for hazard data to be reported at both Event_set (summary) level and Event (detailed) level in the case where Event_set.events is provided.

We'll need to check and update the required fields and descriptions in the schema. Also noting the need to clearly explain the relationship between event sets and events in the documentation, which should be addressed by #178

@duncandewhurst duncandewhurst moved this from Under discussion to Agreed and ready in 2023/24 Standard Development Aug 15, 2023
@odscjen odscjen moved this from Agreed and ready to In progress in 2023/24 Standard Development Aug 15, 2023
@odscjen odscjen moved this from In progress to Review in progress in 2023/24 Standard Development Aug 15, 2023
@odscjen
Copy link
Contributor Author

odscjen commented Aug 21, 2023

this has now been dealt with in #181 and reviewing the descriptions they all seem to cover what was agreed so I'm closing this

@odscjen odscjen closed this as completed Aug 21, 2023
@odscjen odscjen moved this from Review in progress to Done in 2023/24 Standard Development Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
2 participants