Description
We are addressing a bug in the simple search API with the following subset POST parameters:
- oauthClientNames
- httpMethods
- templateUris
All of these parameters are a List <String> type. In the API, a query is generated based on these parameters, each of the list items are used in an AND condition whereas they should be used with an IN condition. For example, including the POST body parameter httpMethods with its value being [“GET”, “POST"], the query generator generates “WHERE httpMethod = ‘GET’ AND httpMethod = ‘POST’”.
This new change will yield “WHERE httpMethod in (‘GET’, ‘POST’).”
Additionally, the POST body parameter httpMethods will be changed to Type List<ENUM> instead of list<String>.
Change Category
API
Change Context
The reason for these changes is to address bugs discovered in the simple search endpoints. The user request is being improperly processed and the logic within the API is incorrect, resulting in incorrect data being returned to the user.
Change Impact
In terms of impact to customers, no change to the request body will be needed as the parameters being passed into the API remains the same. The response object parameters will also remain the same. However, you may notice different results being returned for the same request when comparing the new changes to what is currently implemented. Furthermore, as there will now be additional parameter validation, users will get additional error messages for bad requests.
Date of Change
Immediate: no sooner than August 7th, 2023
Impacted APIs
POST /api/v2/usage/simplesearch
GET /api/v2/usage/simplesearch/{executionId}/results
References
[USAGE-1232]