From 8f553a59f800504f4604a65d7bbe5831ba2eae6c Mon Sep 17 00:00:00 2001 From: Ian Renton Date: Sat, 8 Nov 2025 18:23:11 +0000 Subject: [PATCH] Doc tweaks --- webassets/apidocs/openapi.yml | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/webassets/apidocs/openapi.yml b/webassets/apidocs/openapi.yml index 9402f6e..ca5950d 100644 --- a/webassets/apidocs/openapi.yml +++ b/webassets/apidocs/openapi.yml @@ -528,11 +528,11 @@ paths: example: Dorset country: type: string - description: Country of the operator - example: United Kingdom + description: Country of the operator. Note that this is named "country" for commonality with other amateur radio tools, but in reality this is more of a "DXCC Name", as it includes many options which are not countries, just territories that DXCC uniquely identifies. + example: England flag: type: string - description: Country flag of the operator + description: Country flag of the operator. This is limited to the range of emoji flags, and for many DXCCs there will not be a flag, e.g. Northern Ireland. Many DXCCs may also have the same flag, e.g. mainland Spain, Balearic Islands, etc. example: "" continent: type: string @@ -759,11 +759,11 @@ components: example: Dorset dx_country: type: string - description: Country of the DX operator - example: United Kingdom + description: Country of the operator. Note that this is named "country" for commonality with other amateur radio tools, but in reality this is more of a "DXCC Name", as it includes many options which are not countries, just territories that DXCC uniquely identifies. + example: England dx_flag: type: string - description: Country flag of the DX operator + description: Country flag of the DX operator. This is limited to the range of emoji flags, and for many DXCCs there will not be a flag, e.g. Northern Ireland. Many DXCCs may also have the same flag, e.g. mainland Spain, Balearic Islands, etc. example: "" dx_continent: type: string @@ -826,11 +826,11 @@ components: example: M0TEST de_country: type: string - description: Country of the spotter - example: United Kingdom + description: Country of the operator. Note that this is named "country" for commonality with other amateur radio tools, but in reality this is more of a "DXCC Name", as it includes many options which are not countries, just territories that DXCC uniquely identifies. + example: England de_flag: type: string - description: Country flag of the spotter + description: Country flag of the spotter. This is limited to the range of emoji flags, and for many DXCCs there will not be a flag, e.g. Northern Ireland. Many DXCCs may also have the same flag, e.g. mainland Spain, Balearic Islands, etc. example: "" de_continent: type: string @@ -1050,11 +1050,11 @@ components: example: Ian dx_country: type: string - description: Country of the DX operator. This, and the subsequent fields, assume that all activators will be in the same country! - example: United Kingdom + description: Country of the DX operator. Country of the operator. Note that this is named "country" for commonality with other amateur radio tools, but in reality this is more of a "DXCC Name", as it includes many options which are not countries, just territories that DXCC uniquely identifies. This, and the subsequent fields, assume that all activators will be in the same country! + example: England dx_flag: type: string - description: Country flag of the DX operator + description: Country flag of the DX operator. This is limited to the range of emoji flags, and for many DXCCs there will not be a flag, e.g. Northern Ireland. Many DXCCs may also have the same flag, e.g. mainland Spain, Balearic Islands, etc. example: "" dx_continent: type: string