Fix pagination documentation for stellar-rpc

stellar · Mar 6, 2025 · eae3ac8 · eae3ac8
1 parent 7fbd6e4
commit eae3ac8
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 37 deletions.
diff --git a/openrpc/src/stellar-rpc/contentDescriptors/Pagination.json b/openrpc/src/stellar-rpc/contentDescriptors/Pagination.json
@@ -1,20 +1,11 @@
 {
-    "EventsPagination": {
+    "Pagination": {
         "name": "pagination",
         "summary": "pagination options",
         "description": "Pagination in stellar-rpc is similar to pagination in Horizon. See [Pagination](https://developers.stellar.org/docs/data/rpc/api-reference/pagination).",
         "required": false,
         "schema": {
-            "$ref": "#/components/schemas/EventsPagination"
-        }
-    },
-    "TransactionsPagination": {
-        "name": "pagination",
-        "summary": "pagination options",
-        "description": "Pagination in RPC is similar to pagination in Horizon. See [Pagination](https://developers.stellar.org/docs/data/rpc/api-reference/pagination).",
-        "required": false,
-        "schema": {
-            "$ref": "#/components/schemas/TransactionsPagination"
+            "$ref": "#/components/schemas/Pagination"
         }
     }
 }
diff --git a/openrpc/src/stellar-rpc/examples/Events.json b/openrpc/src/stellar-rpc/examples/Events.json
@@ -103,7 +103,8 @@
                     "txHash": "3f81b00a78830bb0186539cceed5ac137aad0d6872dd998c533c2758fbda0a6c"
                 }
             ],
-            "latestLedger": 1197964
+            "latestLedger": 1197964,
+            "cursor": "0005111084096696320-0000000001"
         }
     }
 }
diff --git a/openrpc/src/stellar-rpc/methods/getEvents.json b/openrpc/src/stellar-rpc/methods/getEvents.json
@@ -17,7 +17,7 @@
             "$ref": "#/components/contentDescriptors/EventFilters"
         },
         {
-            "$ref": "#/components/contentDescriptors/EventsPagination"
+            "$ref": "#/components/contentDescriptors/Pagination"
         },
         {
             "$ref": "#/components/contentDescriptors/Format"
@@ -39,7 +39,7 @@
                 },
                 "cursor": {
                     "type": "string",
-                    "$ref": "#/components/schemas/GetEventsCursor"
+                    "$ref": "#/components/schemas/Cursor"
                 }
             }
         }

diff --git a/openrpc/src/stellar-rpc/methods/getLedgers.json b/openrpc/src/stellar-rpc/methods/getLedgers.json
@@ -11,7 +11,7 @@
       "$ref": "#/components/contentDescriptors/StartLedger"
     },
     {
-      "$ref": "#/components/contentDescriptors/TransactionsPagination"
+      "$ref": "#/components/contentDescriptors/Pagination"
     }
   ],
   "result": {
@@ -36,8 +36,11 @@
         },
         "oldestLedgerCloseTime": {
           "$ref": "#/components/schemas/OldestLedgerCloseTime"
+        },
+        "cursor": {
+          "type": "string",
+          "$ref": "#/components/schemas/Cursor"
         }
-      }
     }
   },
   "examples": [

diff --git a/openrpc/src/stellar-rpc/methods/getTransactions.json b/openrpc/src/stellar-rpc/methods/getTransactions.json
@@ -11,7 +11,7 @@
       "$ref": "#/components/contentDescriptors/StartLedger"
     },
     {
-      "$ref": "#/components/contentDescriptors/TransactionsPagination"
+      "$ref": "#/components/contentDescriptors/Pagination"
     }
   ],
   "result": {
@@ -36,6 +36,10 @@
         },
         "oldestLedgerCloseTimestamp": {
           "$ref": "#/components/schemas/OldestLedgerCloseTime"
+        },
+        "cursor": {
+          "type": "string",
+          "$ref": "#/components/schemas/Cursor"
         }
       }
     }

diff --git a/openrpc/src/stellar-rpc/schemas/Cursor.json b/openrpc/src/stellar-rpc/schemas/Cursor.json
@@ -2,11 +2,6 @@
   "Cursor": {
     "title": "cursor",
     "type": "string",
-    "description": "A unique identifier (specifically, a [TOID](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0035.md#specification)) that points to a specific location in a collection of responses and is pulled from the `paging_token` value of a record. When a cursor is provided, RPC will _not_ include the element whose ID matches the cursor in the response: only elements which appear _after_ the cursor will be included."
-  },
-  "GetEventsCursor": {
-    "title": "cursor",
-    "type": "string",
-    "description": "The last populated event ID if total events reach the limit or end of the search window."
+    "description": "An opaque string which acts as a paging token. For endpoints which support pagination, the response will include a `cursor` field which can be included in a subsequent request to return the next page of results."
   }
 }
diff --git a/openrpc/src/stellar-rpc/schemas/Pagination.json b/openrpc/src/stellar-rpc/schemas/Pagination.json
@@ -1,5 +1,5 @@
 {
-    "EventsPagination": {
+    "Pagination": {
         "type": "object",
         "properties": {
             "cursor": {
@@ -12,17 +12,4 @@
         },
         "required": []
     },
-    "TransactionsPagination": {
-        "type": "object",
-        "properties": {
-            "cursor": {
-                "$ref": "#/components/schemas/Cursor"
-            },
-            "limit": {
-                "type": "number",
-                "description": "The maximum number of records returned by the endpoint."
-            }
-        },
-        "required": []
-    }
 }