Repository navigation
Editorial: add an example of a complete session - #99
Conversation
|
@v-tab-vispero @mcking65 Would either of you mind taking a look at this? |
v-tab-vispero
left a comment
There was a problem hiding this comment.
Thanks for putting this together -- an end-to-end walkthrough is exactly what gh-88 was asking for, and having all five message types in one place should help implementers. The message shapes all check out against the CDDL productions (SessionNewCommand/SessionNewResult, SettingsGetSupportedSettingsCommand/SettingsGetSettingsResult, SettingsSetSettingsCommand/EmptyResult, InteractionUserIntentCommand/EmptyResult, and InteractionCapturedOutputEvent), and readEntirePage is consistent with the setting name already used in the settings module examples.
I parsed all nine JSON blocks in the appendix: eight are valid, one is not. That plus two typos and one substantive issue with the key value are inline below.
A few optional nits that did not seem worth inline comments:
- The
settings.setSettingsreference uses[=settings.setSettings=] [=Command=], where the other three use the[=x|x command=]pipe form. - The appendix opens at
session.new, whereas the explainer example mentions establishing the WebSocket connection first. One sentence would make "a complete session" literally true. - There is no session-teardown command in the spec, so the session just trails off at the end. Worth a note only if "short session" in gh-88 was meant to include an end.
|
Thanks, @v-tab-vispero! I think your "nits" are really valuable improvements, so I've incorporated them all. |
|
Thanks Mike - looks good to me |
|
Thanks, Valentin! |
SHA: c7ba0c9 Reason: push, by jugglinmike Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Resolves gh-88
Preview | Diff