w1cdn/spothole
1
0
Fork 0
mirror of https://git.ianrenton.com/ian/spothole.git synced 2026-08-11 15:11:41 +00:00
Code Issues 13 Packages Projects Releases Wiki Activity

Replace dash-separated config & API properties with underscore-separated versions. #127

Browse Source
This commit is contained in:
Ian Renton
2026-08-10 20:55:18 +01:00
parent 5c86346074
commit c687202a61
54 changed files with 247 additions and 246 deletions
Download Patch File Download Diff File Expand all files Collapse all files
static/apidocs/openapi.yml
+5 -4
View File
@@ -19,13 +19,14 @@ info:
* **Breaking change:** The "add spot" API has changed to enable future support for upstream submission to the spotting services associated with various SIGs. Instead of just posting the spot object itself as the JSON content of the POST, this has moved into a `spot` object within the structure. A new `handling` object alongside it contains the `submit_upstream`, `upstream_provider`, `upstream_credentials`, and `captcha_token` fields which control the server handling of the spot.
* **Breaking change:** Removed `cleanup` from `/status` response
* **Breaking change:** in the `/options` response, renamed `spot_sources` and `alert_sources` to `spot_providers` and `alert_providers`
* **Breaking change:** In the `/options` response, renamed `spot_sources` and `alert_sources` to `spot_providers` and `alert_providers`
* **Breaking change:** A user's QRZ.com and HamQTH credentials are now supplied as request headers (`X-QRZ-Username`, `X-QRZ-Password`, `X-QRZ-Session-Key`, `X-HamQTH-Username`, `X-HamQTH-Password`, `X-HamQTH-Session-ID`) rather than query parameters, to keep credentials out of server logs.
* **Breaking change:** "WAB/WAI GRID" as a location source has been renamed to just "GRID", and also applies to Tiles on the Air spots and grid references from cluster spot comments.
* **Breaking change:** In the `/status` response, `software-version` has changed to `software_version` and `server-owner-callsign` to `server_owner_callsign`.
* POST `/spot` now supports Google reCaptcha and (if the site owner has set it up) now requires `captcha_token` in order to successfully submit. (This is used to lock down the submit function and prevent submission via Spothole by bots or third-party clients.)
* GET `/options` now returns `spot_submit_providers`, a map of SIG names to the names of providers that support upstream spot submission for that SIG. (This allows clients to present the user with options of where a new spot can be sent to.)
* Added `sig_ref_data_providers`, `static_data_providers` and `callsign_data_providers` to `/status` response
* Added `callsign_data_providers` to `/options` response
* Added `callsign_data_providers` and `spot_providers_enabled_by_default` to `/options` response
#### Upgrading a client from v1 to v2 API endpoints
@@ -1926,11 +1927,11 @@ components:
ServerStatus:
type: object
properties:
"software-version":
"software_version":
type: string
description: The version number of the software.
example: "1.0.1"
"server-owner-callsign":
"server_owner_callsign":
type: string
description: The callsign of this server's operator.
example: "M0TRT"