search

whosonfirst / whosonfirst-properties

What things mean in Who's On First documents
Other
5 stars 5 forks source link

Update abbreviation, abrv, shortcode #78

Open stepps00 opened 5 years ago

stepps00 commented 5 years ago

wof:abbreviation was deprecated and replaced by wof:shortcode. Similarly, we have both the abrv:* and abbreviation:* property prefixes. though we now use abrv:*.

Crawl the repo, figure out what properties are currently being used, and update property descriptions/data as necessary.

missinglink commented 5 years ago

agh.. do you happen to know the date when this change happened?

missinglink commented 5 years ago

whenever properties like this change it has the potential to break integrations such as ours, we really need some way of getting a heads-up for changes like this which allow us to 'get ahead' of the changes and to get patches merged and released ahead of time.

it's tricky as a consumer to keep up-to-date with which field means what, I totally not saying we shouldn't change stuff, not at all, just saying that it needs to be done in a way that is mindful of consumers, otherwise the 'API footprint' of the gazeteer is unstable, causing headaches for us that sometimes don't get caught until late-stage testing or even making their way to production and getting spotted by users.

when you say 'deprecated', does that mean the fields stick around for some time to give a migration window or are they just renamed?

stepps00 commented 5 years ago

wof:abbreviation was deprecated last year, in favor of wof:shortcode. Right now, WOF stores both abbreviation:* and abrv:* property prefixes, but we really only need one.

Since many of the PRs have been merged in whosonfirst-data recently, I filed this issue as a follow up to make sure we're correctly cataloguing each property.

when you say 'deprecated', does that mean the fields stick around for some time to give a migration window or are they just renamed?

Some of the wof:abbreviation properties stuck around, but wof:shortcode should be the go-to property now.

Going forward, I agree that Pelias/services need a heads up for changes like this -- short of checking new PRs, do you have a proposal? Happy to craft a change log or sync about changes.