OvertureMaps / OvertureMaps/schema

Deprecate the yaml schema

Open
#664 2 comments 0 reactions 1 assignee View on GitHub

@danabauer is already working on this.

Since Aug 26, 2026.

Dominant language
Python
Stars
213
Forks
22
Avg merge
3d 3h
Merged PRs (30d)
31

Description

Type

Task

Scope

Multi-theme or Platform

Skillset

engineering

Description

The YAML schema files are superseded by the Pydantic models in v2.0.0. Mark them deprecated in the repo, add a deprecation notice to the files themselves and the README, and decide the removal timeline. Does not remove anything yet. Point people to the JSON version of the schema.

Done when: deprecation notices are in place, a removal version is agreed and documented, and downstream consumers we know about have been identified.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.