syncthing / syncthing/docs

rest: Missing parameter "dirsonly" in /db/browse

Open
#871 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
327
Forks
653
PR merge metrics
No merged PRs in 30d

Description

The Syncthing API code evaluates a parameter named dirsonly on the GET /rest/db/browse call:

https://github.com/syncthing/syncthing/blob/17e60b9e0c340d12b80d015663c058bd54d03557/lib/api/api.go#L778

This parameter is not documented. Especially it should be cleared up what values are evaluated as true: no, 0 and false would all be regarded as true if I read the code correctly. Maybe that should be tightened / specified more clearly also in the API code.

Contributor guide

No contributing guide indexed for this repository

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

Read lib/api/api.go at the linked location to confirm how the GET /rest/db/browse dirsonly parameter is evaluated. Find the corresponding API documentation, document the parameter and its accepted true values, and clarify whether the API behavior also needs adjustment.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.