Add GCN Circulars schema #154
Conversation
lpsinger
requested review from
jracusin,
Courey,
dakota002,
tylerbarna and
Vidushi-GitHub
| "title": "GCN Circular", | ||
| "description": "GCN Circulars are rapid astronomical bulletins submitted by and distributed to community members worldwide. They are used to share discoveries, observations, quantitative near-term predictions, requests for follow-up observations, or future observing plans related to high-energy, multi-messenger, and variable or transient astrophysical events. See https://gcn.nasa.gov/circulars", | ||
| "properties": { | ||
| "eventId": { |
There was a problem hiding this comment.
How about using event_name from Event Core Schema (https://github.com/nasa-gcn/gcn-schema/blob/v4.0.0/gcn/notices/core/Event.schema.json)?
It can be same property for both Circulars and Notices, helpful for correlation.
There was a problem hiding this comment.
We could, but we would need to migrate the whole GCN Circulars database if we changed field names.
There was a problem hiding this comment.
Ohh, may be one more translation layer can help later.
@jracusin what is your opinion keeping the name as available in Unified Schema or it's fine?
There was a problem hiding this comment.
I don't think we need a translation layer. I agree with you, @Vidushi-GitHub, that this schema is not very consistent with GCN Notices. We should discuss if and how we should achieve this transition.
| "type": "string", | ||
| "description": "Name, affiliation, and email address of the person who submitted the Circular, in the form `A. E. Einstein at IAS <[email protected]>`" | ||
| }, | ||
| "submittedHow": { |
There was a problem hiding this comment.
How about "submissionMethod"? sounds more appropriate
Co-authored-by: Vidushi Sharma <[email protected]>
Co-authored-by: Vidushi Sharma <[email protected]>
| }, | ||
| "submitter": { | ||
| "type": "string", | ||
| "description": "Name, affiliation, and email address of the person who submitted the Circular, in the form `A. E. Einstein at IAS <[email protected]>`" |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
This is not any kind of standard.
Co-authored-by: Tyler Barna <[email protected]>
Co-authored-by: Tyler Barna <[email protected]>
Co-authored-by: Tyler Barna <[email protected]>
Co-authored-by: Tyler Barna <[email protected]>
Co-authored-by: Tyler Barna <[email protected]>
|
Capturing the consensus from our sprint call: let's include this schema that describes the existing GCN Circulars record structure in the next minor release, and then migrate names of fields in the next major release. |
Add GCN Circulars schema
Description
Create a JSON Schema for GCN Circulars based on a recent example Circular.
Related Issue(s)
Fixes #152.
Testing
Added example for validation purposes.