Native API : Get dataset citation result not unescaped
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 564
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
The output from the get dataset citation command (https://guides.dataverse.org/en/latest/api/native-api.html#get-citation) retrieves an escaped citation.
What steps does it take to reproduce the issue?
-
When does this issue occur?
Example: https://demo.dataverse.org/api/v1/datasets/:persistentId/versions/:latest/citation?persistentId=doi:10.70122/FK2/ACDRRT : Author NameÉxàmpl€appears asÉxàmpl&euro,
while it is not the case with other API commands e.g. https://demo.dataverse.org/api/v1/datasets/:persistentId/versions/:latest?persistentId=doi:10.70122/FK2/ACDRRT : Author NameÉxàmpl€appears asÉxàmpl€. -
Which page(s) does it occurs on?
API citation (https://guides.dataverse.org/en/latest/api/native-api.html#id122) -
To whom does it occur (all users, curators, superusers)?
API users -
What did you expect to happen?
The citation should be unescaped, as results from other commands.
Which version of Dataverse are you using?
6.5 (reproduced on Demo Dataverse)
Any related open or closed issues to this bug report?
None seen on this endpoint but
- #10257 it might be an opportunity to review the documentation
- #9994
Are you thinking about creating a pull request for this issue?
Maybe depending on the complexity to unescape the text :)
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 Native API get-citation endpoint and compare its response for the supplied persistent identifier with the regular dataset-version response. Trace where the citation output is generated and verify that names such as Éxàmpl€ are returned unescaped, matching the expected behavior described in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, backend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100