Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better documentation of the REST API #205

Open
FlorianDev opened this issue Dec 1, 2023 · 1 comment
Open

Better documentation of the REST API #205

FlorianDev opened this issue Dec 1, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@FlorianDev
Copy link

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
@virtualzone virtualzone added the documentation Improvements or additions to documentation label Dec 12, 2023
@yarons
Copy link

yarons commented Jul 19, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@yarons @FlorianDev @virtualzone