Quantcast
Channel: Syncthing Community Forum - Latest topics
Viewing all articles
Browse latest Browse all 6195

REST API Feedback

$
0
0

Firstly thank you for making and maintaining Syncthing, it’s fantastic!

Secondly this is not a criticism, just a constructive feedback. Please don’t take it the wrong way.

  1. Logic in the UI rather than in backend. In particular when it comes to status like “Out of Sync” or “Locally changed”, these are “computed” in the UI based on logic that is present in the UI only. IMHO these should be “computed” in the backed returned by the API, not decided by the UI. If someone wanted to write their own UI then you’d have to look at a logic in the Web UI to make it work similar way. Everything should be returned by the API so different API clients work the same way.

  2. RESTful API URL scheme, in particular resource names. I don’t think that URL and resource naming scheme for REST is defined by any standard, however from my past work and use of API linters, the URL should be in form of POST /v1/db/foldername/scan, rather than POST /rest/db/scan?folder=foldername. Using query strings for resource names is not very RESTy… Also instead of making something as obsolete in the documentation, please consider versioning scheme. I know this is debatable, maybe for future consideration.

1 post - 1 participant

Read full topic


Viewing all articles
Browse latest Browse all 6195

Trending Articles