Skip to content

fix(GAT-8183): Remove geoname examples from coverage.spatial schema documentation #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Stephen-L-HDR-UK wants to merge 6 commits into
base: dev
Choose a base branch
from
Open

fix(GAT-8183): Remove geoname examples from coverage.spatial schema documentation #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
395b55a
Removing references and examples to geonames in metadata
Stephen-L-HDR-UK Nov 11, 2025
2bc9c2a
Removing use of geonames in description and examples
Stephen-L-HDR-UK Nov 11, 2025
5de600a
Removing use of geonames in description and examples
Stephen-L-HDR-UK Nov 11, 2025
cf9a2bc
Removing use of geonames in description and examples
Stephen-L-HDR-UK Nov 11, 2025
f366f0d
Removing use of geonames in description and examples
Stephen-L-HDR-UK Nov 11, 2025
5a282f6
Removing use of geonames in description and examples
Stephen-L-HDR-UK Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/GWDM/2.0.form.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,10 +320,13 @@
{
"required": false,
"title": "Geographic Coverage",
"description": "The geographical area covered by the dataset. It is recommended that links are to entries in a well-maintained gazetteer such as https://www.geonames.org/ or https://what3words.com/daring.lion.race.",
"description": "The geographical area covered by the dataset.",
"guidance": "- The geographical area covered by the dataset.\\n- Please provide a valid location.\\n- For locations in the UK, this location should conform to [ONS standards](https://geoportal.statistics.gov.uk/datasets/208d9884575647c29f0dd5a1184e711a/about).\\n- For locations in other countries we use [ISO 3166-1 & ISO 3166-2](https://github.com/HDRUK/reference-codes).",
"examples": [
"https://www.geonames.org/2635167/united-kingdom-of-great-britain-and-northern-ireland.html"
"England",
"East Ayrshire",
"Ardoyne",
"Powys"
],
"is_list": false,
"is_optional": true,
Expand Down Expand Up @@ -1840,4 +1843,4 @@
}
],
"url_regex": "^\\s*((https?:\\/\\/)*([a-zA-Z0-9-]+\\.?)+[a-zA-Z]{2,}(:\\d+)?(\\/[^\\s]*)?(\n)?)+$"
}
}
7 changes: 5 additions & 2 deletions docs/GWDM/2.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,15 +310,18 @@ This information includes attributes for geographical and temporal coverage, coh

### spatial

The geographical area covered by the dataset. It is recommended that links are to entries in a well-maintained gazetteer such as https://www.geonames.org/ or https://what3words.com/daring.lion.race.
The geographical area covered by the dataset.

| title | guidance | is_list | required | type |
|:--------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------|:-----------|:----------------------------------------------------------------------------------------------------------|
| Geographic Coverage | - The geographical area covered by the dataset.<br>- Please provide a valid location.<br>- For locations in the UK, this location should conform to [ONS standards](https://geoportal.statistics.gov.uk/datasets/208d9884575647c29f0dd5a1184e711a/about).<br>- For locations in other countries we use [ISO 3166-1 & ISO 3166-2](https://github.com/HDRUK/reference-codes). | False | False | ["CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]", 'null'] |

Examples:

* https://www.geonames.org/2635167/united-kingdom-of-great-britain-and-northern-ireland.html
* England
* East Ayrshire
* Ardoyne
* Powys


### pathway
Expand Down
9 changes: 6 additions & 3 deletions docs/GWDM/2.0.structure.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,10 +411,13 @@
"name": "spatial",
"required": false,
"title": "Geographic Coverage",
"description": "The geographical area covered by the dataset. It is recommended that links are to entries in a well-maintained gazetteer such as https://www.geonames.org/ or https://what3words.com/daring.lion.race.",
"description": "The geographical area covered by the dataset.",
"guidance": "The geographical area covered by the dataset.- Please provide a valid location.- For locations in the UK, this location should conform to ONS standards.- For locations in other countries we use ISO 3166-1 & ISO 3166-2.",
"examples": [
"https://www.geonames.org/2635167/united-kingdom-of-great-britain-and-northern-ireland.html"
"England",
"East Ayrshire",
"Ardoyne",
"Powys"
],
"type": [
"CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]",
Expand Down Expand Up @@ -2258,4 +2261,4 @@
}
]
}
]
]
8 changes: 5 additions & 3 deletions docs/HDRUK/4.0.0.form.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,8 +377,10 @@
"description": "The geographical area covered by the dataset. It is recommended that links are to entries in one of the recommended standards:\\n- For locations in the UK: [ONS standards](https://geoportal.statistics.gov.uk/datasets/208d9884575647c29f0dd5a1184e711a/about)\\n- For locations in other countries: [ISO 3166-1 & ISO 3166-2](https://github.com/HDRUK/reference-codes)",
"guidance": "- The geographical area covered by the dataset.\\n- Please provide a valid location.\\n- For locations in the UK, this location should conform to [ONS standards](https://geoportal.statistics.gov.uk/datasets/208d9884575647c29f0dd5a1184e711a/about).\\n- For locations in other countries we use [ISO 3166-1 & ISO 3166-2](https://github.com/HDRUK/reference-codes).",
"examples": [
"United Kingdom",
"https://www.geonames.org/2635167/united-kingdom-of-great-britain-and-northern-ireland.html"
"England",
"East Ayrshire",
"Ardoyne",
"Powys"
],
"is_list": false,
"is_optional": false,
Expand Down Expand Up @@ -1957,4 +1959,4 @@
}
],
"url_regex": "^\\s*((https?:\\/\\/)*([a-zA-Z0-9-]+\\.?)+[a-zA-Z]{2,}(:\\d+)?(\\/[^\\s]*)?(\n)?)+$"
}
}
6 changes: 4 additions & 2 deletions docs/HDRUK/4.0.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,8 +337,10 @@ The geographical area covered by the dataset. It is recommended that links are t

Examples:

* United Kingdom
* https://www.geonames.org/2635167/united-kingdom-of-great-britain-and-northern-ireland.html
* England
* East Ayrshire
* Ardoyne
* Powys


### typicalAgeRangeMin
Expand Down
8 changes: 5 additions & 3 deletions docs/HDRUK/4.0.0.structure.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,8 +438,10 @@
"description": "The geographical area covered by the dataset. It is recommended that links are to entries in one of the recommended standards:- For locations in the UK: ONS standards- For locations in other countries: ISO 3166-1 & ISO 3166-2",
"guidance": "The geographical area covered by the dataset.- Please provide a valid location.- For locations in the UK, this location should conform to ONS standards.- For locations in other countries we use ISO 3166-1 & ISO 3166-2.",
"examples": [
"United Kingdom",
"https://www.geonames.org/2635167/united-kingdom-of-great-britain-and-northern-ireland.html"
"England",
"East Ayrshire",
"Ardoyne",
"Powys"
],
"type": [
"CommaSeparatedValues[{'anyOf': [{'pattern': '([^,]+)', 'type': 'string'}, {'type': 'null'}]}]",
Expand Down Expand Up @@ -1859,4 +1861,4 @@
}
]
}
]
]