Allow using pagination

[petrutlucian94]

At the moment, listing endpoint instances is the only Coriolis API that supports pagination. For this reason, Coriolis clients often retrieve much more database records than needed, leading to poor performance.

We're now adding pagination to other Coriolis APIs:

• transfers
• transfer executions
• deployments

New optional parameters:

• sort_key - sort key, repeatable. created_at and id are used by default.
• sort_dir - sort direction, repeatable. asc or desc (default).
• marker - the last seen ID, omitted from the results.
• limit - the maximum number of records to retrieve.

Example:

GET http://server:7667/v1/transfers?marker=a7061715-e56c-470c-a6ac-80bb02f1f198&limit=2&sort_key=id&sort_dir=asc

[petrutlucian94]

This implies that we'll have two sort parameters, one for the db side sort and pagination and another one for the standard client side sorting:

List transfer executions

positional arguments:
  transfer      The transfer's id

options:
  -h, --help            show this help message and exit
  --marker MARKER
                        The id of the last retrieved execution.
  --limit LIMIT
                        Maximum number of executions to retrieve.
  --sort SORT   Comma-separated list of sort keys and directions in the form of <key>[:<asc|desc>]. The direction defaults to descending if not specified.

output formatters:
  output formatter options

  -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}
                        the output format, defaults to table
  -c COLUMN, --column COLUMN
                        specify the column(s) to include, can be repeated to show multiple columns
  --sort-column SORT_COLUMN
                        specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
  --sort-ascending      sort the column(s) in ascending order
  --sort-descending     sort the column(s) in descending order

[claudiubelu]

nit: query should be a list, not a dict, as seen in the test below, and in the calls in the tests above. It has to be a list because the same key can be specified multiple times.

[petrutlucian94]

urlparse.urlencode accepts both, which is why _list does the same:

def _list(self, url, response_key=None, obj_class=None, json=None,
              values_key='values', query: dict | list | None = None):

test_list_with_dict_query covers dict query params, test_list_with_tuple_list_query handles lists of tuples.