Skip to content

Editorial: add an example of a complete session - #99

Merged
jugglinmike merged 3 commits into
w3c:mainfrom
jugglinmike:full-session-example
Aug 26, 2026
Merged

jugglinmike merged 3 commits into
w3c:mainfrom
jugglinmike:full-session-example

Conversation

@jugglinmike

@jugglinmike jugglinmike commented Aug 21, 2026 •

Copy link
Copy Markdown
Contributor

Resolves gh-88


Preview | Diff

@jugglinmike

Copy link
Copy Markdown
Contributor Author

@v-tab-vispero @mcking65 Would either of you mind taking a look at this?

@v-tab-vispero v-tab-vispero left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.setSettings reference 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.

Comment thread index.bs Resolved
Comment thread index.bs Resolved
Comment thread index.bs Resolved
Comment thread index.bs Resolved
Comment thread index.bs Resolved
@jugglinmike

Copy link
Copy Markdown
Contributor Author

Thanks, @v-tab-vispero! I think your "nits" are really valuable improvements, so I've incorporated them all.

@v-tab-vispero

Copy link
Copy Markdown

Thanks Mike - looks good to me

@jugglinmike

Copy link
Copy Markdown
Contributor Author

Thanks, Valentin!

@jugglinmike
jugglinmike merged commit c7ba0c9 into w3c:main Aug 26, 2026
4 checks passed
@jugglinmike
jugglinmike deleted the full-session-example branch August 26, 2026 17:46
github-actions Bot added a commit that referenced this pull request Aug 26, 2026
SHA: c7ba0c9
Reason: push, by jugglinmike

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add an example of a short session

2 participants