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

Rename the auxiliary file download API? #7850

Closed
landreev opened this issue May 5, 2021 · 3 comments · Fixed by #7866
Closed

Rename the auxiliary file download API? #7850

landreev opened this issue May 5, 2021 · 3 comments · Fixed by #7866
Assignees

Comments

@landreev
Copy link
Contributor

landreev commented May 5, 2021

Proposal to rename the current form of the API:

/api/access/datafile/{fileId}/metadata/{formatTag}/{formatVersion}

to

/api/access/auxiliaryfile/{fileId}/{formatTag}/{formatVersion}

Because aux. files do not necessarily have to be "metadata". And in order to avoid potential conflicts with other forms of /api/access/datafile.

@qqmyers
Copy link
Member

qqmyers commented May 5, 2021

Since the file id there is still the datafile id, perhaps
/api/access/datafile/{fileId}/auxiliaryfile/{formatTag}/{formatVersion}

or
/api/access/datafile/{fileId}/aux/{formatTag}/{formatVersion} ?

@djbrooke
Copy link
Contributor

djbrooke commented May 5, 2021

Good idea. I don't have strong feelings about what to rename it to, but now's the time.

@landreev
Copy link
Contributor Author

landreev commented May 5, 2021

OK, let's drop the "file", but spell "auxiliary" fully:
/api/access/datafile/{fileId}/auxiliary/{formatTag}/{formatVersion}
?

(the code change would be trivial; will just need to carefully reflect it in the docs and the tests)

@djbrooke djbrooke added the Small label May 5, 2021
@landreev landreev moved this from Up Next 🛎 to IQSS Team - In Progress 💻 in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) May 6, 2021
@landreev landreev self-assigned this May 6, 2021
landreev added a commit that referenced this issue May 11, 2021
landreev added a commit that referenced this issue May 11, 2021
kcondon added a commit that referenced this issue May 13, 2021
Renaming the new APIs for auxiliary files. (#7850)
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

Successfully merging a pull request may close this issue.

3 participants