Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions openrpc/src/stellar-rpc/contentDescriptors/Pagination.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,29 @@
{
"Pagination": {
"PaginationEvents": {
"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/structure/pagination).",
"required": false,
"schema": {
"$ref": "#/components/schemas/Pagination"
"$ref": "#/components/schemas/PaginationEvents"
}
},
"PaginationLedgers": {
"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/structure/pagination).",
"required": false,
"schema": {
"$ref": "#/components/schemas/PaginationLedgers"
}
},
"PaginationTransactions": {
"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/structure/pagination).",
"required": false,
"schema": {
"$ref": "#/components/schemas/PaginationTransactions"
}
}
}
2 changes: 1 addition & 1 deletion openrpc/src/stellar-rpc/methods/getEvents.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"$ref": "#/components/contentDescriptors/EventFilters"
},
{
"$ref": "#/components/contentDescriptors/Pagination"
"$ref": "#/components/contentDescriptors/PaginationEvents"
},
{
"$ref": "#/components/contentDescriptors/Format"
Expand Down
2 changes: 1 addition & 1 deletion openrpc/src/stellar-rpc/methods/getLedgers.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"$ref": "#/components/contentDescriptors/StartLedger"
},
{
"$ref": "#/components/contentDescriptors/Pagination"
"$ref": "#/components/contentDescriptors/PaginationLedgers"
},
{
"$ref": "#/components/contentDescriptors/Format"
Expand Down
2 changes: 1 addition & 1 deletion openrpc/src/stellar-rpc/methods/getTransactions.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"$ref": "#/components/contentDescriptors/StartLedger"
},
{
"$ref": "#/components/contentDescriptors/Pagination"
"$ref": "#/components/contentDescriptors/PaginationTransactions"
},
{
"$ref": "#/components/contentDescriptors/Format"
Expand Down
30 changes: 29 additions & 1 deletion openrpc/src/stellar-rpc/schemas/Pagination.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"Pagination": {
"PaginationEvents": {
"type": "object",
"properties": {
"cursor": {
Expand All @@ -12,5 +12,33 @@
}
},
"required": []
},
"PaginationLedgers": {
"type": "object",
"properties": {
"cursor": {
"type": "string",
"description": "An opaque string which acts as a paging token. To obtain the next page of results occurring after a given response set this value to the `cursor` field of the response."
},
"limit": {
"type": "number",
"description": "The maximum number of records returned. The limit for getLedgers can range from 1 to 200 - an upper limit that is hardcoded in Stellar-RPC for performance reasons. If this argument isn't designated, it defaults to 50."
}
},
"required": []
},
"PaginationTransactions": {
"type": "object",
"properties": {
"cursor": {
"type": "string",
"description": "An opaque string which acts as a paging token. To obtain the next page of results occurring after a given response set this value to the `cursor` field of the response."
},
"limit": {
"type": "number",
"description": "The maximum number of records returned. The limit for getTransactions can range from 1 to 200 - an upper limit that is hardcoded in Stellar-RPC for performance reasons. If this argument isn't designated, it defaults to 50."
}
},
"required": []
}
}
4 changes: 2 additions & 2 deletions static/stellar-rpc.openrpc.json
Original file line number Diff line number Diff line change
Expand Up @@ -902,7 +902,7 @@
},
"limit": {
"type": "number",
"description": "The maximum number of records returned. The limit for getEvents can range from 1 to 10000 - an upper limit that is hardcoded in Stellar-RPC for performance reasons. If this argument isn't designated, it defaults to 100."
"description": "The maximum number of records returned. The limit for getLedgers can range from 1 to 200 - an upper limit that is hardcoded in Stellar-RPC for performance reasons. If this argument isn't designated, it defaults to 50."
}
}
}
Expand Down Expand Up @@ -1391,7 +1391,7 @@
},
"limit": {
"type": "number",
"description": "The maximum number of records returned. The limit for getEvents can range from 1 to 10000 - an upper limit that is hardcoded in Stellar-RPC for performance reasons. If this argument isn't designated, it defaults to 100."
"description": "The maximum number of records returned. The limit for getTransactions can range from 1 to 200 - an upper limit that is hardcoded in Stellar-RPC for performance reasons. If this argument isn't designated, it defaults to 50."
}
}
}
Expand Down
Loading