Skip to content

Commit d868bdd

Browse files
committed
docs: Rename InitiateEventStream() to Subscribe()
1 parent 2194e99 commit d868bdd

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# [unreleased]
22

3+
## Breaking Changes
4+
5+
### UI Controller API
6+
7+
- Renamed `InitiateEventStream()` to `Subscribe()`
8+
39
# [0.1.0] - 2025-08-14
410

511
## Breaking Changes

doc/api.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,15 @@ sequenceDiagram
4646

4747
## [unreleased]
4848

49+
### Breaking Changes
50+
51+
- (UI Controller): Renamed `InitiateEventStream()` to `Subscribe()`
52+
4953
## [0.1.0] - 2025-08-14
5054

51-
### Added
55+
### Breaking Changes
56+
57+
### Improvements
5258

5359
- Initial release.
5460

@@ -376,9 +382,7 @@ See the WebAuthn spec for meanings of the [client capability keys][def-client-ca
376382

377383
The Flow Control API is used by the UI to pass user interactions through the Flow Controller to the authenticator.
378384

379-
## InitiateEventStream()
380-
381-
> TODO: Rename to Subscribe()?
385+
## Subscribe()
382386

383387
> TODO: Is a signal here safe? Do we need to have the client set up an
384388
> endpoint to send a unicast message instead? The QR code in hybrid flow contains
@@ -702,7 +706,7 @@ Initializes a FIDO hybrid authenticator flow.
702706

703707
### Request
704708

705-
The UI client should subscribe to the `StateChanged` and call `InitiateEventStream()` before calling this method.
709+
The UI client should subscribe to the `StateChanged` and call `Subscribe()` before calling this method.
706710

707711
### Response
708712

@@ -718,7 +722,7 @@ Initializes a FIDO USB authenticator flow.
718722

719723
### Request
720724

721-
The UI client should subscribe to the `StateChanged` and call `InitiateEventStream()` before calling this method.
725+
The UI client should subscribe to the `StateChanged` and call `Subscribe()` before calling this method.
722726

723727
### Response
724728

0 commit comments

Comments
 (0)