@nasa-gcn/schema 4.1.0

package/.github/auto_request_review.yml

@@ -0,0 +1,12 @@
+# The format of this file is described at
+# https://github.com/necojackarc/auto-request-review#reviewers-configuration.
+
+files:
+  '**':
+    - team:maintainers
+  'gcn/notices/glowbug/**':
+    - shb46
+  'gcn/notices/icecube/**':
+    - blaufuss
+  'gcn/notices/swift/**':
+    - Tohuvavohu

package/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: weekly

package/.github/workflows/release.yml

@@ -0,0 +1,27 @@
+name: Main
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  github:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Release
+        uses: softprops/action-gh-release@v2
+  npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/review.yml

@@ -0,0 +1,15 @@
+name: Auto Request Review
+
+on:
+  pull_request:
+    types: [opened, ready_for_review, reopened]
+
+jobs:
+  auto-request-review:
+    name: Auto Request Review
+    runs-on: ubuntu-latest
+    steps:
+      - name: Request review based on files changes and/or groups the author belongs to
+        uses: necojackarc/auto-request-review@v0.10.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/validate.yml

@@ -0,0 +1,32 @@
+name: Validate
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  test:
+    uses: nasa-gcn/.github/.github/workflows/node.yml@main
+    with:
+      test-options:
+  bump:
+    name: dry run of version bump
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+      - name: Configure git identity
+        run: |
+          git config --global user.email "you@example.com"
+          git config --global user.name "Your Name"
+      - name: Install package
+        run: npm ci
+      - name: Bump version
+        run: npm version patch
+      - name: Run validation
+        run: npm test

package/.husky/pre-commit

@@ -0,0 +1 @@
+lint-staged

package/README.md

