Background
...
OpenSRP is committed to building endpoints that adhere to these standards. This might necessitate the building of new endpoints for already existing functionality. This then necessitates the need to version API API’s endpoints for easier use.
To solve this we choose decided to add the version number to the endpoint URL path. OpenSRP currently has 2 versions of some of its endpoint e.g the settings endpoint. The addition of v2 on the endpoint path denotes that the endpoint is the second version
...
Add the version number before the endpoint noun on the path e.g https://ona-stage.smartregister.org/opensrp/rest/v2/settings. In case we already have a v2 endpoint version then the version number is incremented by 1.
...
A change in the format of the response data for one or more calls
A change in the format of the request payload for the POST, PUT & PATCH HTTP methods that does not maintain backward compatibility
A change in the response type (i.e. changing an integer to a float)
Removing any part of the API.
...