change only GET recent items endpoint

box · Sep 18, 2023 · 9bb8515 · 9bb8515
1 parent 574a19e
commit 9bb8515
Show file tree

Hide file tree

Showing 4 changed files with 132 additions and 70 deletions.
diff --git a/content/attributes/marker_pagination.yml b/content/attributes/marker_pagination.yml
@@ -18,11 +18,13 @@ properties:
   next_marker:
     description: |-
       The marker for the start of the next page of results.
-    example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
-    type: string
+    example: 3000
+    type: integer
+    format: int64
 
   prev_marker:
     description: |-
       The marker for the start of the previous page of results.
-    example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
-    type: string
+    example: 1000
+    type: integer
+    format: int64
diff --git a/content/attributes/marker_pagination_string_based.yml b/content/attributes/marker_pagination_string_based.yml
@@ -0,0 +1,28 @@
+---
+type: object
+
+description: |-
+  The part of an API response that describes marker
+  based pagination
+
+properties:
+  limit:
+    description: |-
+      The limit that was used for these entries. This will be the same as the
+      `limit` query parameter unless that value exceeded the maximum value
+      allowed. The maximum value varies by API.
+    example: 1000
+    type: integer
+    format: int64
+
+  next_marker:
+    description: |-
+      The marker for the start of the next page of results.
+    example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii
+    type: string
+
+  prev_marker:
+    description: |-
+      The marker for the start of the previous page of results.
+    example: JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih
+    type: string
diff --git a/content/responses/recent_items.yml b/content/responses/recent_items.yml
@@ -9,7 +9,7 @@ description: |-
   A list of recent items.
 
 allOf:
-  - $ref: "../attributes/marker_pagination.yml"
+  - $ref: "../attributes/marker_pagination_string_based.yml"
   - properties:
       entries:
         type: array

diff --git a/openapi.json b/openapi.json
@@ -25742,13 +25742,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -25860,13 +25862,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -27756,13 +27760,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -28099,13 +28105,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -28205,13 +28213,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -29054,13 +29064,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -29271,13 +29283,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -29934,13 +29948,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -30099,13 +30115,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -30330,13 +30348,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -30673,13 +30693,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -30831,7 +30853,7 @@
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
+                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih",
                 "type": "string"
               }
             }
@@ -32110,13 +32132,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -32222,13 +32246,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -35375,13 +35401,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -36121,13 +36149,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },
@@ -36407,13 +36437,15 @@
               },
               "next_marker": {
                 "description": "The marker for the start of the next page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 3000,
+                "type": "integer",
+                "format": "int64"
               },
               "prev_marker": {
                 "description": "The marker for the start of the previous page of results.",
-                "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
-                "type": "string"
+                "example": 1000,
+                "type": "integer",
+                "format": "int64"
               }
             }
           },