File Citation in Formats API extension: include a version parameter
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 564
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
Issue #11733 added support for retrieving file citations in multiple formats, similar to the existing dataset-level Get Citation In Other Formats API.
However, file citations also need to clearly identify the dataset/file version being cited. Now, without a version parameter, the API always return latest version of citation. Similar to Get Citation in Native API, we need to include a version param
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Formats API extension added by issue #11733 and compare its file-citation handling with the linked Get Citation in Native API documentation. Trace the existing file-citation endpoint and its request parameters, then verify that a supplied version selects the requested dataset/file version rather than always returning the latest citation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100