I have created a Labview toolkit for the Cloud user API. While doing so I ran into numerous inconsistencies in the user API documentation. It appears that the API evolved, but the documentation wasn’t updated.
To name a few:
It started with the issue I posted about not being able to request a code. The documentation should mention that every POST should have a content-type header
Many GET endpoints describe body parameters, that should really be URL parameters. The endpoint “get alerts” seems to get all data, rather than only the alerts.
Alert enum types are incompletely defined.
@otso Could you have a look at this documentation?
Thank you for the feedback. We’ll add the content-type header to documentation, improve error message on missing header and fix the GET parameter documentation
1 Like