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

Format external IDs as URLs in ROR API #173

Open
mariagould opened this issue May 21, 2021 · 0 comments
Open

Format external IDs as URLs in ROR API #173

mariagould opened this issue May 21, 2021 · 0 comments
Labels
enhancement Improvement/change to existing functionality external IDs Handling external IDs in ROR

Comments

@mariagould
Copy link
Contributor

External IDs in the ROR API are formatted as strings. They are formatted as URLs in ror-app. The URL transformation is currently hard-coded in ror-app.

It is not ideal to have inconsistent forms of external IDs across ror-api and ror-app. All of the external IDs that ROR maps to should be actionable URLs.

Formatting external IDs as URLs also minimizes extra formatting work as part of the curation process. Curators preparing ROR metadata records will be starting with the URL form of the external ID and they should not have to perform additional formatting to convert it to a string.

Example:
In https://api.ror.org/organizations/https://ror.org/05ch0aw77 the ISNI ID is "0000 0001 2173 6488"
In https://ror.org/05ch0aw77 the ISNI ID is a clickable URL that resolves to http://isni.org/isni/0000000121736488

Desired functionality:
In https://api.ror.org/organizations/https://ror.org/05ch0aw77 the ISNI ID should be formatted as "http://isni.org/isni/0000000121736488"

User stories

  • As a user, I want to have an actionable URL form of the external ID in the ROR API so that I can easily access information about the external ID
  • As a user, I want to have an actionable URL form of the external ID in the ROR API so that I can easily match the external ID to other datasets without having to perform additional transformations
  • As a curator, I want to provide the actionable URL form of the external ID when I create a metadata record so that I do not have to perform additional formatting to turn the URL form into a string
@mariagould mariagould added the external IDs Handling external IDs in ROR label May 21, 2021
@mariagould mariagould changed the title Format external IDs as URLs Format external IDs as URLs in ROR API Mar 1, 2022
@mariagould mariagould added the enhancement Improvement/change to existing functionality label Mar 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement/change to existing functionality external IDs Handling external IDs in ROR
Projects
Development

No branches or pull requests

1 participant