Repository navigation
Update Websocket types from docs - #615
Open
C0D3-M4513R wants to merge 7 commits into
Open
C0D3-M4513R wants to merge 7 commits into
C0D3-M4513R wants to merge 7 commits into
Conversation
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
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
One or more issues must be addressed before approval.
7 open findings
Define ids items as a schema object · New Reference specialized schema for websocket user updates · New Require instanceLocation instead of location · New Require instanceLocation instead of location · New Exclude new message types from fallback schema · New Add captured evidence for dirtyPurchases schema · New Remove YAML TODO comment · New
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.
commit: |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



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
Everything apart from the
WebsocketNotificationV2Deleteand the types forinstance-closedcomes exclusively from docspnpm lintpasses - Command errors out:pnpm test -w session -w <workflow>passesIrrelevant for Websocket only types?