@@ -0,0 +1,36 @@
+# GCN Schema
+
+This repository contains the schemas for crafting new GCN notices. It also includes mission-specific schemas and illustrative examples, which are distributed by [GCN Kafka](https://gcn.nasa.gov). The formulation of mission schemas is one step in the process for setting up [New Notice Producers](https://gcn.nasa.gov/docs/producers).
+
+The alert format for new Notices over GCN Kafka is JavaScript Object Notation (JSON), a widely adopted Internet data format. We have designed a set of core schema which serve as the building blocks for new GCN Notices. Instrument-specific schema can also be created, but we request that you utilize the core schema as much as possible.
+
+Please add your schema to this repository under <code>gcn/notices/<i>mission</i>/</code> and submit a pull request for the GCN Team to review. The GCN team is happy to iterate with the producers on their schema contents and format. Your pipeline will generate JSON files following these schema and send alerts to GCN as described in [New Notice Producers](https://gcn.nasa.gov/docs/notices/producers).
+
+## How To Release
+
+1.  Clone the parent repo (nasa-gcn/gcn-schema).
+
+        git clone git@github.com:nasa-gcn/gcn-schema.git
+        cd gcn-schema
+
+2.  Install necessary npm packages
+
+        npm install
+
+3.  Tag a new version by running the following command: `npm version [ major | minor | patch ]`. Choose `major`, `minor`, or `patch` depending on the kind of update according to [Semantic Versioning](https://semver.org) rules.
+
+    This command will handle the intermediate steps of updating and committing the path changes in each file as defined in the `version` and `postversion` npm scripts
+
+4.  Review the changes with `git log -p` to make sure that each file is appropriately updated.
+
+5.  Finally, push both the commit and the tag:
+
+        git push && git push origin <tag name>
+
+This will make the release available for use. For subsequent releases:
+
+1.  Pull the latest state of the main branch
+
+        git pull
+
+2.  Follow the above steps from Step 3 on.

package/gcn/circulars.example.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://gcn.nasa.gov/schema/v4.1.0/gcn/circulars.schema.json",
+  "eventId": "GRB 230410A",
+  "submitter": "Fermi GBM Team at MSFC/Fermi-GBM <do_not_reply@GIOC.nsstc.nasa.gov>",
+  "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
+}

package/gcn/circulars.schema.json

@@ -0,0 +1,46 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/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. An archive of all GCN Circulars can be found at 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 <albert.einstein@example.edu>`"
+    },
+    "submittedHow": {
+      "enum": ["web", "email", "email-legacy", "api"],
+      "description": "Specifies the method by which the user submitted the Circular"
+    },
+    "subject": {
+      "type": "string",
+      "description": "Subject line of the Circular"
+    },
+    "circularId": {
+      "type": "number",
+      "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"],
+      "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": {
+      "type": "number",
+      "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)"
+    }
+  },
+  "required": [
+    "eventId",
+    "submitter",
+    "subject",
+    "circularId",
+    "body",
+    "createdOn"
+  ]
+}

package/gcn/notices/burstcube/alert.example.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/burstcube/alert.schema.json",
+  "alert_datetime": "2024-06-01T00:05:00.00Z",
+  "alert_tense": "current",
+  "alert_type": "initial",
+  "mission": "BurstCube",
+  "record_number": 1,
+  "trigger_time": "2024-06-01T00:00:00.0Z",
+  "id": ["240601000"],
+  "ra": 232,
+  "dec": -53.1,
+  "ra_dec_error": 10,
+  "containment_probability": 0.9,
+  "systematic_included": false,
+  "healpix_url": "https://heasarc.gsfc.nasa.gov/burstcube/trigger/240601000/current/240601000_locmap.fits",
+  "healpix_file": "stuff",
+  "rate_snr": 7.2,
+  "rate_duration": 1.024,
+  "rate_energy_range": [50, 300],
+  "classification": { "GRB": 0.95, "SF": 0.03, "Local Particles": 0.02 },
+  "t90": 2.3,
+  "t90_error": [0.1],
+  "detector_status": {
+    "CsI0": "triggered",
+    "CsI1": "triggered",
+    "CsI2": "on",
+    "CsI3": "on"
+  }
+}

package/gcn/notices/burstcube/alert.schema.json

@@ -0,0 +1,27 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/burstcube/alert.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Alert",
+  "description": "BurstCube Trigger Alert",
+  "type": "object",
+  "allOf": [
+    { "$ref": "../core/Alert.schema.json" },
+    { "$ref": "../core/Reporter.schema.json" },
+    { "$ref": "../core/DateTime.schema.json" },
+    { "$ref": "../core/Event.schema.json" },
+    { "$ref": "../core/Localization.schema.json" },
+    { "$ref": "../core/Statistics.schema.json" },
+    { "$ref": "../core/Duration.schema.json" }
+  ],
+  "properties": {
+    "detector_status": {
+      "type": "object",
+      "properties": {
+        "CsI0": { "$ref": "../core/DetectorStatus.schema.json" },
+        "CsI1": { "$ref": "../core/DetectorStatus.schema.json" },
+        "CsI2": { "$ref": "../core/DetectorStatus.schema.json" },
+        "CsI3": { "$ref": "../core/DetectorStatus.schema.json" }
+      }
+    }
+  }
+}

package/gcn/notices/burstcube/test.example.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/burstcube/test.schema.json",
+  "alert_datetime": "2024-06-01T00:05:00.00Z",
+  "alert_tense": "current",
+  "alert_type": "initial",
+  "mission": "BurstCube",
+  "record_number": 1,
+  "trigger_time": "2024-06-01T00:00:00.0Z",
+  "id": ["240601000"],
+  "ra": 232,
+  "dec": -53.1,
+  "ra_dec_error": 10,
+  "containment_probability": 0.9,
+  "systematic_included": false,
+  "healpix_url": "https://heasarc.gsfc.nasa.gov/burstcube/trigger/240601000/current/240601000_locmap.fits",
+  "healpix_file": "stuff",
+  "rate_snr": 7.2,
+  "rate_duration": 1.024,
+  "rate_energy_range": [50, 300],
+  "classification": { "GRB": 0.95, "SF": 0.03, "Local Particles": 0.02 },
+  "t90": 2.3,
+  "t90_error": [0.1],
+  "detector_status": {
+    "CsI0": "triggered",
+    "CsI1": "triggered",
+    "CsI2": "on",
+    "CsI3": "on"
+  }
+}

package/gcn/notices/burstcube/test.schema.json

@@ -0,0 +1,27 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/burstcube/test.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Alert",
+  "description": "BurstCube Trigger Alert",
+  "type": "object",
+  "allOf": [
+    { "$ref": "../core/Alert.schema.json" },
+    { "$ref": "../core/Reporter.schema.json" },
+    { "$ref": "../core/DateTime.schema.json" },
+    { "$ref": "../core/Event.schema.json" },
+    { "$ref": "../core/Localization.schema.json" },
+    { "$ref": "../core/Statistics.schema.json" },
+    { "$ref": "../core/Duration.schema.json" }
+  ],
+  "properties": {
+    "detector_status": {
+      "type": "object",
+      "properties": {
+        "CsI0": { "$ref": "../core/DetectorStatus.schema.json" },
+        "CsI1": { "$ref": "../core/DetectorStatus.schema.json" },
+        "CsI2": { "$ref": "../core/DetectorStatus.schema.json" },
+        "CsI3": { "$ref": "../core/DetectorStatus.schema.json" }
+      }
+    }
+  }
+}

package/gcn/notices/core/AdditionalInfo.schema.json

@@ -0,0 +1,13 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/core/AdditionalInfo.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "title": "Comments",
+  "description": "Comments that are not summarized elsewhere in schema",
+  "properties": {
+    "additional_info": {
+      "type": "string",
+      "description": "Additional information about the event"
+    }
+  }
+}

package/gcn/notices/core/Alert.schema.json

@@ -0,0 +1,28 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/core/Alert.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Alert",
+  "description": "Alert Information description properties of this notice",
+  "type": "object",
+  "properties": {
+    "alert_datetime": {
+      "type": "string",
+      "description": "Date and time of notice creation [UTC, ISO 8601], ex YYYY-MM-DDTHH:MM:SS.ssssssZ"
+    },
+    "alert_tense": {
+      "enum": [
+        "current",
+        "archival",
+        "planned",
+        "injection",
+        "commanded",
+        "test"
+      ],
+      "description": "Indication of whether this alert refers to a recent observation (current), re-analysis of archival data (archival), a planned observation in the future (planned), a signal injection (injection), commanded trigger (commanded) or a test trigger (test)."
+    },
+    "alert_type": {
+      "enum": ["initial", "update", "retraction"],
+      "description": "Indication of alert sequence if multiple of same type sent"
+    }
+  }
+}

package/gcn/notices/core/DateTime.schema.json

@@ -0,0 +1,25 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/core/DateTime.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "DateTime",
+  "description": "Time descriptions of transient event and observation",
+  "type": "object",
+  "properties": {
+    "trigger_time": {
+      "type": "string",
+      "description": "Time of the trigger [ISO 8601], ex YYYY-MM-DDTHH:MM:SS.ssssssZ"
+    },
+    "observation_start": {
+      "type": "string",
+      "description": "Start time of the observation [ISO 8601]"
+    },
+    "observation_stop": {
+      "type": "string",
+      "description": "Stop time of the observation [ISO 8601]"
+    },
+    "observation_livetime": {
+      "type": "number",
+      "description": "Livetime of the observation [s]"
+    }
+  }
+}

package/gcn/notices/core/DetectorStatus.schema.json

@@ -0,0 +1,7 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/core/DetectorStatus.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "DetectorStatus",
+  "enum": ["on", "off", "triggered"],
+  "description": "Status of a specified detector at the time of the alert"
+}

package/gcn/notices/core/Distance.schema.json

@@ -0,0 +1,19 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/core/Distance.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "title": "Distance",
+  "description": "Luminosity Distance",
+  "properties": {
+    "luminosity_distance": {
+      "type": "number",
+      "description": "Luminosity distance [Mpc]"
+    },
+    "luminosity_distance_error": {
+      "type": "array",
+      "items": { "type": "number" },
+      "maxItems": 2,
+      "description": "Luminosity distance uncertainty [Mpc, 1-sigma], with optional asymmetric uncertainty"
+    }
+  }
+}

package/gcn/notices/core/Duration.schema.json

@@ -0,0 +1,28 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/core/Duration.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "title": "Duration",
+  "properties": {
+    "t90": {
+      "type": "number",
+      "description": "Time duration of central 90% of integrated fluence [s]"
+    },
+    "t90_error": {
+      "type": "array",
+      "items": { "type": "number" },
+      "maxItems": 2,
+      "description": "1-sigma uncertainty of the T90 duration [s], with asymmetric statistical errors taken into account"
+    },
+    "t50": {
+      "type": "number",
+      "description": "Time duration of central 50% of integrated fluence [s]"
+    },
+    "t50_error": {
+      "type": "array",
+      "items": { "type": "number" },
+      "maxItems": 2,
+      "description": "1-sigma uncertainty of the T50 duration [s], with asymmetric statistical errors taken into account"
+    }
+  }
+}

package/gcn/notices/core/Event.schema.json

@@ -0,0 +1,23 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/core/Event.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "title": "Event Information",
+  "description": "Name or names of the event",
+  "properties": {
+    "event_name": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Name of the event (ex: GRB 170817A, GW170817, AT2017gfo, SSS 17a)"
+    },
+    "id": {
+      "type": "array",
+      "items": { "oneOf": [{ "type": "string" }, { "type": "number" }] },
+      "description": "Instrument-specific trigger ID (ex: bn230313485 (Fermi), 1159327 (Swift)) or alternate ID"
+    },
+    "data_archive_page": {
+      "type": "string",
+      "description": "URL of archived data files"
+    }
+  }
+}

package/gcn/notices/core/FollowUp.schema.json

@@ -0,0 +1,26 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/core/FollowUp.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "FollowUp",
+  "description": "Schema specific to follow-up cases",
+  "type": "object",
+  "properties": {
+    "ref_type": {
+      "type": "string",
+      "description": "Type of the event detected, ex. GRB, GW, neutrino"
+    },
+    "ref_instrument": {
+      "type": "string",
+      "description": "Name of the reference mission or, instrument, ex. Fermi-GBM"
+    },
+    "ref_ID": {
+      "type": "string",
+      "description": "Trigger ID as reported by the reference instrument, ex. bnYYMMDDFF"
+    },
+    "reference": {
+      "type": "object",
+      "additionalProperties": { "type": ["number", "string"] },
+      "description": "Reference as distributed by the notices or circulars or ATel, ex. gcn circulars: 12345, gcn.notices.LVK.alert: SYYMMDDak-2-preliminary. "
+    }
+  }
+}

package/gcn/notices/core/GeoLocBase.schema.json

@@ -0,0 +1,26 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/core/GeoLocBase.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Spacecraft Geolocation and McIlwain L",
+  "description": "Enables GCN providers to include spacecraft geolocation and McIlwain L-Parameter.",
+  "type": "object",
+  "properties": {
+    "latitude": {
+      "type": "number",
+      "description": "Geocentric latitude [deg]"
+    },
+    "longitude": {
+      "type": "number",
+      "description": "Geocentric longitude [deg]"
+    },
+    "altitude": {
+      "type": "number",
+      "description": "Distance from the surface of the Earth [km]."
+    },
+    "mcilwain_l": { "type": "number", "description": "McIlwain L-parameter" },
+    "geoloc_time": {
+      "type": "string",
+      "description": "Time [UTC, ISO 8601] of the geolocation and McIlwain L-parameter, if different than the trigger time."
+    }
+  }
+}

package/gcn/notices/core/HardnessRatio.schema.json

@@ -0,0 +1,33 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/core/HardnessRatio.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "title": "HardnessRatio",
+  "description": "Hardness Ratio parameterization",
+  "properties": {
+    "hardness_ratio": {
+      "type": "number",
+      "description": "ratio of flux between high and low energy bands"
+    },
+    "hardness_ratio_error": {
+      "type": "array",
+      "items": { "type": "number" },
+      "maxItems": 2,
+      "description": "ratio of flux between high and low energy bands, with asymmetric statistical errors taken into account"
+    },
+    "energy_range_soft": {
+      "type": "array",
+      "items": { "type": "number" },
+      "description": "Energy range [keV] used in soft band of hardness ratio",
+      "minItems": 2,
+      "maxItems": 2
+    },
+    "energy_range_hard": {
+      "type": "array",
+      "items": { "type": "number" },
+      "description": "Energy range [keV] used in hard band of hardness ratio",
+      "minItems": 2,
+      "maxItems": 2
+    }
+  }
+}

package/gcn/notices/core/Localization.example.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/core/Localization.schema.json",
+  "ra": 120,
+  "dec": 45,
+  "ra_dec_error": [0.5, 0.8, 0],
+  "containment_probability": 0.95,
+  "systematic_included": true,
+  "instrument_phi": 90,
+  "instrument_theta": 45,
+  "instrument_semimajor_angle": 50,
+  "healpix_url": "http://example.com/localization.fits",
+  "healpix_file": "H4sIAAAAAAAAC......."
+}

package/gcn/notices/core/Localization.schema.json

@@ -0,0 +1,64 @@
+{
+  "$id": "https://gcn.nasa.gov/schema/v4.1.0/gcn/notices/core/Localization.schema.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "title": "Localization",
+  "description": "Localization of transient",
+  "properties": {
+    "ra": {
+      "type": "number",
+      "description": "ICRS right ascension [deg], utilizes the J2000 epoch and an equatorial coordinate system"
+    },
+    "dec": {
+      "type": "number",
+      "description": "ICRS declination [deg], utilizes the J2000 epoch and an equatorial coordinate system"
+    },
+    "ra_dec_error": {
+      "anyOf": [
+        {
+          "type": "number",
+          "description": "Uncertainty region described as a circle with a radius [deg]."
+        },
+        {
+          "type": "array",
+          "items": { "type": "number" },
+          "minItems": 1,
+          "maxItems": 3,
+          "description": "An array of up to three values that describe the localization region as an ellipse: length of the semi-major axis, length of the semi-minor axis (default is the same as the semi-major axis), and astronomical position angle of the semi-major axis (measured from North through East, default is zero)."
+        }
+      ]
+    },
+    "containment_probability": {
+      "type": "number",
+      "description": "Containment probability [dimensionless, 0-1]; if absent, default is 0.9",
+      "default": 0.9
+    },
+    "systematic_included": {
+      "type": "boolean",
+      "description": "Contains true when the systematic error is included and false when the systematic error is not included",
+      "default": false
+    },
+    "instrument_phi": {
+      "type": "number",
+      "description": "Instrument phi [deg]"
+    },
+    "instrument_theta": {
+      "type": "number",
+      "description": "Instrument theta [deg]"
+    },
+    "instrument_semimajor_angle": {
+      "type": "number",
+      "description": "Position angle of semi-major axis in instrument coordinates [deg]"
+    },
+    "healpix_url": {
+      "type": "string",
+      "description": "URL of HEALPix localization probability file"
+    },
+    "healpix_file": {
+      "type": "string",
+      "contentEncoding": "base64",
+      "contentMediaType": "image/fits",
+      "description": "Base 64 encoded content of a FITS file"
+    }
+  }
+}