APIs Tech Debt review
This page contains a list of endpoints that have been identified as a tech debt (either because of an incorrect design or lacking documentation). This should be reviewed as a part of https://openlmis.atlassian.net/browse/OLMIS-4726 and presented back to the tech committee.
Resource | Description | Notes | Decision / Action | Priority | Ticket |
|---|---|---|---|---|---|
commodityTypes/{id} | Returns a specific commodity type | Not currently in the API documentation | Give ability to retrieve a single commodity type by id | Major | |
facilities/supplying | Returns an array of facilities that are supplied by the same supervisory node | This API endpoint has poor documentation and no schema | The endpoint is not used by any OpenLMIS services or UI so for now we should mark it as deprecated and in the next release remove it | Minor | |
lots | Experimental resource to find lots in the system | This resource does not have a schema |
| Minor | |
lots/{id} | Experimental resource to find a specific lot | This resource does not have documentation |
| Minor | |
orderableDisplayCategories | Returns an array of orderableDisplayCategories | It has been marked red, but is there any issue with this endpoint? | Add description of the resource | Minor | |
orderableDisplayCategories/search | Find orderable categories with matched code. Returns an array. | This resource uses a GET method and all other search endpoints use a POST method |
| Major | |
processingSchedules | Returns an array of all processingSchedules | This resource does not have a schema. | Add missing schema for a page of processing schedules | Minor | |
processingSchedules/search | Retrieve processing schedule based on the provided parameters. | This resource uses a GET method and all other search endpoints use a POST method | merge the endpoint with /processingSchedules | Major | |
programs/search | Returns an array of programs | This resource uses a GET method and all other search endpoints use a POST method |
| Major | |
requisitionGroups | Returns an array of requisitionGroups | This resource does not have a schema. |
| Major | |
rights/search | Returns an array of user rights based on search criteria | This resource uses a GET method and all other search endpoints use a POST method |
| Major | |
users/{id} | Returns a specific user | This resource is not documented and may not exist due to the /users/{userId} endpoint. | rename parameter to follow syntax | Trivial | |
roles/{id} | Returns a specific user role | The documentation has this resource listed as /roles/{roleId} which doesn't follow the other syntax | rename parameter to follow syntax | Trivial | |
supplyLines/searchByUUID | Returns an array of supplyLines based on search criteria | This resource uses a GET method and all other search endpoints use a POST method |
| Major | |
tradeItems/{id} | Returns a specific trade item | This resource is not documented | Add description of the resource | Minor | |
requisitions/search | Returns an array of requisitions based on search criteria | This resource uses a GET method and all other search endpoints use a POST method | merge the endpoint with /requisitions | Major |