From ff1205bb3aa6b8d0008f3ce51c288058c3495f3b Mon Sep 17 00:00:00 2001 From: Eval EXEC Date: Mon, 30 Oct 2023 22:16:58 +0800 Subject: [PATCH 1/3] Add last page doc on get_cells and get_transactions RPC Signed-off-by: Eval EXEC --- rpc/src/module/indexer.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/rpc/src/module/indexer.rs b/rpc/src/module/indexer.rs index 9a492a8228..7d5429bed8 100644 --- a/rpc/src/module/indexer.rs +++ b/rpc/src/module/indexer.rs @@ -63,6 +63,7 @@ pub trait IndexerRpc { /// /// ## Returns /// + /// > If the number of objects is less than the requested `limit`, it indicates that these are the last page of get_cells. /// * objects: /// - output: the fields of an output cell /// - output_data: the cell data @@ -409,6 +410,7 @@ pub trait IndexerRpc { /// * after: pagination parameter, optional /// /// ## Returns + /// > If the number of objects is less than the requested `limit`, it indicates that these are the last page of get_transactions. /// * objects - enum, ungrouped TxWithCell | grouped TxWithCells /// - TxWithCell: /// - tx_hash: transaction hash, From ee09a369b37171c12c873b3328096b24349d27fe Mon Sep 17 00:00:00 2001 From: Eval EXEC Date: Mon, 30 Oct 2023 22:21:11 +0800 Subject: [PATCH 2/3] Execute `make gen-rpc-doc` --- rpc/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/rpc/README.md b/rpc/README.md index fe16348215..e50b65674f 100644 --- a/rpc/README.md +++ b/rpc/README.md @@ -2183,6 +2183,8 @@ Returns the live cells collection by the lock or type script. ###### Returns +If the number of objects is less than the requested `limit`, it indicates that these are the last page of get_cells. + * objects: * output: the fields of an output cell @@ -2560,6 +2562,8 @@ Returns the transactions collection by the lock or type script. ###### Returns +If the number of objects is less than the requested `limit`, it indicates that these are the last page of get_transactions. + * objects - enum, ungrouped TxWithCell | grouped TxWithCells * TxWithCell: * tx_hash: transaction hash, From 185a4067cf36f8d13d62646696b19d48de8402bc Mon Sep 17 00:00:00 2001 From: Eval EXEC Date: Tue, 31 Oct 2023 10:16:42 +0800 Subject: [PATCH 3/3] doc: Remove meaningless `>` Co-authored-by: ian Signed-off-by: Eval EXEC --- rpc/src/module/indexer.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/rpc/src/module/indexer.rs b/rpc/src/module/indexer.rs index 7d5429bed8..ea7578b9e3 100644 --- a/rpc/src/module/indexer.rs +++ b/rpc/src/module/indexer.rs @@ -63,7 +63,8 @@ pub trait IndexerRpc { /// /// ## Returns /// - /// > If the number of objects is less than the requested `limit`, it indicates that these are the last page of get_cells. + /// If the number of objects is less than the requested `limit`, it indicates that these are the last page of get_cells. + /// /// * objects: /// - output: the fields of an output cell /// - output_data: the cell data @@ -410,7 +411,9 @@ pub trait IndexerRpc { /// * after: pagination parameter, optional /// /// ## Returns - /// > If the number of objects is less than the requested `limit`, it indicates that these are the last page of get_transactions. + /// + /// If the number of objects is less than the requested `limit`, it indicates that these are the last page of get_transactions. + /// /// * objects - enum, ungrouped TxWithCell | grouped TxWithCells /// - TxWithCell: /// - tx_hash: transaction hash,