From 212a964fd1ec3d87b35f2803a760299966ebf6d7 Mon Sep 17 00:00:00 2001 From: Eric Passmore Date: Fri, 3 Jan 2025 05:22:32 +0800 Subject: [PATCH] added notes on how to resume and an example use case --- plugins/producer_api_plugin/producer.swagger.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/plugins/producer_api_plugin/producer.swagger.yaml b/plugins/producer_api_plugin/producer.swagger.yaml index 2ffe7bea7c..a614f2acc9 100644 --- a/plugins/producer_api_plugin/producer.swagger.yaml +++ b/plugins/producer_api_plugin/producer.swagger.yaml @@ -47,7 +47,9 @@ paths: /producer/pause_at_block: post: summary: pause_at_block - description: Pause producer node at the specified block. + description: Pause node at the specified block. Use /producer/resume to un-pause. If specified block is less than head then returns an error. + ### Useage + Note that is pauses all nodes not just producer nodes. The common use case is to use on non-producer nodes as a way of freezing state. For example, a user might wish to download all the rolls of a table. This would allow the user to freeze at a block number and then iterate through an entire table. operationId: pause_at_block requestBody: content: