nextcloud / nextcloud/documentation

hideDownload attribute for shares in OCS is not documented

Open
#9,498 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

1. to develop feature: sharing good first issue manual: developer technical debt
Dominant language
JavaScript
Stars
628
Forks
2.5k
Avg merge
2d 11h
Merged PRs (30d)
135

Description

The web UI does this when checking the box:

curl 'https:///ocs/v2.php/apps/files_sharing/api/v1/shares/375560' -X PUT […] --data-raw '{"hideDownload":"true"}'

But https://docs.nextcloud.com/server/latest/developer_manual//client_apis/OCS/ocs-share-api.html#update-share does not list hideDownload as a potential attribute.
It should also be listed in the POST documentation if it is available for POST as well.

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

Open the linked OCS Share API documentation and inspect the update-share section first. Check whether hideDownload is supported for both PUT and POST, then document it in each applicable section. Done means the documented attributes match the web UI behavior and the API’s supported operations.

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
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.