Skip to content

[Places] Initial commit of places operating status - #354

Merged
Jennings Anderson (jenningsanderson) merged 15 commits into
devfrom
places-operating-status
Sep 10, 2025
Merged

[Places] Initial commit of places operating status#354
Jennings Anderson (jenningsanderson) merged 15 commits into
devfrom
places-operating-status

Conversation

@jwass

@jwass Jacob Wasserman (jwass) commented Jul 2, 2025

Copy link
Copy Markdown
Collaborator

Major change release plan

Minor release as its a new optional column

B. Related MINOR change steps

Add operating_status field

C. Public documentation and messaging plan

TODO.

Description

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

Allow Overture to include places that are known to be closed

Reference

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

Testing

Added example and counterexample

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. [x ] Add relevant examples.
  2. [ x] Add relevant counterexamples.
  3. [ x] 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.

@jwass Jacob Wasserman (jwass) added the change type - minor 🤏 Minor schema change. See https://lf-overturemaps.atlassian.net/wiki/x/GgDa label Jul 2, 2025
Comment thread schema/places/place.yaml Outdated
@Cj-Malone

Copy link
Copy Markdown
Contributor

How does this fit in with confidence=0?

@vcschapp

Victor Schappert (vcschapp) commented Jul 23, 2025

Copy link
Copy Markdown
Collaborator

How does this fit in with confidence=0?

Good question. This is something we should document carefully also.

(Related: Are we still thinking about switching confidence to existence?)

@jensgoossens-tomtom

Jens Goossens (jensgoossens-tomtom) commented Aug 19, 2025

Copy link
Copy Markdown
Contributor

How does this fit in with confidence=0?

Good question. This is something we should document carefully also.

(Related: Are we still thinking about switching confidence to existence?)

We're still debating on this one - for now we settled on setting confidence to 0 when it's also marked as closed to match the current confidence definition.

From discussions happening - I think the confidence score will be redefined to indeed more like 'existence' to indicate whether the place ever existed or not, and used more to weed out junk vs real places (even places that are now closed, but used to exist)

@ericgodwin

Copy link
Copy Markdown
Contributor

How does this fit in with confidence=0?
Good question. This is something we should document carefully also.

(Related: Are we still thinking about switching confidence to existence?)
We're still debating on this one - for now we settled on setting confidence to 0 when it's also marked as closed to match the current confidence definition.

From discussions happening - I think the confidence score will be redefined to indeed more like 'existence' to indicate whether the place ever existed or not, and used more to weed out junk vs real places (even places that are now closed, but used to exist)

The Places TF this was actually discussed in great detail. First confidence = existence. There has been no further conversation to change the schema field name to existence. Basically documentation can explain that is our confidence in the existence of a place.

Without this field we would drive the confidence to 0 as that is the only closure indicator that we had. Once we have this the confidence should be independent of the closure status. For example we could have an operating status of open and a very low confidence indicating that the place most likely does not exists. Or we can have an operating status of closed and a very high confidence indicating that we know the place is there but it is closed.

@vcschapp

Copy link
Copy Markdown
Collaborator

How does this fit in with confidence=0?

Good question. This is something we should document carefully also.
(Related: Are we still thinking about switching confidence to existence?)

We're still debating on this one - for now we settled on setting confidence to 0 when it's also marked as closed to match the current confidence definition.

From discussions happening - I think the confidence score will be redefined to indeed more like 'existence' to indicate whether the place ever existed or not, and used more to weed out junk vs real places (even places that are now closed, but used to exist)

I said it above, but "closed with confidence 0" sounds to me like "you are not confident it is closed".

@vcschapp

Copy link
Copy Markdown
Collaborator

Seth Fitzsimmons (@mojodna) Jennings Anderson (@jenningsanderson) Jens Goossens (@jensgoossens-tomtom) This change will have to be ported to the Pydantic model.

Comment thread schema/places/place.yaml Outdated

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Mostly mechanical changes, though we may want to consider how we think about what "default" means and how it manifests.

Comment thread counterexamples/places/bad-operating-status.yaml Outdated
Comment thread examples/places/place-with-operating-status.yaml Outdated
Comment thread examples/places/place-with-operating-status.yaml Outdated
Comment thread counterexamples/places/bad-operating-status.yaml Outdated
Comment thread schema/places/place.yaml Outdated
Seth Fitzsimmons (sethfitz) added a commit that referenced this pull request Sep 5, 2025
This is the Pydantic equivalent of #354
@sethfitz

Copy link
Copy Markdown
Collaborator

Pydantic equivalent here: #389

@jenningsanderson

Copy link
Copy Markdown
Collaborator

Looks like we will need to rebase / resolve these conflicts?

@jenningsanderson
Jennings Anderson (jenningsanderson) merged commit de288ae into dev Sep 10, 2025
3 checks passed
Seth Fitzsimmons (sethfitz) added a commit that referenced this pull request Sep 11, 2025
This is the Pydantic equivalent of #354
Victor Schappert (vcschapp) pushed a commit that referenced this pull request Nov 26, 2025
This is the Pydantic equivalent of #354
@jenningsanderson
Jennings Anderson (jenningsanderson) deleted the places-operating-status branch December 1, 2025 16:13
Victor Schappert (vcschapp) pushed a commit that referenced this pull request Dec 4, 2025
This is the Pydantic equivalent of #354
Patryk (patryklikus-tomtom) pushed a commit to patryklikus-tomtom/OvertureMaps-schemas that referenced this pull request Dec 4, 2025
* Initial commit of places operating status

* Improve in-schema documentation for operating status

* feat(OvertureMaps#383): update operating status values

* feat(OvertureMaps#383): update example

* feat(OvertureMaps#383): add doc to confidence behavior for closed places

* feat(OvertureMaps#383): nit: add space after commas

* Update counterexamples/places/bad-operating-status.yaml

Co-authored-by: Seth Fitzsimmons <sethfitz@amazon.com>

* Update examples/places/place-with-operating-status.yaml

Co-authored-by: Seth Fitzsimmons <sethfitz@amazon.com>

* Update examples/places/place-with-operating-status.yaml

Co-authored-by: Seth Fitzsimmons <sethfitz@amazon.com>

* Update counterexamples/places/bad-operating-status.yaml

Co-authored-by: Seth Fitzsimmons <sethfitz@amazon.com>

* add clarification

* mark operating status as required and remove the default for clarity

* fix test

* fix more tests

* Remove extra conflict >>>>>>

---------

Co-authored-by: Jens Goossens <jens.goossens@tomtom.com>
Co-authored-by: Jens Goossens <82045265+jensgoossens-tomtom@users.noreply.github.com>
Co-authored-by: Seth Fitzsimmons <sethfitz@amazon.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.

9 participants