Skip to content

Commit b08ee4c

Browse files
committed
docs: Document errors returned to gateway requests
1 parent c11c3b6 commit b08ee4c

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

doc/api.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ sequenceDiagram
5151
- (UI Controller): Renamed `InitiateEventStream()` to `Subscribe()`
5252
- (UI Controller): Serialize enums (including BackgroundEvent, HybridState and UsbState) as (yv) structs instead for a{sv} dicts
5353

54+
### Improvements
55+
56+
- Document errors returned to gateway requests
57+
5458
## [0.1.0] - 2025-08-14
5559

5660
### Breaking Changes
@@ -269,7 +273,10 @@ denoted by `type: "publicKey"`:
269273

270274
### Errors
271275

272-
TBD.
276+
- `AbortError`: Request cancelled by client.
277+
- `SecurityError`: Security policies are not met, for example, requesting an RP credential whose origin does not match.
278+
- `TypeError`: An invalid request is made.
279+
- `NotAllowedError`: catch-all error.
273280

274281
## `GetCredential(credRequest: GetCredentialRequest) -> GetCredentialResponse`
275282

@@ -362,7 +369,10 @@ denoted by `type: "publicKey"`:
362369

363370
### Errors
364371

365-
TBD.
372+
- `AbortError`: Request cancelled by client.
373+
- `SecurityError`: Security policies are not met, for example, requesting an RP credential whose origin does not match.
374+
- `TypeError`: An invalid request is made.
375+
- `NotAllowedError`: catch-all error.
366376

367377
## `GetClientCapabilities() -> GetClientCapabilitiesResponse`
368378

0 commit comments

Comments
 (0)