Skip to content

Document pool status on websocket subscriptions - #1210

Open
stefangutica wants to merge 4 commits into
developmentfrom
ws-pool-too-large-status
Open

stefangutica wants to merge 4 commits into
developmentfrom
ws-pool-too-large-status

Conversation

@stefangutica

@stefangutica stefangutica commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

Description of the pull request (what is new / what has changed)

Documents the pool status on websocket subscriptions, in the Pool (Pulse) section of ws-subscriptions.md:

  • poolUpdate now carries a status: success, tooLarge or internalServerError. Added to the existing update example, which also gets its poolCount indentation fixed.
  • New table with the poolUpdate fields:
    • status;
    • pool, null unless the status is success;
    • poolCount, the total count of the pool, regardless of type, when the status is not success, or null when it could not be counted either.
  • New "Pool too large" and "Pool unavailable" examples: in both cases the update carries no transactions, only the total count, and clients should show a message instead of the list.

This documents the behaviour added in mx-api-service by the pool-count-from-gateway PR, so it should be merged together with or after that PR.

Did you test the changes locally ?

  • yes
  • no

Did you regenerate static/llms.txt and static/llms-full.txt ? (happens at build time)

  • yes
  • no

Which category (categories) does this pull request belong to?

  • document new feature
  • update documentation that is not relevant anymore
  • add examples or more information about a component
  • fix grammar issues
  • other

@stefangutica
stefangutica marked this pull request as draft September 29, 2026 12:01
@stefangutica
stefangutica marked this pull request as ready for review September 30, 2026 09:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants