Docs for propagation modes

webassets/apidocs/openapi.yml

@@ -14,6 +14,10 @@ info:
     Spothole's source code is located at https://git.ianrenton.com/ian/spothole and the README there provides setup instructions if you would like to run your own copy. A demonstration server of Spothole is located at https://spothole.app.
 
     ## Changelog
+    
+    ### 1.4
+    
+    * Spots can now include a "propagation_mode" field, and the `/options` call enumerates the options that can have.
 
     ### 1.3
 
@@ -36,7 +40,7 @@ info:
   license:
     name: The Unlicense
     url: https://unlicense.org/#the-unlicense
-  version: v1.3
+  version: v1.4
 
 servers:
   - url: https://spothole.app/api/v1
@@ -898,6 +902,20 @@ components:
         - NONE
       example: SPOT
 
+    PropagationMode:
+      type: string
+      enum:
+        - F2 layer ionospheric
+        - Sporadic-E
+        - Tropospheric ducting
+        - Trans-Equatorial Propagation
+        - Earth-Moon-Earth
+        - Aurora
+        - Meteor scatter
+        - Rain scatter
+        - Aircraft scatter
+      example: Sporadic-E
+
     LocationSourceForSpot:
       type: string
       enum:
@@ -1153,6 +1171,11 @@ components:
           type: string
           description: The ID the source gave it, if any.
           example: "GUID-123456"
+        propagation_mode:
+          description: >
+            Propagation mode, if known. This is only populated when the upstream spot specifically states it; Spothole
+            does not try to determine it using its own algorithm.
+          $ref: "#/components/schemas/PropagationMode"
 
 
     SpotStream:
@@ -1827,6 +1850,11 @@ components:
           items:
             type: string
             example: "EU"
+        propagation_modes:
+          type: array
+          description: A list of all the supported propagation mode names.
+          items:
+            $ref: '#/components/schemas/PropagationMode'
         max_spot_age:
           type: integer
           description: >