Feature Request/Idea: In API Guides, document additions to User Traces endpoint
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 564
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
Overview of the Feature Request
What kind of user is the feature intended for?
API User, Curator, Superuser, Sysadmin
What inspired the request?
Finding the GitHub issue https://github.com/IQSS/dataverse/issues/7952 and seeing that the changes aren't mentioned in the API Guides.
What existing behavior do you want changed?
To the section in the API Guides about the User Traces API endpoint, adding how you can search for the user's activity based on the role assignment they have.
Any related open or closed issues to this feature request?
https://github.com/IQSS/dataverse/issues/7952
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 API Guides section for the User Traces API endpoint linked in the issue, then read related issue #7952 to identify the behavior that is missing from the guide. Update that section to document searching user activity by role assignment, and verify the wording matches the endpoint's documented usage.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100