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

Some API doc/sample seems not up-to-date #150

Open
boly38 opened this issue Jan 21, 2024 · 0 comments
Open

Some API doc/sample seems not up-to-date #150

boly38 opened this issue Jan 21, 2024 · 0 comments

Comments

@boly38
Copy link
Contributor

boly38 commented Jan 21, 2024

Hi,
following umami 2.9.0 study, I encounter some diff between doc and real endpoints.
Maybe some update of the doc are needed.

(source: boly38/umami-api-client#17)

doc: https://umami.is/docs/api

  • auth - ok
  • users - GET : 405 (that's maybe because I didnt use this feature)
  • teams or websites - GET response structure
{
  "data": [],
  "count": 0,
  "page": 1,
  "pageSize": 10,
  "orderBy": "name"
}

=> ⚠️ data level is not reported in umami doc ?

in https://umami.is/docs/website-stats

  • error in first : /active uses /stats as example (we expect a /active as example)
  • and there is no details on /stats

Bonus: in order to retrieve this website repository, it could be great to add in the footer a link to the website repository in addition to the "umami" core one (out of mistake from me, I didn't find it quickly) - or that could be inline link "improve me..." button for example.

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

No branches or pull requests

1 participant