Skip to content
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.

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

add "commit" to endpoint reconfiguration #463

Merged
merged 6 commits into from
Sep 28, 2022
Merged
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions docs/specs/sequences/endpoint_reconfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,21 @@ sequenceDiagram

```

### Commit Reconfiguration (Successful reconfiguration, persists restart)

```mermaid
%%{wrap}%%
sequenceDiagram
autonumber
participant D as Device
participant E as Original Endpoint
participant E' as New Endpoint
D->>E':STATE MESSAGE<br/>blobset.blobs._iot_endpoint_config.phase = "final"
note over D,E': Restart sequence from New Endpoint
D->>E':STATE MESSAGE<br/>blobset.blobs._iot_endpoint_config.phase = "final"
note right of E': New endpoint connection is remembered by the device after a system restart
```

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a simple note after that just says "This just means the new endpoint connection is remembered after a system restart" I dunno -- it's one of those "it's so simple I'm not sure people will see it!" situations...

## Message Examples

Config message to initiate Reconfiguration (sequence #1 in diagrams above)
Expand Down