Skip to content

Added Colloquial Areas - Supplemental Dataset Schema#497

Draft
Pradeep Kumar (pradeepbkkumar) wants to merge 7 commits intodevfrom
users/prbachin/colloquial_areas_supplemental
Draft

Added Colloquial Areas - Supplemental Dataset Schema#497
Pradeep Kumar (pradeepbkkumar) wants to merge 7 commits intodevfrom
users/prbachin/colloquial_areas_supplemental

Conversation

@pradeepbkkumar
Copy link
Copy Markdown
Collaborator

@pradeepbkkumar Pradeep Kumar (pradeepbkkumar) commented Apr 16, 2026

B. Related MINOR change steps

  • Add a new supplemental dataset feature type: colloquial_area

C. Public documentation and messaging plan

TODO.

Description

Supplemental Datasets

Supplemental datasets extend Overture Maps with additional geographic data that is not part of the core reference map. They provide valuable map data from single sources that complement—but remain separate from—the multi-source, conflated reference map.

Characteristics

  • Not part of the reference map corpus - Supplemental datasets add new rows of map data rather than new properties to existing features
  • Single-source - Each supplemental dataset comes from a single data provider, not conflated from multiple sources
  • No GERS IDs - Features do not have Global Entity Reference System (GERS) identifiers used for entity resolution
  • Independent release cadence - Updates follow their own schedule, not tied to monthly reference map releases
  • No reference map links - Features do not link to reference map features via GERS IDs
  • No theme property - Unlike reference map features, supplemental datasets do not include a theme property

Colloquial Areas as Supplemental

Represents informal, culturally defined, or commonly referenced areas that do not correspond to official administrative boundaries. Unlike countries, states, counties, or cities whose boundaries are legally defined, colloquial areas evolve from cultural, historical, economic, or linguistic identity. These areas have no official ISO codes, no fixed administrative definitions, and frequently overlap existing divisions. They are nonetheless highly important for search, mapping, analytics, and user experience, particularly when users expect them to behave like meaningful geographic entities.

Examples:

  • South Florida: A cultural and economic region typically understood to include Miami, Fort Lauderdale, and West Palm Beach. It does not match any administrative boundary.
  • East Asia: A macro-region defined primarily by cultural and geographic context, comprising countries such as Japan, South Korea, China, Mongolia, etc.
  • Northern Italy: Often used to refer to Italian regions north of the Po River; widely used in climate, economic, and tourism contexts.

Properties:

  • type (required) - Always colloquial_area
  • version (required) - Feature version number
  • names (required) - Multi-language names with primary and common translations
  • sources (required) - Source attribution
  • bbox (optional) - Bounding box as [west, south, east, north]
  • center_point (optional) - Representative point for labeling/geocoding
  • parent_name (optional) - Name of containing geographic area
  • wikipedia_url (optional) - Wikipedia article URL
  • wikidata (optional) - Wikidata identifier

Geometry: Polygon or MultiPolygon

Reference

Testing

  • Added examples and counterexamples with appropriate validations
  • Tested those examples by running the below commands
    • ./test.sh -m examples "supplemental-datasets/colloquial_area/.*"
    • ./test.sh -m counterexamples "supplemental-datasets/colloquial_area/.*"
  • Tested the corresponding pydantic schema too
    • uv run pytest packages

Checklist

Checklist of tasks commonly-associated with schema pull requests. Please review the relevant checklists and ensure you do all the tasks that are required for the change you made.

  1. Add relevant examples.
  2. Add relevant counterexamples.
  3. Update any counterexamples that became obsolete. For example, if a counterexample uses property A but is not intended to test property A's validity, and you made a schema change that invalidates property A in that counterexample, fix the counterexample to align it with your schema change.
  4. Update in-schema documentation using plain English written in complete sentences, if an update is required.
  5. Update Docusaurus documentation, if an update is required.
  6. Review change with Overture technical writer to ensure any advanced documentation needs will be taken care of, unless the change is trivial and would not affect the documentation.

Documentation website

Docs preview for this PR.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 16, 2026

🗺️ Schema reference docs preview is live!

🌍 Preview https://staging.overturemaps.org/schema/pr/497/schema/index.html
🕐 Updated Apr 17, 2026 16:37 UTC
📝 Commit bc780eb
🔧 env SCHEMA_PREVIEW true

Note

♻️ This preview updates automatically with each push to this PR.

Pradeep Kumar Bachin Krishnarao added 7 commits April 17, 2026 09:34
Signed-off-by: Pradeep Kumar Bachin Krishnarao <prbachin@microsoft.com>
Signed-off-by: Pradeep Kumar Bachin Krishnarao <prbachin@microsoft.com>
Signed-off-by: Pradeep Kumar Bachin Krishnarao <prbachin@microsoft.com>
Signed-off-by: Pradeep Kumar Bachin Krishnarao <prbachin@microsoft.com>
Signed-off-by: Pradeep Kumar Bachin Krishnarao <prbachin@microsoft.com>
Signed-off-by: Pradeep Kumar Bachin Krishnarao <prbachin@microsoft.com>
Signed-off-by: Pradeep Kumar Bachin Krishnarao <prbachin@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

change type - minor 🤏 Minor schema change. See https://lf-overturemaps.atlassian.net/wiki/x/GgDa

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant