Specify a minimum set of search parameters / query parameters

euniversal / umei-api-specification

UMEI API specifications

Apache License 2.0

3 stars 0 forks source link

Specify a minimum set of search parameters / query parameters #18

Closed narve closed 2 years ago

narve commented 2 years ago

Several of the endpoints, e.g. /orders, should accept filters to limit the search results.

Some general seach filters are:

Take/Maxhits/Limit, to say how many hits you want returned
StartFrom/Skip, to get the next "page" of data if there are more hits than returned.

Examples of more specific filters:

portfolioId, for order-searches (/orders)
orderId, for trade-searches (/trades)
name, for portfolio-searches (/portfolios)

This issue is about whether we should specify any of these filters as part of the initial UMEI specification or not. If not, each FMO will still have to implement these filters, and it will be in inconsistencies between different FMOs.

cdmNSIDE commented 2 years ago

Hello Narve,

In my opinion, defining a list of filters for the search queries is something required to improve the robustness of the market platform. The underlying question is therefore to know what is the minimal robustness that we want to / must achieve in the framework of this project ... I would try to keep it as simple as possible. I think that an important filter to have is to limit the results returned depending on the access rights of the entity who submit the request.

narve commented 2 years ago

Filter on access rights are implicit - I don't think we need any API changes to support that?

narve commented 2 years ago

@cdmNSIDE see updated description. What do you think? I can come up with a proposal if you agree that we should include some of this.

cdmNSIDE commented 2 years ago

Hello @narve ,

Yes I agree with the general filters proposed. If it's ok for you you can come up with a proposal and I will ask my colleague to check it (I have never implemented those kind of filters)

For the more specific filters, what do you think to add to your proposal:

For the orders: filter by gridNodeId ? filter by marketId ? filter by status ? filter by time period ?
For the baselines: filter by portfolioId ? filter by gridNodeId ? filter by time period ?
For the trades: same filters than the orders ?
For the measurements: same filters than the baselines ?