First pass at TOTA support #82

This commit is contained in:
Ian Renton
2025-11-24 21:57:29 +00:00
parent 4e427f26c3
commit 6c9f3136b8
6 changed files with 83 additions and 8 deletions

View File

@@ -52,7 +52,7 @@ paths:
type: number
- name: source
in: query
description: "Limit the spots to only ones from one or more sources. To select more than one source, supply a comma-separated list."
description: "Limit the spots to only ones from one or more sources. To select more than one source, supply a comma-separated list. The allowed options will vary based on how the sources are named within the server's config. See the /options call for how to retrieve a list of these."
required: false
schema:
type: string
@@ -71,6 +71,7 @@ paths:
- RBN
- APRS-IS
- UKPacketNet
- TOTA
- name: sig
in: query
description: "Limit the spots to only ones from one or more Special Interest Groups provided as an argument. To select more than one SIG, supply a comma-separated list."
@@ -90,11 +91,13 @@ paths:
- ARLHS
- ILLW
- ZLOTA
- KRMNPA
- IOTA
- WOTA
- BOTA
- WAB
- WAI
- TOTA
- name: needs_sig
in: query
description: "Limit the spots to only ones with a Special Interest Group such as POTA. Because supplying all known SIGs as a `sigs` parameter is unwieldy, and leaving `sigs` blank will also return spots with *no* SIG, this parameter can be set true to return only spots with a SIG, regardless of what it is, so long as it's not blank. This is what Field Spotter uses to exclude generic cluster spots and only retrieve xOTA things."
@@ -282,7 +285,7 @@ paths:
type: boolean
- name: source
in: query
description: "Limit the alerts to only ones from one or more sources. To select more than one source, supply a comma-separated list."
description: "Limit the alerts to only ones from one or more sources. To select more than one source, supply a comma-separated list. The options will vary based on how the sources are named within the server's config. See the /options call for how to retrieve a list of these."
required: false
schema:
type: string
@@ -301,6 +304,7 @@ paths:
- RBN
- APRS-IS
- UKPacketNet
- TOTA
- name: sig
in: query
description: "Limit the alerts to only ones from one or more Special Interest Groups. To select more than one SIG, supply a comma-separated list."
@@ -320,11 +324,13 @@ paths:
- ARLHS
- ILLW
- ZLOTA
- KRMNPA
- IOTA
- WOTA
- BOTA
- WAB
- WAI
- TOTA
- name: dx_continent
in: query
description: "Limit the alerts to only ones where the DX operator is on the given continent(s). To select more than one continent, supply a comma-separated list."
@@ -646,11 +652,13 @@ paths:
- ARLHS
- ILLW
- ZLOTA
- KRMNPA
- IOTA
- WOTA
- BOTA
- WAB
- WAI
- TOTA
example: POTA
- name: id
in: query
@@ -744,11 +752,13 @@ components:
- ARLHS
- ILLW
- ZLOTA
- KRMNPA
- IOTA
- WOTA
- BOTA
- WAB
- WAI
- TOTA
example: POTA
name:
type: string
@@ -895,7 +905,7 @@ components:
example: 51.2345
de_longitude:
type: number
description: Longitude of the DX spotspotter, in degrees. This is not going to be from a xOTA reference so it will likely just be a QRZ or DXCC lookup. If the spotter is also portable, this is probably wrong, but it's good enough for some simple mapping.
description: Longitude of the spotter, in degrees. This is not going to be from a xOTA reference so it will likely just be a QRZ or DXCC lookup. If the spotter is also portable, this is probably wrong, but it's good enough for some simple mapping.
example: -1.2345
mode:
type: string
@@ -1007,11 +1017,13 @@ components:
- ARLHS
- ILLW
- ZLOTA
- KRMNPA
- IOTA
- WOTA
- BOTA
- WAB
- WAI
- TOTA
example: POTA
sig_refs:
type: array
@@ -1040,7 +1052,7 @@ components:
example: false
source:
type: string
description: Where we got the spot from.
description: Where we got the spot from. The options will vary based on how the sources are named within the server's config. See the /options call for how to retrieve a list of these.
enum:
- POTA
- SOTA
@@ -1055,6 +1067,7 @@ components:
- RBN
- APRS-IS
- UKPacketNet
- TOTA
example: POTA
source_id:
type: string