IQSS / IQSS/dataverse

Move documentation about "Move dataset" API endpoint from Admin guide to API Guide

Open
#8,120 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: Admin Guide Feature: API Guide
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

In Dataverse software v6.3, the "Move dataset" API endpoint is documented in the Admin Guide, which "documents the functionality only available to superusers". But that endpoint is also usable by accounts that aren't superuser accounts. From what I can tell so far, the account just needs to have certain permissions on the dataset, the collection that the dataset is in, and the collection that the dataset should be moved into. Sometimes users like collection managers who don't have superuser accounts need to move a dataset into their collection and are able to use this endpoint.

I think info about the "Move dataset" API endpoint should be moved into the Native API Guide, unless the endpoint should really be available only to superuser accounts.

I wonder if other endpoints described in the Admin Guide that are available to all non-superuser accounts should be moved into the API Guide.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked "Move a dataset" section in the 6.3 Admin Guide and locate its source documentation files, then compare the Native API Guide structure. Confirm the endpoint's permissions and decide whether the section belongs in the API Guide; done means the documentation is moved or the access-policy rationale is clarified, with related endpoints assessed if in scope.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.