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.

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

API - Documentation need improvments #1932

Open
mikaelparkefelt opened this issue Apr 12, 2024 · 1 comment
Open

API - Documentation need improvments #1932

mikaelparkefelt opened this issue Apr 12, 2024 · 1 comment

Comments

@mikaelparkefelt
Copy link

Hi,

The API is documented at the following pages:

  1. https://docs.semui.co/administration-guide/api
  2. https://www.semui.co/api-docs/

In the first page you have very good and easy to explain examples.

But on the second page you do not. I would like you to document the API in a better way with a lot of examples for each request that could be made and more details.

@fiftin
Copy link
Collaborator

fiftin commented Apr 14, 2024

Hi,

second page is auto generated docs (OpenID). It is good idea to make it more friendly :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants