瀏覽代碼

Add an example

Lucian Petrut 1 周之前
父節點
當前提交
79c55ce548
共有 1 個文件被更改,包括 15 次插入0 次删除
  1. 15 0
      README.rst

+ 15 - 0
README.rst

@@ -148,6 +148,21 @@ Delete a migration job:
 
 Note: only completed, failed or cancelled jobs can be deleted.
 
+The following Coriolis APIs support pagination:
+* transfers
+* transfer executions
+* deployments
+* endpoint instances (only marker and limit parameters)
+
+Pagination 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
 
 API Documentation
 -----------------