chore(rest): explain more clearly how to use /rest/db/file #817
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds an example curl call and explains the parameters more clearly. It's not immediately obvious how to use this endpoint from the existing docs. Hopefully this will help others figure it out. Reading the forums I don't think I was the only person confused by this page.
👷 Deploy request for syncthing-docs pending review.Visit the deploys page to approve it
|
tomasz1986
reviewed
Aug 20, 2023
tomasz1986
reviewed
Aug 20, 2023
tomasz1986
reviewed
Aug 20, 2023
tomasz1986
reviewed
Aug 20, 2023
tomasz1986
reviewed
Aug 20, 2023
imsodin
reviewed
Aug 20, 2023
Co-authored-by: tomasz1986 <[email protected]>
Co-authored-by: tomasz1986 <[email protected]>
Co-authored-by: tomasz1986 <[email protected]>
Co-authored-by: tomasz1986 <[email protected]>
Co-authored-by: tomasz1986 <[email protected]>
tomasz1986
reviewed
Aug 20, 2023
|
Thanks for all the suggested improvements to my patch, I've applied them all now |
acolomb
requested changes
Aug 21, 2023
rest/db-file-get.rst
Outdated
|
|
||
| .. code-block:: bash | ||
|
|
||
| curl --silent --get --header "X-API-KEY: YOUR_API_TOKEN" "http://localhost:8384/rest/db/file?folder=YOUR_FOLDER_ID" --data-urlencode "file=path/to/file.pdf" |
There was a problem hiding this comment.
There are already numerous examples involving curl in the docs. I'd find it convenient to adopt the same CLI options used there, e.g. -H instead of --header and omit the --get.
| @@ -19,7 +38,10 @@ respectively. | |||
| "local": { /* a file entry */ } | |||
| } | |||
|
|
|||
| A file entry looks like this:: | |||
| ``local`` and ``global`` refer to the current file on the local device and the | |||
| globally newest file, respectively. A file entry looks like this: | |||
There was a problem hiding this comment.
There is a factual error here. The mtime attribute is not part of the respective file entry, but top-level next to availability. When that is fixed, the outer object wrapping can go away in this code sample.
More closely follow the other examples and fix use of --url-query instead of --data-urlencode.
It lives on the same level as global and local, not inside each of them.
acolomb
changed the title
acolomb
changed the title
In contrast to the /rest/debug/file endpoint, this one lacks the global versions info. Thus the statement "most data" was correct.
acolomb
force-pushed
the
rest-file-example
branch
from
805a858 to
f02400b
Compare
acolomb
approved these changes
Jan 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds an example curl call and explains the parameters more clearly.
It's not immediately obvious how to use this endpoint from the existing docs. Hopefully this will help others figure it out. Reading the forums I don't think I was the only person confused by this page.