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

Create an endpoint to retrieve the file citation #10240

Closed
MellyGray opened this issue Jan 18, 2024 · 0 comments · Fixed by #10246
Closed

Create an endpoint to retrieve the file citation #10240

MellyGray opened this issue Jan 18, 2024 · 0 comments · Fixed by #10246
Labels
pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 10 A percentage of a sprint. 7 hours. SPA These changes are required for the Dataverse SPA User Role: API User Makes use of APIs
Milestone

Comments

@MellyGray
Copy link

MellyGray commented Jan 18, 2024

Overview of the Feature Request
Create an endpoint to retrieve file citation. This endpoint will be the equivalent to the existing one for retrieving dataset citation but for the file citation

Note that the citation may include HTML elements, such as an anchor with a link, e.g., Finch, Fiona, 2024, "Darwin's Finches", <a href="https://doi.org/10.5072/FK2/GNCFOD" target="_blank">https://doi.org/10.5072/FK2/GNCFOD</a>, Root, DRAFT VERSION; blob [fileName].

Also, please review this PR conversation about the composition of the citation: IQSS/dataverse-frontend#269 (comment).

What kind of user is the feature intended for?
API User

What inspired the request?

What existing behavior do you want changed?
None

Any brand new behavior do you want to add to Dataverse?
Add new endpoint to the API to retrieve the file citation

Any open or closed issues related to this feature request?

Issue to add the endpoint to get the dataset citation:

Also related:

@MellyGray MellyGray added Type: Feature a feature request pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows SPA These changes are required for the Dataverse SPA User Role: API User Makes use of APIs and removed Type: Feature a feature request labels Jan 18, 2024
@GPortas GPortas added the Size: 10 A percentage of a sprint. 7 hours. label Jan 18, 2024
@GPortas GPortas moved this to SPRINT READY in IQSS Dataverse Project Jan 18, 2024
@GPortas GPortas moved this from SPRINT READY to This Sprint 🏃‍♀️ 🏃 in IQSS Dataverse Project Jan 18, 2024
@pdurbin pdurbin moved this from This Sprint 🏃‍♀️ 🏃 to In Progress 💻 in IQSS Dataverse Project Jan 18, 2024
@pdurbin pdurbin self-assigned this Jan 18, 2024
@pdurbin pdurbin removed their assignment Jan 18, 2024
pdurbin added a commit that referenced this issue Jan 23, 2024
pdurbin added a commit that referenced this issue Feb 7, 2024
pdurbin added a commit that referenced this issue Feb 7, 2024
pdurbin added a commit that referenced this issue Feb 7, 2024
pdurbin added a commit that referenced this issue Feb 7, 2024
Conflicts:
src/test/java/edu/harvard/iq/dataverse/api/FilesIT.java
@pdurbin pdurbin added this to the 6.2 milestone Feb 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pm.GREI-d-2.7.1 NIH, yr2, aim7, task1: R&D UI modules for creating datasets and supporting publishing workflows pm.GREI-d-2.7.2 NIH, yr2, aim7, task2: Implement UI modules for creating datasets and publishing workflows Size: 10 A percentage of a sprint. 7 hours. SPA These changes are required for the Dataverse SPA User Role: API User Makes use of APIs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants