Skip to content

Rewrite public docs for the 0.6.0 API #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
UTXOnly merged 1 commit into from
Sep 12, 2026
Merged

Rewrite public docs for the 0.6.0 API #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .cursor/rules/oddrip-require-tests.mdc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ When you add or change **any** of the following, you **must** add or update test

| Change | Test file | Assert |
|--------|-----------|--------|
| New/changed REST method | `oddrip/*_test.go` | HTTP path, method, query params, request body when non-trivial |
| New/changed response/request struct | `oddrip/types/*_test.go` | JSON unmarshal (and marshal if you construct requests) |
| New WS channel or `update_subscription` action | `oddrip/types/ws_test.go` or `oddrip/ws_test.go` | Constant value and/or JSON round-trip |
| New/changed REST method | `oddrip/*_test.go` (Series / OrderGroups / Subaccounts and extra Events / Markets / Portfolio methods: `oddrip/services_extra_test.go`) | HTTP path, method, query params, request body when non-trivial |
| New/changed response/request struct | `oddrip/types/*_test.go` | JSON unmarshal (and marshal if you construct requests). Use the spec example payload, not a fabricated shape. |
| New WS channel or `update_subscription` action | `oddrip/types/ws_test.go` or `oddrip/ws_test.go` | Constant value and/or JSON round-trip. Command calls that wait on a reply (`Subscribe`, `get_snapshot`) need a test that the call returns. |

Use the existing `mockTransport` pattern in `oddrip/client_test.go`.

Expand Down
5 changes: 5 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,8 @@
/example
*.pem
cmd/example/key_id

# Local working notes — not for the public repo
*-pre-release-review.md
*PLAN.md
PLAN.md
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ All notable changes to this project are documented here. The client tracks [Kals

## [0.6.0] — 2026-09-12

Audit release. Every item under **Fixed** was reproduced with a failing test before the fix; the shipped test suite now exercises retry exhaustion, context cancellation during backoff, multi-channel subscribes, concurrent WebSocket writes, slow consumers, and dead connections.
Fixes retry panics and WebSocket hangs, adds Series / OrderGroups / Subaccounts REST, and aligns typed WS payloads with AsyncAPI 2.0.0.

### Breaking

Expand Down
Loading