Skip to content

Conversation

@jwass
Copy link
Collaborator

@jwass jwass commented Dec 1, 2025

B. Related MINOR change steps

  • Add new taxonomy column

C. Public documentation and messaging plan

TODO.

Description

Brief description of the business purpose and effect of the pull request.

Adds the new categorization description for Overture's new taxonomy. This includes
specifying the primary category and the hierarchy from most general to most specific. The
schema includes the ability to specify alternates, but those are only the strings.

Reference

List of relevant links to GitHub issues, PRs, and other documentation.

  1. TODO.

Testing

Brief description of the testing done for this change showing why you are confident it works as expected and does not introduce regressions. Provide sample output data where appropriate.

TODO.

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

Update the hyperlink below to put the pull request number in.

[Docs preview for this PR.](https://dfhx9f55j8eg5.cloudfront.net/pr/<PUT THE PR # HERE>)

@jwass jwass added the change type - minor 🤏 Minor schema change. See https://lf-overturemaps.atlassian.net/wiki/x/GgDa label Dec 1, 2025
Copy link
Collaborator

@jenningsanderson jenningsanderson left a comment

Choose a reason for hiding this comment

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

👍 Pydantic changes look good, too!

sasastanojkov
sasastanojkov previously approved these changes Dec 2, 2025
Copy link
Collaborator

@vcschapp vcschapp left a comment

Choose a reason for hiding this comment

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

It looks pretty good. I picked a few nits and also called out the sad and sorry need to duplicate the examples/counterexamples.

Copy link
Contributor

@danabauer danabauer left a comment

Choose a reason for hiding this comment

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

We need to document the changes to the categories properties in several locations in the schema so that information will pass through to the user-facing documentation. @jwass @DrishT

@TristanDiet-TomTom TristanDiet-TomTom self-requested a review December 3, 2025 16:28
@vcschapp vcschapp merged commit f8385af into dev Dec 3, 2025
3 checks passed
@vcschapp vcschapp deleted the places-taxonomy branch December 3, 2025 17:55
@TristanDiet-TomTom TristanDiet-TomTom self-requested a review December 3, 2025 17:55
vcschapp pushed a commit that referenced this pull request Dec 4, 2025
* Initial commit of new places taxonomy

* Fix TX region

* Add operating_status to bad-categories-value

* Fix mistakenly change alternate -> alternates

* Revert change to bad categories counterexample

* Add pydantic model for new taxonomy

* Fix up place baseline schema json

* Copy examples/couterexamples to references. Update docs

* Update main place.yaml file to reflect unique/minItems constraints

* Add backtick and reference to Places doc page

* Update baseline json
patryklikus-tomtom pushed a commit to patryklikus-tomtom/OvertureMaps-schemas that referenced this pull request Dec 4, 2025
* Initial commit of new places taxonomy

* Fix TX region

* Add operating_status to bad-categories-value

* Fix mistakenly change alternate -> alternates

* Revert change to bad categories counterexample

* Add pydantic model for new taxonomy

* Fix up place baseline schema json

* Copy examples/couterexamples to references. Update docs

* Update main place.yaml file to reflect unique/minItems constraints

* Add backtick and reference to Places doc page

* Update baseline json
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.

8 participants