You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the solution you'd like
Provide a standardised way to implement search among all the endpoints that support it. In particular we want to:
Reduce the amount of endpoint specific code and do as much in the core endpoint
Ability to provide metadata to the CLI or other user facing interfaces to draw from
I suggest implementing an end to end solution for two of the endpoints to prove the use case and the requirements e.g:
Card types
Cardholders
Consider leaving attribute filtering out of the initial solution to keep things relatively simple.
Describe alternatives you've considered
NA
Additional context
There are certain parameters like name that support sql like syntax:
Limits the returned items to those with a name that matches this string.
Without surrounding quotes or a percent sign or underscore, it is a substring
match; surround the parameter with double quotes "..." for an exact match.
Without quotes, a percent sign % will match any substring and an underscore
will match any single character.
We should ensure that those parameters are sanitised before they are sent through to the REST API.
Checklist of the various endpoints that support search, for implementation reference:
implements a version of search in the core package for all endpoints to
use, this performs a number of cleanups:
- removes unused search method signatures and merges them into core
- updates enum with a generic signature that can be reused
- updates test case for testing cardholder profiles
- cleans up core to accept parameters as part of the internal get call
refs #51
Is your feature request related to a problem? Please describe.
Search is a common feature around the API and has two main characteristics:
2.10
) #20)Describe the solution you'd like
Provide a standardised way to implement search among all the endpoints that support it. In particular we want to:
core
endpointmetadata
to the CLI or other user facing interfaces to draw fromI suggest implementing an end to end solution for two of the endpoints to prove the use case and the requirements e.g:
Consider leaving attribute filtering out of the initial solution to keep things relatively simple.
Describe alternatives you've considered
NA
Additional context
There are certain parameters like
name
that supportsql
like syntax:We should ensure that those parameters are sanitised before they are sent through to the REST API.
Checklist of the various endpoints that support search, for implementation reference:
Sample interaction with
httpie
:The text was updated successfully, but these errors were encountered: