Skip to content

Commit

Permalink
added notes on how to resume and an example use case
Browse files Browse the repository at this point in the history
  • Loading branch information
ericpassmore committed Jan 2, 2025
1 parent ee99136 commit 212a964
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion plugins/producer_api_plugin/producer.swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 212a964

Please sign in to comment.