Add "fields" query parameter to spots and alerts API calls. Closes #140

static/apidocs/openapi.yml

@@ -24,6 +24,7 @@ info:
     * Added `alert_type` and `url` to alert data
     * Added `contests_skip_max_duration_check` to alert query parameters
     * SIG reference types (e.g. "Park") are now capitalised to match other enums
+    * Added the ability to get only certain fields of spots and alerts from the API by using the `fields` query parameter.
     
     ### 2.0
 
@@ -140,6 +141,7 @@ paths:
         - $ref: '#/components/parameters/SpotTextIncludes'
         - $ref: '#/components/parameters/SpotNeedsGoodLocation'
         - $ref: '#/components/parameters/SpotAllowQrt'
+        - $ref: '#/components/parameters/SpotFields'
         - $ref: '#/components/parameters/QrzUsername'
         - $ref: '#/components/parameters/QrzPassword'
         - $ref: '#/components/parameters/QrzSessionKey'
@@ -180,6 +182,7 @@ paths:
         - $ref: '#/components/parameters/SpotTextIncludes'
         - $ref: '#/components/parameters/SpotNeedsGoodLocation'
         - $ref: '#/components/parameters/SpotAllowQrt'
+        - $ref: '#/components/parameters/SpotFields'
         - $ref: '#/components/parameters/QrzUsername'
         - $ref: '#/components/parameters/QrzPassword'
         - $ref: '#/components/parameters/QrzSessionKey'
@@ -217,6 +220,7 @@ paths:
         - $ref: '#/components/parameters/AlertDxContinent'
         - $ref: '#/components/parameters/AlertDxCallIncludes'
         - $ref: '#/components/parameters/AlertTextIncludes'
+        - $ref: '#/components/parameters/AlertFields'
         - $ref: '#/components/parameters/QrzUsername'
         - $ref: '#/components/parameters/QrzPassword'
         - $ref: '#/components/parameters/QrzSessionKey'
@@ -252,6 +256,7 @@ paths:
         - $ref: '#/components/parameters/AlertDxContinent'
         - $ref: '#/components/parameters/AlertDxCallIncludes'
         - $ref: '#/components/parameters/AlertTextIncludes'
+        - $ref: '#/components/parameters/AlertFields'
         - $ref: '#/components/parameters/QrzUsername'
         - $ref: '#/components/parameters/QrzPassword'
         - $ref: '#/components/parameters/QrzSessionKey'
@@ -657,6 +662,16 @@ components:
       schema:
         type: boolean
         default: true
+    SpotFields:
+      name: fields
+      in: query
+      description: >
+        Filter the fields you receive in each spot, to conserve data bandwidth for constrained applications.
+        Supply a comma-separated list of the fields you want to receive, using the names of the fields returned by the
+        `/spots` call, e.g. `id,dx_call,freq,mode,time`. If the "fields" parameter is not supplied, all fields will be
+        included in the spot data.
+      schema:
+        type: string
     AlertMaxDuration:
       name: max_duration
       in: query
@@ -795,6 +810,16 @@ components:
         you will get all the more recent alerts back, without duplicating the previous latest spot.
       schema:
         type: number
+    AlertFields:
+      name: fields
+      in: query
+      description: >
+        Filter the fields you receive in each alert, to conserve data bandwidth for constrained applications.
+        Supply a comma-separated list of the fields you want to receive, using the names of the fields returned by the
+        `/alerts` call, e.g. `id,dx_calls,freqs_modes,start_time`. If the "fields" parameter is not supplied, all fields
+        will be included in the alert data.
+      schema:
+        type: string
     CallParam:
       name: call
       in: query