Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't break identifiers #37

Closed
Floppy opened this issue Oct 8, 2014 · 15 comments
Closed

Don't break identifiers #37

Floppy opened this issue Oct 8, 2014 · 15 comments

Comments

@Floppy
Copy link

Floppy commented Oct 8, 2014

We rely on the license IDs that you define here for other apps. When they change (like for capitalisation, or renaming), it breaks things downstream that depend on them.

I accept renaming needs to happen, but when it does, perhaps older deprecated IDs could be kept around with some sort of link to the new ID in its JSON representation?

@rufuspollock
Copy link
Member

@Floppy absolutely - we need to redirect / alias and have a proper deprecation process.

@Floppy
Copy link
Author

Floppy commented Oct 9, 2014

Proposed a JSON representation for the deprecated IDs in #38

@rufuspollock
Copy link
Member

Great. Just as a BTW you may be interested in the proposal in okfn/opendefinition#7 (note we will promise no breakage - e.g. redirects will be put in ...)

@mlinksva
Copy link
Contributor

mlinksva commented Oct 9, 2014

Will have to move off gh-pages to implement redirects usefu to machine clients.

@Floppy
Copy link
Author

Floppy commented Oct 9, 2014

@Floppy
Copy link
Author

Floppy commented Oct 9, 2014

That may be irrelevant though, depending on how you're using gh-pages.

@mlinksva
Copy link
Contributor

mlinksva commented Oct 9, 2014

That just generates HTML with javascript redirects. You can see it in action at http://opendefinition.org/okd/

@Floppy
Copy link
Author

Floppy commented Oct 9, 2014

yeah, sorry, I just read through properly and realised that myself. Ignore me :)

@mlinksva
Copy link
Contributor

mlinksva commented Dec 1, 2017

https://github.com/okfn/licenses/pull/69/files#diff-df8c50fbd9842b77c087e6defc698cfa has a proposed rename and adds a legacy_id field with the old name. How about that?

@rufuspollock
Copy link
Member

@mlinksva i think that could work. @Stephen-Gates any thoughts at your end.

@Stephen-Gates
Copy link
Contributor

@rufuspollock I've highlighted this thread to ODI Labs who I believe use the data.

@mlinksva
Copy link
Contributor

mlinksva commented Dec 6, 2017

It'd appear its consumed in https://github.com/theodi/odlifier/blob/60d8d808f3b283a7c58d8c727ef0705ae30962f9/lib/odlifier.rb which is used in 3 other ODI projects https://github.com/theodi/odlifier/network/dependents

Hopefully it'll be easy for them to become legacy_id aware in odlifier?

@Floppy
Copy link
Author

Floppy commented Dec 12, 2017

I'm not there any more, but yes, one of us could easily update odlifier to use something like legacy_id.

@mlinksva
Copy link
Contributor

@Floppy I made a crude attempt at theodi/odlifier#56 ... untested, I'm not good at Ruby and don't grok the VCR stuff in tests. 😬 🗑

Anyway, I'll merge #69 (changes id of a few licenses to SPDX assignment, adds legacy_id to those) when I hear from you that it's handled by ODI's tools, or in some months if nobody cares. 😄

@mlinksva
Copy link
Contributor

Has been some months, assume nobody cares so merged #69 🎉

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

No branches or pull requests

4 participants