Skip to content

Fix deserialization of Websocket received Notifications #598

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.

Sign up for GitHub

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

Open
C0D3-M4513R wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix deserialization of Websocket received Notifications #598

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2121348
Fix deserialization of Websocket received Notifications
C0D3-M4513R Sep 14, 2026
6526682
Make linter happy?
C0D3-M4513R Sep 14, 2026
141b895
Gate default and example behind the `x-if`
C0D3-M4513R Sep 14, 2026
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
18 changes: 15 additions & 3 deletions openapi/components/schemas/Notification.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,33 @@
title: Notification
type: object
description: ""

Check warning on line 3 in openapi/components/schemas/Notification.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description 

Cannot be empty.
properties:
created_at:
type: string
format: date-time
details:
type: string
description: "**NOTICE:** This is not a JSON object when received from the REST API, but it is when received from the Websocket API. When received from the REST API, this is a json **encoded** object, meaning you have to json-de-encode to get the NotificationDetail object depending on the NotificationType."
default: "{}"
example: "OneOf: {}, NotificationDetailBoop, NotificationDetailInvite, NotificationDetailInviteResponse, NotificationDetailRequestInvite, NotificationDetailRequestInviteResponse, NotificationDetailVoteToKick"
x-if:
when: jsonschema
then:
oneOf:
- type: string
- $ref: ./NotificationDetailBoop.yaml
Comment on lines +13 to +15

@C0D3-M4513R C0D3-M4513R Sep 14, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ideally we would somehow have the detail be either a string or the deserialization of the concrete type be determined by the type field of the Notification?

- $ref: ./NotificationDetailInvite.yaml
- $ref: ./NotificationDetailInviteResponse.yaml
- $ref: ./NotificationDetailRequestInvite.yaml
- $ref: ./NotificationDetailRequestInviteResponse.yaml
- $ref: ./NotificationDetailVoteToKick.yaml
else:
type: string
default: "{}"
example: "OneOf: {}, NotificationDetailBoop, NotificationDetailInvite, NotificationDetailInviteResponse, NotificationDetailRequestInvite, NotificationDetailRequestInviteResponse, NotificationDetailVoteToKick"
id:
type: string
minLength: 1
message:
type: string
description: ""

Check warning on line 30 in openapi/components/schemas/Notification.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description 

Cannot be empty.
example: This is a generated invite to VRChat Hub
receiverUserId:
$ref: ./UserID.yaml
Expand Down
Loading