Skip to content

Refresh HTTP API docs and Postman collection#113

Merged
HDauven merged 1 commit intomainfrom
docs/http-api-refresh
Feb 16, 2026
Merged

Refresh HTTP API docs and Postman collection#113
HDauven merged 1 commit intomainfrom
docs/http-api-refresh

Conversation

@HDauven
Copy link
Copy Markdown
Member

@HDauven HDauven commented Feb 15, 2026

Why

Docs and the Postman collection were out of sync with the current rusk HTTP server behavior (RUES /on, WebSocket session, subscriptions, event framing).

What Changed

  • Rewrote the HTTP API page to match rusk:
    • WebSocket session id flow (wss://<node>/on)
    • Subscribe/unsubscribe via HTTP GET/DELETE to /on/... with Rusk-Session-Id
    • Event framing: u32 LE header_len + JSON header + data (Content-Location)
  • Clarified binary vs text responses (Accept: application/octet-stream) and hex (0x...) decoding behavior.
  • Updated the Postman collection (variables, grouping, corrected requests).

Files

  • src/content/docs/developer/integrations/http-api.md
  • public/dusk_api_postman_collection.json

Test

  • npm run build

@HDauven HDauven requested a review from Neotamandua February 15, 2026 12:17
@HDauven HDauven changed the title docs: refresh HTTP API docs and Postman collection Refresh HTTP API docs and Postman collection Feb 15, 2026
@HDauven HDauven merged commit 8ed8c46 into main Feb 16, 2026
1 check passed
@HDauven HDauven deleted the docs/http-api-refresh branch February 16, 2026 15:26
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