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

Server API documentation undocumented endpoints & fields #21

Open
napewnoarnold opened this issue Feb 28, 2024 · 0 comments
Open

Server API documentation undocumented endpoints & fields #21

napewnoarnold opened this issue Feb 28, 2024 · 0 comments

Comments

@napewnoarnold
Copy link

Hello Developers 👋

I'm using thinger.io solution only as a back-end server, in other words, I'm reimplementing the Angular console for my own use case.
The swagger documentation is very helpful, as is taking a peek into dev tools to see how your frontend project calls REST api, however I keep finding values I don't understand, or endpoints that return data or expect payload that's not clear to me.
So far, I've been getting by with guessing what fields represent, or testing what data is sent by UI when I change it here or there.

An example of such data could be the state field in alarms endpoint - it's practically a guessing game what number represents which state

I was wandering - are there any plans to extends the docs "Server API" section to describe certain models in more detail?
Would it be possible for you guys to share console angular source code - to see how the data is mapped to ui?

Cheers

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