-
Notifications
You must be signed in to change notification settings - Fork 22
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
Add schema for the 1st SVOM notices (ECLAIRs, GRM & MXT) #245
base: main
Are you sure you want to change the base?
Conversation
{ | ||
"$id": "https://gcn.nasa.gov/schema/main/gcn/notices/svom/eclairs/eclairs.schema.json", | ||
"$schema": "https://json-schema.org/draft/2020-12/schema", | ||
"type": "object", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For one schema and multiple notices, add "notice_type"
"notice_type": {
"type": "string",
"enum": [
"trigger",
"catalog",
"wakeup"
],
"description": "..."
},
A bit more organized, according you need.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks neat.
As discussed, please feel free to use "notice_type" with "enum", when you are producing multiple notices with the use of one schema.
"$schema": true, | ||
"slew_status": { | ||
"enum": ["accepted", "rejected", "not_requested"], | ||
"description": "Whether the platform accepted or rejected a slew requested by ECLAIRs (to its best localisation). If the detection is not significant enough, this value can remain to 'not_requested'" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"description": "Whether the platform accepted or rejected a slew requested by ECLAIRs (to its best localisation). If the detection is not significant enough, this value can remain to 'not_requested'" | |
"description": "Whether the platform accepted or rejected a slew requested by ECLAIRs (to its best localisation). If the detection is not significant enough, this value is 'not_requested'." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a simple prescription for the significance or a document you can reference where it's described?
"properties": { | ||
"$schema": true, | ||
"triggered_GRDs": { | ||
"type": "array", | ||
"items": { "type": "boolean" }, | ||
"minItems": 3, | ||
"maxItems": 3, | ||
"description": "In case of a GRM trigger, trigger status the 3 GRDs. Each item correspond to one of the 3 GRDs: true means the GRD triggers, false not." | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider using the DetectorStatus core schema.
This PR introduce the SVOM notices in the common JSON format used by the NASA/GCN system.
It replaces the json schemas previously defined for SVOM notices as it was too complicated. Instead we simplify it by defining 3 schemas based on the SVOM instruments. Different notice examples are also included to illustrates the different notice subtypes.