RPC API: Remove/Add deprecations, update examples (#1703)

Author: Shaptic

openrpc/src/stellar-rpc/methods/getVersionInfo.json

@@ -15,7 +15,7 @@
         "version": {
           "type": "string",
           "description": "The version of the RPC server.",
-          "example": "21.1.0"
+          "example": "23.0.1"
         },
         "commitHash": {
           "type": "string",
@@ -25,21 +25,19 @@
         "buildTimestamp": {
           "type": "string",
           "description": "The build timestamp of the RPC server.",
-          "example": "2024-05-10T11:18:38"
+          "example": "2025-05-10T11:18:38"
         },
         "captiveCoreVersion": {
           "type": "string",
           "description": "The version of the Captive Core.",
-          "example": "stellar-core 21.0.0.rc2 (c6f474133738ae5f6d11b07963ca841909210273)"
+          "example": "stellar-core 23.0.1 (050eacf11a15afb2e95560dfb5723dfdcf78070f)"
         },
         "protocolVersion": {
           "type": "integer",
           "description": "The protocol version.",
-          "example": 21
+          "example": 23
         }
-
-      },
-      "required": ["version", "commit_hash", "build_time_stamp", "captive_core_version", "protocol_version"]
+      }
     }
   },
   "examples": [
@@ -50,11 +48,11 @@
       "result": {
         "name": "getVersionInfoResult",
         "value": {
-          "version": "21.1.0",
+          "version": "23.0.1",
           "commit_hash": "fcd2f0523f04279bae4502f3e3fa00ca627e6f6a",
-          "build_time_stamp": "2024-05-10T11:18:38",
-          "captive_core_version": "stellar-core 21.0.0.rc2 (c6f474133738ae5f6d11b07963ca841909210273)",
-          "protocol_version": 21
+          "build_time_stamp": "2025-05-10T11:18:38",
+          "captive_core_version": "stellar-core 23.0.1 (050eacf11a15afb2e95560dfb5723dfdcf78070f)",
+          "protocol_version": 23
         }
       }
     }

openrpc/src/stellar-rpc/schemas/Event.json

@@ -20,12 +20,9 @@
             "id": {
                 "$ref": "#/components/schemas/EventId"
             },
-            "pagingToken": {
-                "description": "Duplicate of `id` field. This field is deprecated, please use the `cursor` field at the top level of the getEvents response for pagination.",
-                "$ref": "#/components/schemas/EventId"
-            },
             "inSuccessfulContractCall": {
                 "description": "If true the event was emitted during a successful contract call.",
+                "deprecated": true,
                 "type": "boolean"
             },
             "topic": {

openrpc/src/stellar-rpc/schemas/TransactionEvents.json

@@ -21,7 +21,7 @@
   },
   "ContractEvent": {
     "type": "array",
-    "description": "Base64-encoded contract events emitted by a single operation within the transaction.",
+    "description": "Base64-encoded [xdr.ContractEvent]([xdr.ContractEvent](https://github.com/stellar/stellar-xdr/blob/v23.0/Stellar-ledger.x#L371-L390) emitted by a single operation within the transaction.",
     "items": {
       "type": "string"
     }

static/stellar-rpc.openrpc.json

@@ -188,12 +188,9 @@
                     "description": "Unique identifier for this event, based on the [TOID](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0035.md#specification) format. It combines a 19-character TOID and a 10-character, zero-padded event index, separated by a hyphen. \n\n- For example: `0000000000000123456-0000000001`",
                     "type": "string"
                   },
-                  "pagingToken": {
-                    "description": "Duplicate of `id` field. This field is deprecated, please use the `cursor` field at the top level of the getEvents response for pagination.",
-                    "type": "string"
-                  },
                   "inSuccessfulContractCall": {
                     "description": "If true the event was emitted during a successful contract call.",
+                    "deprecated": true,
                     "type": "boolean"
                   },
                   "topic": {
@@ -1203,7 +1200,7 @@
                   "description": "A nested array of base64-encoded [xdr.ContractEvent](https://github.com/stellar/stellar-xdr/blob/v23.0/Stellar-ledger.x#L371-L390). Each inner array represents the contract events emitted by a single operation within the transaction.",
                   "items": {
                     "type": "array",
-                    "description": "Base64-encoded contract events emitted by a single operation within the transaction.",
+                    "description": "Base64-encoded [xdr.ContractEvent]([xdr.ContractEvent](https://github.com/stellar/stellar-xdr/blob/v23.0/Stellar-ledger.x#L371-L390) emitted by a single operation within the transaction.",
                     "items": {
                       "type": "string"
                     }
@@ -1448,7 +1445,7 @@
                         "description": "A nested array of base64-encoded [xdr.ContractEvent](https://github.com/stellar/stellar-xdr/blob/v23.0/Stellar-ledger.x#L371-L390). Each inner array represents the contract events emitted by a single operation within the transaction.",
                         "items": {
                           "type": "array",
-                          "description": "Base64-encoded contract events emitted by a single operation within the transaction.",
+                          "description": "Base64-encoded [xdr.ContractEvent]([xdr.ContractEvent](https://github.com/stellar/stellar-xdr/blob/v23.0/Stellar-ledger.x#L371-L390) emitted by a single operation within the transaction.",
                           "items": {
                             "type": "string"
                           }
@@ -1916,18 +1913,11 @@
         "name": "getVersionInfoResult",
         "schema": {
           "type": "object",
-          "required": [
-            "version",
-            "commit_hash",
-            "build_time_stamp",
-            "captive_core_version",
-            "protocol_version"
-          ],
           "properties": {
             "version": {
               "type": "string",
               "description": "The version of the RPC server.",
-              "example": "21.1.0"
+              "example": "23.0.1"
             },
             "commitHash": {
               "type": "string",
@@ -1937,17 +1927,17 @@
             "buildTimestamp": {
               "type": "string",
               "description": "The build timestamp of the RPC server.",
-              "example": "2024-05-10T11:18:38"
+              "example": "2025-05-10T11:18:38"
             },
             "captiveCoreVersion": {
               "type": "string",
               "description": "The version of the Captive Core.",
-              "example": "stellar-core 21.0.0.rc2 (c6f474133738ae5f6d11b07963ca841909210273)"
+              "example": "stellar-core 23.0.1 (050eacf11a15afb2e95560dfb5723dfdcf78070f)"
             },
             "protocolVersion": {
               "type": "integer",
               "description": "The protocol version.",
-              "example": 21
+              "example": 23
             }
           }
         }
@@ -1960,11 +1950,11 @@
           "result": {
             "name": "getVersionInfoResult",
             "value": {
-              "version": "21.1.0",
+              "version": "23.0.1",
               "commit_hash": "fcd2f0523f04279bae4502f3e3fa00ca627e6f6a",
-              "build_time_stamp": "2024-05-10T11:18:38",
-              "captive_core_version": "stellar-core 21.0.0.rc2 (c6f474133738ae5f6d11b07963ca841909210273)",
-              "protocol_version": 21
+              "build_time_stamp": "2025-05-10T11:18:38",
+              "captive_core_version": "stellar-core 23.0.1 (050eacf11a15afb2e95560dfb5723dfdcf78070f)",
+              "protocol_version": 23
             }
           }
         }