Simplify API for band conditions #92

webassets/apidocs/openapi.yml

@@ -1356,47 +1356,6 @@ components:
           description: Regex that matches this SIG's reference IDs. Generally for Spothole's own internal use, clients probably won't need this.
           example: "[A-Z]{2}\\-\\d+"
 
-    HFBandCondition:
-      type: object
-      description: HF propagation conditions for a group of bands at a particular time of day.
-      properties:
-        band:
-          type: string
-          description: Band group, e.g. "80m-40m", "30m-20m", "17m-15m", "10m-6m". As provided by HamQSL.
-          example: "80m-40m"
-        time:
-          type: string
-          description: Time of day these conditions apply to. As provided by HamQSL.
-          enum:
-            - day
-            - night
-          example: day
-        condition:
-          type: string
-          description: Propagation condition assessment. As provided by HamQSL.
-          enum:
-            - Good
-            - Fair
-            - Poor
-          example: Good
-
-    VHFCondition:
-      type: object
-      description: A VHF propagation phenomenon and its current condition.
-      properties:
-        phenomenon:
-          type: string
-          description: The name of the propagation phenomenon, e.g. "E-Skip", "vhf-aurora". As provided by HamQSL.
-          example: "E-Skip"
-        location:
-          type: string
-          description: The geographic region this condition applies to, e.g. "europe", "north_america", "northern_hemi". As provided by HamQSL.
-          example: "europe"
-        condition:
-          type: string
-          description: The current condition for this phenomenon and location.
-          example: "Band Closed"
-
     SolarConditions:
       type: object
       description: Current solar and propagation conditions. All fields may be null if no provider has successfully fetched data yet.
@@ -1458,15 +1417,57 @@ components:
           description: Geomagnetic background noise level on HF, in S-units
           example: "S0"
         hf_conditions:
-          type: array
-          description: HF propagation condition assessments by band group and time of day
-          items:
-            $ref: '#/components/schemas/HFBandCondition'
+          type: object
+          description: HF propagation condition assessments, keyed by "{band}-{time}" e.g. "80m-40m-day"
+          properties:
+            80m-40m-day:
+              type: string
+              enum: [Good, Fair, Poor]
+            80m-40m-night:
+              type: string
+              enum: [Good, Fair, Poor]
+            30m-20m-day:
+              type: string
+              enum: [Good, Fair, Poor]
+            30m-20m-night:
+              type: string
+              enum: [Good, Fair, Poor]
+            17m-15m-day:
+              type: string
+              enum: [Good, Fair, Poor]
+            17m-15m-night:
+              type: string
+              enum: [Good, Fair, Poor]
+            12m-10m-day:
+              type: string
+              enum: [Good, Fair, Poor]
+            12m-10m-night:
+              type: string
+              enum: [Good, Fair, Poor]
         vhf_conditions:
-          type: array
-          description: VHF propagation condition assessments by phenomenon and location
-          items:
-            $ref: '#/components/schemas/VHFCondition'
+          type: object
+          description: VHF propagation condition assessments, keyed by condition name
+          properties:
+            vhf_aurora_northern_hemi:
+              type: string
+              description: VHF aurora propagation condition for the northern hemisphere
+              example: "Band Closed"
+            es_2m_europe:
+              type: string
+              description: Sporadic-E propagation condition on 2m for Europe
+              example: "Band Closed"
+            es_4m_europe:
+              type: string
+              description: Sporadic-E propagation condition on 4m for Europe
+              example: "Band Closed"
+            es_6m_europe:
+              type: string
+              description: Sporadic-E propagation condition on 6m for Europe
+              example: "Band Closed"
+            es_2m_na:
+              type: string
+              description: Sporadic-E propagation condition on 2m for North America
+              example: "Band Closed"
         blackout_desc:
           type: string
           description: HF radio blackout risk description, derived from the X-ray flux class.