View Issue Details

IDProjectCategoryView StatusLast Update
0007949Talerspecificationpublic2023-10-05 16:43
Reportersebasjm Assigned To 
Status confirmedResolutionopen 
Product Versionpost-1.0 
Target Versionpost-1.0 
Summary0007949: unified set of parameters for endpoint with pagination
Descriptioncurrent state:

delta and start[-instances-$INSTANCE]-private-orders

limit and offset[-instances-$INSTANCE]-private-transfers[-instances-$INSTANCE]-private-rewards


if we want the result to be paginated it will be enough to have
 * offset: id of the element in the list ( equals product_id in products or order_id in orders)
 * limit: max number of elements in the list

if we need the result to be ordered by some criteria defined by the client (other than the default)
 * order: criteria name in increasing order, a hyphen symbol at the start indicate decreasing

the criteria for witch the order is possible should be explicitly indicated in the endpoint documentation (since it will match some index in the db), for example:
 - creation_time
 - last_update_time
 - execution_time

Additional parameters are considered filters and every filter has its own semantic.
Like "before", "after" in transfers or "date_s" in orders.

modification to the current API
 1 names are always use offset and limit
 2 offset is always the row id or element id
 3 order is specified as a parameter, not in the limit parameter as a hyphen

This will also allow the SPA client to have sorting columns in the table UI in the future.
TagsNo tags attached.


There are no notes attached to this issue.

Issue History

Date Modified Username Field Change
2023-10-05 14:47 sebasjm New Issue
2023-10-05 14:47 sebasjm Status new => assigned
2023-10-05 14:47 sebasjm Assigned To => Christian Grothoff
2023-10-05 16:43 Christian Grothoff Assigned To Christian Grothoff =>
2023-10-05 16:43 Christian Grothoff Status assigned => confirmed
2024-01-12 14:02 Christian Grothoff Category merchant backend API (HTTP specification) => specification