From 5568de682e43ae825f73e8ed178f89b0d8e2ddd6 Mon Sep 17 00:00:00 2001 From: Leo Singer Date: Wed, 12 Jun 2024 13:32:42 -0400 Subject: [PATCH 1/8] Add GCN Circulars schema Fixes #152. --- gcn/circulars.example.json | 11 +++++++++++ gcn/circulars.schema.json | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 gcn/circulars.example.json create mode 100644 gcn/circulars.schema.json diff --git a/gcn/circulars.example.json b/gcn/circulars.example.json new file mode 100644 index 00000000..5501671a --- /dev/null +++ b/gcn/circulars.example.json @@ -0,0 +1,11 @@ +{ + "$schema": "https://gcn.nasa.gov/schema/main/gcn/circulars.schema.json", + "eventId": "GRB 230410A", + "submitter": "Fermi GBM Team at MSFC/Fermi-GBM ", + "submittedHow": "email-legacy", + "subject": "GRB 230410A: Fermi GBM Final Real-time Localization", + "circularId": 33603, + "format": "text/plain", + "body": "The Fermi GBM team reports the detection of a likely LONG GRB\\n\\nAt 11:26:00 UT on 10 Apr 2023, the Fermi Gamma-ray Burst Monitor (GBM) triggered and located GRB 230410A (trigger 702818765.135562 / 230410476).\\n\\nThe on-ground calculated location, using the Fermi GBM trigger data, is RA = 352.3, Dec = 22.9 (J2000 degrees, equivalent to J2000 23h 29m, 22d 53'), with a statistical uncertainty of 2.1 degrees.\\n\\nThe angle from the Fermi LAT boresight is 72.0 degrees.\\n\\nThe skymap can be found here:\\nhttps://heasarc.gsfc.nasa.gov/FTP/fermi/data/gbm/triggers/2023/bn230410476/quicklook/glg_skymap_all_bn230410476.png\\n\\nThe HEALPix FITS file, including the estimated localization systematic, can be found here:\\nhttps://heasarc.gsfc.nasa.gov/FTP/fermi/data/gbm/triggers/2023/bn230410476/quicklook/glg_healpix_all_bn230410476.fit\\n\\nThe GBM light curve can be found here:\\nhttps://heasarc.gsfc.nasa.gov/FTP/fermi/data/gbm/triggers/2023/bn230410476/quicklook/glg_lc_medres34_bn230410476.gif", + "createdOn": 1718212589034 +} diff --git a/gcn/circulars.schema.json b/gcn/circulars.schema.json new file mode 100644 index 00000000..50e7b031 --- /dev/null +++ b/gcn/circulars.schema.json @@ -0,0 +1,38 @@ +{ + "$id": "https://gcn.nasa.gov/schema/main/gcn/circulars.schema.json", + "$schema": "https://json-schema.org/draft/2020-12/schema", + "type": "object", + "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": { + "type": "string", + "description": "Event name, automatically inferred from the subject" + }, + "submitter": { + "type": "string", + "description": "Name, affiliation, and email address of the person who submitted the Circular, in the form `A. E. Einstein at IAS `" + }, + "submittedHow": { + "enum": ["web", "email", "email-legacy", "api"], + "description": "Submission method" + }, + "subject": { + "type": "string", + "description": "Subject line" + }, + "circularId": { + "type": "number", + "description": "Circular ID assign in the GCN Ciculars archive. Increments by 1 for each published Circular" + }, + "format": { + "enum": ["text/plain", "text/markdown"], + "description": "Format of the body text as a MIME type" + }, + "body": { "type": "string", "description": "Body text" }, + "createdOn": { + "type": "number", + "description": "Date accepted into GCN Circular archive as milliseconds since the UNIX epoch" + } + } +} From 7debb9a103f7fa4c8439210b5fd3b1bb942b32e5 Mon Sep 17 00:00:00 2001 From: Leo Singer Date: Thu, 13 Jun 2024 14:11:14 -0400 Subject: [PATCH 2/8] Update gcn/circulars.schema.json Co-authored-by: Vidushi Sharma <103223246+Vidushi-GitHub@users.noreply.github.com> --- gcn/circulars.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gcn/circulars.schema.json b/gcn/circulars.schema.json index 50e7b031..be487f89 100644 --- a/gcn/circulars.schema.json +++ b/gcn/circulars.schema.json @@ -19,7 +19,7 @@ }, "subject": { "type": "string", - "description": "Subject line" + "description": "Subject line of the Circular" }, "circularId": { "type": "number", From df3f78610c86ce7e8d82824cd172c8f5e4fb48d9 Mon Sep 17 00:00:00 2001 From: Leo Singer Date: Thu, 13 Jun 2024 14:11:25 -0400 Subject: [PATCH 3/8] Update gcn/circulars.schema.json Co-authored-by: Vidushi Sharma <103223246+Vidushi-GitHub@users.noreply.github.com> --- gcn/circulars.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gcn/circulars.schema.json b/gcn/circulars.schema.json index be487f89..c01d188b 100644 --- a/gcn/circulars.schema.json +++ b/gcn/circulars.schema.json @@ -15,7 +15,7 @@ }, "submittedHow": { "enum": ["web", "email", "email-legacy", "api"], - "description": "Submission method" + "description": "Specifies the method by which the user submitted the Circular" }, "subject": { "type": "string", From f850eb8f4948295edd1021d8bcbef2621fe53f94 Mon Sep 17 00:00:00 2001 From: Leo Singer Date: Sun, 16 Jun 2024 13:52:48 -0400 Subject: [PATCH 4/8] Update gcn/circulars.schema.json Co-authored-by: Tyler Barna <57914086+tylerbarna@users.noreply.github.com> --- gcn/circulars.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gcn/circulars.schema.json b/gcn/circulars.schema.json index c01d188b..e6f7d795 100644 --- a/gcn/circulars.schema.json +++ b/gcn/circulars.schema.json @@ -3,7 +3,7 @@ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "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", + "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. An archive of all GCN Circulars can be found at https://gcn.nasa.gov/circulars", "properties": { "eventId": { "type": "string", From c0adb1fa6ca27bd2d9eb65f196d75e7ac1d9415c Mon Sep 17 00:00:00 2001 From: Leo Singer Date: Sun, 16 Jun 2024 13:53:07 -0400 Subject: [PATCH 5/8] Update gcn/circulars.schema.json Co-authored-by: Tyler Barna <57914086+tylerbarna@users.noreply.github.com> --- gcn/circulars.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gcn/circulars.schema.json b/gcn/circulars.schema.json index e6f7d795..8c66ee19 100644 --- a/gcn/circulars.schema.json +++ b/gcn/circulars.schema.json @@ -32,7 +32,7 @@ "body": { "type": "string", "description": "Body text" }, "createdOn": { "type": "number", - "description": "Date accepted into GCN Circular archive as milliseconds since the UNIX epoch" + "description": "Date and time the Circular is accepted and published onto the GCN Circular archive, formatted as a UNIX timestamp (milliseconds since the UNIX epoch)" } } } From 5e789e9e84fde45e7050b1cb927af2f63a478aa4 Mon Sep 17 00:00:00 2001 From: Leo Singer Date: Sun, 16 Jun 2024 13:53:34 -0400 Subject: [PATCH 6/8] Update gcn/circulars.schema.json Co-authored-by: Tyler Barna <57914086+tylerbarna@users.noreply.github.com> --- gcn/circulars.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gcn/circulars.schema.json b/gcn/circulars.schema.json index 8c66ee19..b68b904a 100644 --- a/gcn/circulars.schema.json +++ b/gcn/circulars.schema.json @@ -27,7 +27,7 @@ }, "format": { "enum": ["text/plain", "text/markdown"], - "description": "Format of the body text as a MIME type" + "description": "Format of the body text as a MIME type. See https://gcn.nasa.gov/docs/circulars/markdown for documentation on using Markdown in Circulars" }, "body": { "type": "string", "description": "Body text" }, "createdOn": { From 0d8b32a4262f92c9da6bf5ccc44049be7cecda41 Mon Sep 17 00:00:00 2001 From: Leo Singer Date: Sun, 16 Jun 2024 13:53:57 -0400 Subject: [PATCH 7/8] Update gcn/circulars.schema.json Co-authored-by: Tyler Barna <57914086+tylerbarna@users.noreply.github.com> --- gcn/circulars.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gcn/circulars.schema.json b/gcn/circulars.schema.json index b68b904a..681dd8c0 100644 --- a/gcn/circulars.schema.json +++ b/gcn/circulars.schema.json @@ -23,7 +23,7 @@ }, "circularId": { "type": "number", - "description": "Circular ID assign in the GCN Ciculars archive. Increments by 1 for each published Circular" + "description": "Circular ID assigned to the Circular in the GCN Circulars archive. This value is unique to each published Circular and increments by 1" }, "format": { "enum": ["text/plain", "text/markdown"], From 0b9aab4ea2b72f2ba02bb04fc0d27e7e79c8396e Mon Sep 17 00:00:00 2001 From: Leo Singer Date: Mon, 17 Jun 2024 14:00:01 -0400 Subject: [PATCH 8/8] Update gcn/circulars.schema.json Co-authored-by: Tyler Barna <57914086+tylerbarna@users.noreply.github.com> --- gcn/circulars.schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gcn/circulars.schema.json b/gcn/circulars.schema.json index 681dd8c0..9ddc12b9 100644 --- a/gcn/circulars.schema.json +++ b/gcn/circulars.schema.json @@ -32,7 +32,7 @@ "body": { "type": "string", "description": "Body text" }, "createdOn": { "type": "number", - "description": "Date and time the Circular is accepted and published onto the GCN Circular archive, formatted as a UNIX timestamp (milliseconds since the UNIX epoch)" + "description": "Date and time the Circular is accepted and published onto the GCN Circulars archive, formatted as a UNIX timestamp (milliseconds since the UNIX epoch)" } } }