backend icon indicating copy to clipboard operation
backend copied to clipboard

Better documentation of the REST API

Open FlorianDev opened this issue 2 years ago • 1 comments

Hi,

I am currently trying to use the REST API. Unfortunately, the documentation doesn't really help me because, for example, the expected parameters are not specified. Is it possible to customize the documentation? I am currently trying to find out the parameters from the source code.

Thank you Florian

FlorianDev avatar Dec 01 '23 08:12 FlorianDev

I'm thinking about godoc with a GitHub Actions workflow to generate and publish it to GitHub Pages accordingly.

This way there shouldn't be any manual work.

yarons avatar Jul 19 '24 11:07 yarons