Skip to content

Add unique identifier and property to recognize alert type #193

@aleberti

Description

@aleberti

Description

In the current VOEvent format, there are two important fields that I think the JSON format should have:

  • ivorn , an unique identifier attached to each alert (see https://voevent.readthedocs.io/en/latest/reading.html?highlight=ivorn#ivorns-and-identifiers). This can be used also to reference specific alerts in follow-ups by other instruments e.g. using the FollowUp core schema or by the same instrument in the case it sends updates on the same event. More importantly, it can be used in general for the provenance of alerts, and used by subscribers to properly store the alerts (e.g. in their local DB or files on disk)
  • at the moment, it is not straightforward to recognize easily which type of alert is received. I take as an example https://github.com/nasa-gcn/gcn-schema/blob/main/gcn/notices/swift/bat/guano.loc_arc_min.example.json and https://github.com/nasa-gcn/gcn-schema/blob/main/gcn/notices/swift/bat/guano.loc_map.example.json . The alert_tense and alert_type is the same, but the content is different (one contains RA and Dec, the other has a link to a skymap). It would be good to have an additional field in Alert core schema that identifies the type of alert, similarly to the Packet_Type of VOEvents. It does not need to be an integer, but it can be a string (but definitely the same variable type for all JSON alerts, not a mix of integers and strings). In the cases above, e.g. something like SWIFTBAT_GUANO_LOC_ARC_MIN and SWIFTBAT_GUANO_LOC_MAP. In this way, subscribers know immediately what they would find in the JSON, and code the parsing accordingly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions