API Endpoints Inconsistencies #22
Description
The documentation does not clearly and consistently define the main/common component of the API call and the endpoint of the API call.
For example, for the API call to list all processes the user has access to, the call is /api/v1/processes, and for the other calls, the documentation has an endpoint of the format /v1/{API endpoint}.
Without clear communication, what would typically happen is that a new user would first read the OAuth page of the documentation. (The readme document also leads readers to the OAuth page first as well.)
The OAuth page provides conflicting information – the main API component is implied to be https://[env].solvexia.com with no clear definition of what [env] is. Further, at the bottom of the page, the main URL is given as https://app.solvexia.com/api/v1/processes. This would most likely create confusion and frustration for users as they may use the app keyword.
Next, by implication, the endpoint for process list starts with the /api (which is the last time this is seen in the documentation). For all further API calls, all API endpoints start with /v1. If users were to follow the documentation, they would not be able to use any API calls except the process list.
Example – Wrike communicates this sufficiently well.
Below screenshot shows how they communicate what the base URL is.
