search

lacuna-tech / mds-core

Repo for LADOT MDS implementation for contribution to the Open Mobility Foundation
Apache License 2.0
13 stars 9 forks source link

Policy: Property `publish_date` should be renamed to `published_date` to satisfy MDS Spec #973

Closed d-koppenhagen closed 2 years ago

d-koppenhagen commented 2 years ago

Hi, during implementation we noticed, that the policy entity in mds-core policy API accepts and check the property publish_date but the property defined in the MDS Spec (Policy API) is names as published_date. This behaviour is a bit inconsistent compared to the geographies API where the property is named publish_date indeed.

Probably the best solution would be to use a consistent naming in geographies and policies API in the MDS spec. But this would lead into a breaking change for one of this APIs.

When not adjusting the spec, the property should be renamed in policy API in mds-core which will also comes with the need of migration from existing data.

avatarneil commented 2 years ago

@d-koppenhagen thank you for flagging this! I'm escalating with the team, hopefully we should have a fix out shortly. This might be a case where policies have to be a bit mutable (so we can fix them) 😅

avatarneil commented 2 years ago

This is resolved by #975. Thanks again for raising this @d-koppenhagen!