docs: update v3 pagination schema

envelope-zero · Nov 11, 2023 · a932fe1 · a932fe1
1 parent 0f382e9
commit a932fe1
Showing 1 changed file with 17 additions and 23 deletions.
diff --git a/static/schemas/v3/pagination.schema.json b/static/schemas/v3/pagination.schema.json
@@ -4,33 +4,27 @@
   "title": "Pagination",
   "description": "The pagination information",
   "type": "object",
-  "required": [
-    "total_records",
-    "current_page",
-    "total_pages",
-    "next_page",
-    "prev_page"
-  ],
+  "required": ["count", "limit", "offset", "total"],
   "properties": {
-    "total_records": {
-      "description": "The total amount of resources for the query",
-      "anyOf": [{ "type": "integer", "minimum": 0 }, { "type": "null" }]
+    "count": {
+      "description": "The number of results in this response",
+      "type": "integer",
+      "minimum": 0
     },
-    "current_page": {
-      "description": "The page currently viewed",
-      "anyOf": [{ "type": "integer", "minimum": 1 }, { "type": "null" }]
+    "limit": {
+      "description": "The limit for the number of results used for this response",
+      "type": "integer",
+      "minimum": 0
     },
-    "total_pages": {
-      "description": "The number of pages for the query",
-      "anyOf": [{ "type": "integer", "minimum": 1 }, { "type": "null" }]
+    "offset": {
+      "description": "The offset of the first resource returned",
+      "type": "integer",
+      "minimum": 0
     },
-    "next_page": {
-      "description": "The next page",
-      "anyOf": [{ "type": "integer", "minimum": 2 }, { "type": "null" }]
-    },
-    "prev_page": {
-      "description": "The previous page",
-      "anyOf": [{ "type": "integer", "minimum": 1 }, { "type": "null" }]
+    "total": {
+      "description": "Total number of records matching the query",
+      "type": "integer",
+      "minimum": 0
     }
   }
 }