Skip to content

[DOCS] Add blog post: The Overture Schema Is a Library Now - #518

Merged
Dana Bauer (danabauer) merged 5 commits into
mainfrom
schema-v2
Sep 16, 2026
Merged

Dana Bauer (danabauer) merged 5 commits into
mainfrom
schema-v2

Conversation

@danabauer

@danabauer Dana Bauer (danabauer) commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

What's in this PR?

Announces overture-schema v2.0.0 on PyPI — the schema is now a Python
library with Pydantic models instead of handwritten YAML JSON Schema.

Closes #517

The post covers:

  • What you can do now: import a feature type, inspect its fields, read field descriptions, validate your own data
  • Install and generate — the umbrella package, the twelve packages underneath it, and overture-schema json-schema for a type, a theme, or everything installed
  • Why we left JSON Schema, with context from Seth Fitzsimmons and Vic Schappert on the original 2023 design and where it stopped generalizing past JSON
  • Pydantic models are now the source of truth; JSON Schema, the PySpark validation expressions, and the reference docs are all generated from them, so they can't drift
  • YAML files are deprecated as of this release and go away in December 2026
  • Writing your own feature types today, and schema extensions next

Signed-off-by: Dana Bauer <dana.bauer@gmail.com>
Signed-off-by: Dana Bauer <dana.bauer@gmail.com>
@github-actions

github-actions Bot commented Sep 16, 2026

Copy link
Copy Markdown

MegaLinter analysis: Success

Descriptor Linter Files Fixed Errors Max errors Warnings Elapsed time
✅ JAVASCRIPT eslint 24 0 0 12.73s
✅ MARKDOWN markdownlint 5 0 0 0.4s
✅ SQL sqlfluff 69 0 0 3.97s

See detailed reports in MegaLinter artifacts

Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)

  • Documentation: Custom Flavors
  • Command: npx mega-linter-runner@10.1.0 --custom-flavor-setup --custom-flavor-linters JAVASCRIPT_ES,MARKDOWN_MARKDOWNLINT,SQL_SQLFLUFF

MegaLinter is provided by OX Security
Show us your support by starring ⭐ the repository

@github-actions

github-actions Bot commented Sep 16, 2026

Copy link
Copy Markdown

🗺️ Overture Docs preview is live!

🌍 Preview site https://staging.overturemaps.org/docs/pr/518/index.html
🗂️ Schema ref main@e074163
🕐 Updated Sep 16, 2026 18:59 UTC
📝 Commit 7245497

Note

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great

Comment thread blog/2026-09-16-schema-v2.mdx Outdated
Comment thread blog/2026-09-16-schema-v2.mdx Outdated
Comment thread blog/2026-09-16-schema-v2.mdx Outdated
Comment thread blog/2026-09-16-schema-v2.mdx
Comment on lines +19 to +24
['addresses', 'basic_category', 'bbox', 'brand', 'confidence', 'emails', 'geometry', 'id', 'names', 'operating_status', 'phones', 'socials', 'sources', 'taxonomy', 'theme', 'type', 'version', 'websites']

>>> print(Place.model_fields["taxonomy"].description)

A structured representation of the place's category within the Overture taxonomy.
Provides the primary classification, full hierarchy path, and alternate categories.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we able to word-wrap this using a Docusaurus config?

Comment thread blog/2026-09-16-schema-v2.mdx Outdated
Comment thread blog/2026-09-16-schema-v2.mdx Outdated
Comment thread blog/2026-09-16-schema-v2.mdx Outdated
Comment thread blog/2026-09-16-schema-v2.mdx Outdated
Co-authored-by: Alex Iannicelli <atiannicelli@gmail.com>
Signed-off-by: Dana Bauer <dana.bauer@gmail.com>
Co-authored-by: Seth Fitzsimmons <sethfitz@amazon.com>
Signed-off-by: Dana Bauer <dana.bauer@gmail.com>
Signed-off-by: Dana Bauer <dana.bauer@gmail.com>
@danabauer
Dana Bauer (danabauer) merged commit c404917 into main Sep 16, 2026
17 checks passed
@danabauer
Dana Bauer (danabauer) deleted the schema-v2 branch September 16, 2026 19:01
@jjcfrancisco

Copy link
Copy Markdown
Member

This is great, well done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

publish schema v2 post

4 participants