Skip to content

Commit 7f0d427

Browse files
authored
chore: update docs to include websockets info (#1076)
chore: update docs to include websockets info (#1076)
1 parent 1454aa2 commit 7f0d427

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

docs/openapi.yaml

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ paths:
237237
description: |
238238
Retrieves all transactions that have been recently broadcast to the mempool. These are pending transactions awaiting confirmation.
239239
240-
If you need to monitor new transactions, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
240+
If you need to monitor new transactions, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
241241
parameters:
242242
- name: sender_address
243243
in: query
@@ -490,7 +490,10 @@ paths:
490490
tags:
491491
- Microblocks
492492
operationId: get_microblock_list
493-
description: Retrieves a list of microblocks.
493+
description: |
494+
Retrieves a list of microblocks.
495+
496+
If you need to actively monitor new microblocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
494497
parameters:
495498
- name: limit
496499
in: query
@@ -560,7 +563,10 @@ paths:
560563
/extended/v1/block:
561564
get:
562565
summary: Get recent blocks
563-
description: Retrieves a list of recently mined blocks
566+
description: |
567+
Retrieves a list of recently mined blocks
568+
569+
If you need to actively monitor new blocks, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
564570
tags:
565571
- Blocks
566572
operationId: get_block_list
@@ -1250,7 +1256,10 @@ paths:
12501256
/extended/v1/address/{principal}/transactions:
12511257
get:
12521258
summary: Get account transactions
1253-
description: Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
1259+
description: |
1260+
Retrieves a list of all Transactions for a given Address or Contract Identifier. More information on Transaction types can be found [here](https://docs.stacks.co/understand-stacks/transactions#types).
1261+
1262+
If you need to actively monitor new transactions for an address or contract id, we highly recommend subscribing to [WebSockets or Socket.io](https://github.com/hirosystems/stacks-blockchain-api/tree/master/client) for real-time updates.
12541263
tags:
12551264
- Accounts
12561265
operationId: get_account_transactions

0 commit comments

Comments
 (0)