21 - SDA Report Commenting Convention
Purpose
Monitor Space Hazards uses reports generated by Orbital Analysts for Conjunction, Re-entry, and Fragmentation events.
These reports sometimes require additional commentary, editable by Agency Approvers via the front end. To ensure accuracy and reliability, comment fields need to be unified and consistent across the service.
Problem Statement
Comment fields across the three report types (Conjunctions, Re-entries, Fragmentations) risk inconsistncy. This creates risk of misalignment between OA JSON outputs, backend schemas, and frontend/email templates.
Design Decision
Standardise comment field naming conventions across all three report types using a shared set of field identifiers.
Comment Field Mapping
| Comment field | Conjunctions | Re-entries | Fragmentations |
|---|---|---|---|
| Executive Summary | executive_summary_comment |
executive_summary_comment |
executive_summary_comment |
| Level 1 summary | executive_summary_level_1_comment |
executive_summary_level_1_comment |
executive_summary_level_1_comment |
| Level 2 summary | executive_summary_level_2_comment |
executive_summary_level_2_comment |
executive_summary_level_2_comment |
| Closed Comment | closed_comment |
closed_comment |
closed_comment |
| UK response comment | uk_response_comment |
uk_response_comment |
uk_response_comment |
| Press attention comment | press_attention_comment |
press_attention_comment |
press_attention_comment |
| Risk immediate response comment | — | immediate_response_comment |
— |
| Damages liability comment | — | damages_liability_comment |
— |
| Immediate impact | immediate_impact_comment |
— | — |
| Short term impact | short_term_impact_comment |
— | — |
| Long term impact | long_term_impact_comment |
— | — |
| Risk at altitude | risk_at_altitude_comment |
— | — |
| Manoeuvre comment | manoeuvre_comment |
— | — |
| Object history comment | — | — | object_history_comment |
| Orbital analyst comment | — | — | orbital_analyst_comment |
| UK and Human Spaceflight risk comment | — | — | spaceflight_risk_comment |
| Fragmentation type comment | — | — | fragmentation_type_comment |
Impact
The following components need to be updated to reflect the standardised field names:
- OA JSON outputs — field names in generated report JSON
- Backend endpoints and schemas — API contracts and data models
- Frontend and email templates — display labels and template variables
This page was last reviewed on 16 June 2026.
It needs to be reviewed again on 16 June 2027
.
This page was set to be reviewed before 16 June 2027.
This might mean the content is out of date.