Skip to content

Update Websocket types from docs - #615

Open
C0D3-M4513R wants to merge 7 commits into
mainfrom
feature/update-ws-from-docs
Open

C0D3-M4513R wants to merge 7 commits into
mainfrom
feature/update-ws-from-docs

Conversation

@C0D3-M4513R

@C0D3-M4513R C0D3-M4513R commented Oct 12, 2026 •

Copy link
Copy Markdown
Member

Update the Websocket types from the docs at https://vrchat.community/websocket again.

The code I based the Websocket Types off-of was manually written a while ago, so the docs got some addition in that time

example instance-closed data

{"type":"instance-closed","content":"{\"instanceLocation\":\"wrld_d3c63056-8295-432a-bb9d-a0f6319444b6:24028~group(grp_000616f6-d362-4162-8918-ea65bdc92c1a)~groupAccessType(public)~region(eu)\"}"}

example notification-v2-delete data

{"type":"notification-v2-delete","content":"{\"ids\":[\"not_f1becc4c-9130-4dae-9d2f-6c1d7291d497\"],\"version\":2}"}

Evidence

  • Every property, type and example comes from a captured response

Everything apart from the WebsocketNotificationV2Delete and the types for instance-closed comes exclusively from docs

  • pnpm lint passes - Command errors out:
$ pnpm --no-bail --stream --reporter-hide-prefix --color run '/^lint-(?!ci$)(?!.*-ci$).*/'
[ERR_PNPM_NO_SCRIPT] Missing script: '/lint-(?!ci$)(?!.*-ci$).*/'

Command "'/lint-(?!ci$)(?!.*-ci$).*/'" not found.
[ELIFECYCLE] Command failed with exit code 1.
  • pnpm test -w session -w <workflow> passes

Irrelevant for Websocket only types?

Update the Websocket types from the docs at https://vrchat.community/websocket again.

The code I based the Websocket Types off-of was manually written a while ago, so the docs got some addition in that time
Copilot AI lite review requested due to automatic review settings October 12, 2026 11:58

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

One or more issues must be addressed before approval.

7 open findings
What changed in this PR

Updates WebSocket schemas with newly documented message types and payload fields.

Changes:

  • Adds economy, modified-image, error, untyped, and user-update schemas.
  • Updates discriminator mappings and schema registry.
  • Renames queue location fields and changes notification deletion IDs.
File Description
openapi/​components/​schemas/​WebsocketUserUpdateUser.yaml Updated as part of this pull request.
openapi/​components/​schemas/​WebsocketNotificationV2Delete.yaml Updated as part of this pull request.
openapi/​components/​schemas/​WebsocketModifiedImageUpdateEncoded.yaml Updated as part of this pull request.
openapi/​components/​schemas/​WebsocketModifiedImageUpdate.yaml Updated as part of this pull request.
openapi/​components/​schemas/​WebsocketMessageUntyped.yaml Updated as part of this pull request.
openapi/​components/​schemas/​WebsocketMessageError.yaml Updated as part of this pull request.
openapi/​components/​schemas/​WebsocketMessage.yaml Updated as part of this pull request.
openapi/​components/​schemas/​WebsocketInstanceQueueReady.yaml Updated as part of this pull request.
openapi/​components/​schemas/​WebsocketInstanceQueueJoined.yaml Updated as part of this pull request.
openapi/​components/​schemas/​WebsocketGroupMemberUpdated.yaml Updated as part of this pull request.
openapi/​components/​schemas/​WebsocketFriendOnline.yaml Updated as part of this pull request.
openapi/​components/​schemas/​WebsocketEconomyUpdateEncoded.yaml Updated as part of this pull request.
openapi/​components/​schemas/​WebsocketEconomyUpdate.yaml Updated as part of this pull request.
openapi/​components/​schemas/​_index.yaml Updated as part of this pull request.

🧠 Review effort: Lite


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread openapi/components/schemas/WebsocketNotificationV2Delete.yaml Outdated
Comment thread openapi/components/schemas/WebsocketUserUpdateUser.yaml
Comment thread openapi/components/schemas/WebsocketInstanceQueueJoined.yaml Outdated
Comment thread openapi/components/schemas/WebsocketInstanceQueueReady.yaml Outdated
Comment thread openapi/components/schemas/WebsocketMessage.yaml
Comment thread openapi/components/schemas/WebsocketEconomyUpdate.yaml
Comment thread openapi/components/schemas/WebsocketGroupMemberUpdated.yaml
@pkg-pr-new

pkg-pr-new Bot commented Oct 12, 2026 •

Copy link
Copy Markdown
pnpm add https://pkg.pr.new/vrchatapi/specification/vrchat@41ca0fa

commit: 41ca0fa

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants