Websocket types

openapi/components/schemas/Notification.yaml

@@ -1,43 +1,24 @@
 title: Notification
-type: object
-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: "{}"
-    examples:
-      - "OneOf: {}, NotificationDetailBoop, NotificationDetailInvite, NotificationDetailInviteResponse, NotificationDetailRequestInvite, NotificationDetailRequestInviteResponse, NotificationDetailVoteToKick"
-  id:
-    type: string
-    minLength: 1
-  message:
-    type: string
-    examples:
-      - This is a generated invite to VRChat Hub
-  receiverUserId:
-    $ref: ./UserID.yaml
-    description: Not included in notification objects received from the REST API
-  seen:
-    type: boolean
-    description: Not included in notification objects received from the Websocket API
-    default: false
-  senderUserId:
-    $ref: ./UserID.yaml
-  senderUsername:
-    type:
-      - string
-      - "null"
-    description: The name of the user who sent the notification.
-    minLength: 1
-  type:
-    $ref: ./NotificationType.yaml
-required:
-  - created_at
-  - details
-  - id
-  - message
-  - senderUserId
-  - type
+description: A notification. The shape of `details` depends on `type`.
+discriminator:
+  defaultMapping: ./NotificationUnknown.yaml
+  mapping:
+    boop: ./NotificationBoop.yaml
+    friendRequest: ./NotificationFriendRequest.yaml
+    invite: ./NotificationInvite.yaml
+    inviteResponse: ./NotificationInviteResponse.yaml
+    message: ./NotificationMessage.yaml
+    requestInvite: ./NotificationRequestInvite.yaml
+    requestInviteResponse: ./NotificationRequestInviteResponse.yaml
+    votetokick: ./NotificationVoteToKick.yaml
+  propertyName: type
+oneOf:
+  - $ref: ./NotificationBoop.yaml
+  - $ref: ./NotificationFriendRequest.yaml
+  - $ref: ./NotificationInvite.yaml
+  - $ref: ./NotificationInviteResponse.yaml
+  - $ref: ./NotificationMessage.yaml
+  - $ref: ./NotificationRequestInvite.yaml
+  - $ref: ./NotificationRequestInviteResponse.yaml
+  - $ref: ./NotificationVoteToKick.yaml
+  - $ref: ./NotificationUnknown.yaml

openapi/components/schemas/NotificationBase.yaml

@@ -0,0 +1,33 @@
+title: NotificationBase
+type: object
+properties:
+  created_at:
+    type: string
+    format: date-time
+  id:
+    type: string
+    minLength: 1
+  message:
+    type: string
+    examples:
+      - This is a generated invite to VRChat Hub
+  receiverUserId:
+    $ref: ./UserID.yaml
+    description: Not included in notification objects received from the REST API
+  seen:
+    type: boolean
+    description: Not included in notification objects received from the Websocket API
+    default: false
+  senderUserId:
+    $ref: ./UserID.yaml
+  senderUsername:
+    type:
+      - string
+      - "null"
+    description: The name of the user who sent the notification.
+    minLength: 1
+required:
+  - created_at
+  - id
+  - message
+  - senderUserId

openapi/components/schemas/NotificationBoop.yaml

@@ -0,0 +1,18 @@
+title: NotificationBoop
+type: object
+properties:
+  details:
+    type: string
+    description: A JSON-encoded string.
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailBoop.yaml
+    x-vrchat-double-encoding-type: NotificationDetailBoop
+  type:
+    type: string
+    const: boop
+required:
+  - details
+  - type
+allOf:
+  - $ref: ./NotificationBase.yaml

openapi/components/schemas/NotificationDetailFriendRequest.yaml

@@ -0,0 +1,2 @@
+title: NotificationDetailFriendRequest
+type: object

openapi/components/schemas/NotificationDetailMessage.yaml

@@ -0,0 +1,2 @@
+title: NotificationDetailMessage
+type: object

openapi/components/schemas/NotificationFriendRequest.yaml

@@ -0,0 +1,17 @@
+title: NotificationFriendRequest
+type: object
+properties:
+  details:
+    type: string
+    description: A JSON-encoded string.
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailFriendRequest.yaml
+  type:
+    type: string
+    const: friendRequest
+required:
+  - details
+  - type
+allOf:
+  - $ref: ./NotificationBase.yaml

openapi/components/schemas/NotificationInvite.yaml

@@ -0,0 +1,18 @@
+title: NotificationInvite
+type: object
+properties:
+  details:
+    type: string
+    description: A JSON-encoded string.
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailInvite.yaml
+    x-vrchat-double-encoding-type: NotificationDetailInvite
+  type:
+    type: string
+    const: invite
+required:
+  - details
+  - type
+allOf:
+  - $ref: ./NotificationBase.yaml

openapi/components/schemas/NotificationInviteResponse.yaml

@@ -0,0 +1,18 @@
+title: NotificationInviteResponse
+type: object
+properties:
+  details:
+    type: string
+    description: A JSON-encoded string.
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailInviteResponse.yaml
+    x-vrchat-double-encoding-type: NotificationDetailInviteResponse
+  type:
+    type: string
+    const: inviteResponse
+required:
+  - details
+  - type
+allOf:
+  - $ref: ./NotificationBase.yaml

openapi/components/schemas/NotificationMessage.yaml

@@ -0,0 +1,17 @@
+title: NotificationMessage
+type: object
+properties:
+  details:
+    type: string
+    description: A JSON-encoded string.
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailMessage.yaml
+  type:
+    type: string
+    const: message
+required:
+  - details
+  - type
+allOf:
+  - $ref: ./NotificationBase.yaml

openapi/components/schemas/NotificationRequestInvite.yaml

@@ -0,0 +1,18 @@
+title: NotificationRequestInvite
+type: object
+properties:
+  details:
+    type: string
+    description: A JSON-encoded string.
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailRequestInvite.yaml
+    x-vrchat-double-encoding-type: NotificationDetailRequestInvite
+  type:
+    type: string
+    const: requestInvite
+required:
+  - details
+  - type
+allOf:
+  - $ref: ./NotificationBase.yaml

openapi/components/schemas/NotificationRequestInviteResponse.yaml

@@ -0,0 +1,18 @@
+title: NotificationRequestInviteResponse
+type: object
+properties:
+  details:
+    type: string
+    description: A JSON-encoded string.
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailRequestInviteResponse.yaml
+    x-vrchat-double-encoding-type: NotificationDetailRequestInviteResponse
+  type:
+    type: string
+    const: requestInviteResponse
+required:
+  - details
+  - type
+allOf:
+  - $ref: ./NotificationBase.yaml

openapi/components/schemas/NotificationUnknown.yaml

@@ -0,0 +1,24 @@
+title: NotificationUnknown
+type: object
+description: A notification whose `type` has no schema of its own.
+properties:
+  details:
+    type: string
+    description: A JSON-encoded string.
+  type:
+    type: string
+    not:
+      enum:
+        - boop
+        - friendRequest
+        - invite
+        - inviteResponse
+        - message
+        - requestInvite
+        - requestInviteResponse
+        - votetokick
+required:
+  - details
+  - type
+allOf:
+  - $ref: ./NotificationBase.yaml

openapi/components/schemas/NotificationVoteToKick.yaml

@@ -0,0 +1,18 @@
+title: NotificationVoteToKick
+type: object
+properties:
+  details:
+    type: string
+    description: A JSON-encoded string.
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailVoteToKick.yaml
+    x-vrchat-double-encoding-type: NotificationDetailVoteToKick
+  type:
+    type: string
+    const: votetokick
+required:
+  - details
+  - type
+allOf:
+  - $ref: ./NotificationBase.yaml

openapi/components/schemas/WebsocketClearNotification.yaml

@@ -0,0 +1,8 @@
+title: WebsocketClearNotification
+type: object
+properties:
+  type:
+    type: string
+    const: clear-notification
+required:
+  - type

openapi/components/schemas/WebsocketContentRefresh.yaml

@@ -0,0 +1,21 @@
+title: WebsocketContentRefresh
+type: object
+properties:
+  actionType:
+    $ref: ./WebsocketContentRefreshActionType.yaml
+  contentType:
+    $ref: ./WebsocketContentRefreshContentType.yaml
+  fileId:
+    $ref: ./FileID.yaml
+  itemId:
+    # TODO: is this correct?
+    $ref: ./InventoryTemplateID.yaml
+  itemType:
+    # TODO: is this correct?
+    $ref: ./InventoryItemType.yaml
+required:
+  - actionType
+  - contentType
+  - fileId
+  - itemId
+  - itemType

openapi/components/schemas/WebsocketContentRefreshActionType.yaml

@@ -0,0 +1,9 @@
+title: WebsocketContentRefreshActionType
+type: string
+enum:
+  - add
+  - created
+  - delete
+  - deleted
+examples:
+  - created

openapi/components/schemas/WebsocketContentRefreshContentType.yaml

@@ -0,0 +1,3 @@
+title: WebsocketContentRefreshContentType
+type: string
+# Todo: How to type this, since this is technically a non-exhaustive enum?

openapi/components/schemas/WebsocketContentRefreshEncoded.yaml

@@ -0,0 +1,15 @@
+title: WebsocketContentRefreshEncoded
+type: object
+properties:
+  content:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./WebsocketContentRefresh.yaml
+    x-vrchat-double-encoding-type: WebsocketContentRefresh
+  type:
+    type: string
+    const: content-refresh
+required:
+  - content
+  - type

openapi/components/schemas/WebsocketFriendActive.yaml

@@ -0,0 +1,13 @@
+title: WebsocketFriendActive
+type: object
+properties:
+  platform:
+    $ref: ./Platform.yaml
+  user:
+    $ref: ./User.yaml
+  userId:
+    $ref: ./UserID.yaml
+required:
+  - platform
+  - user
+  - userId

openapi/components/schemas/WebsocketFriendActiveEncoded.yaml

@@ -0,0 +1,15 @@
+title: WebsocketFriendActiveEncoded
+type: object
+properties:
+  content:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./WebsocketFriendActive.yaml
+    x-vrchat-double-encoding-type: WebsocketFriendActive
+  type:
+    type: string
+    const: friend-active
+required:
+  - content
+  - type

openapi/components/schemas/WebsocketFriendAdd.yaml

@@ -0,0 +1,10 @@
+title: WebsocketFriendAdd
+type: object
+properties:
+  user:
+    $ref: ./User.yaml
+  userId:
+    $ref: ./UserID.yaml
+required:
+  - user
+  - userId

openapi/components/schemas/WebsocketFriendAddEncoded.yaml

@@ -0,0 +1,15 @@
+title: WebsocketFriendAddEncoded
+type: object
+properties:
+  content:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./WebsocketFriendAdd.yaml
+    x-vrchat-double-encoding-type: WebsocketFriendAdd
+  type:
+    type: string
+    const: friend-add
+required:
+  - content
+  - type