Websocket types

openapi/components/schemas/Notification.yaml

@@ -1,43 +1,6 @@
 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
+allOf:
+  - title: base
+    $ref: ./NotificationBase.yaml
+  - title: detail
+    $ref: ./NotificationDetailEncoded.yaml

openapi/components/schemas/NotificationBase.yaml

@@ -0,0 +1,36 @@
+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
+  type:
+    $ref: ./NotificationType.yaml
+required:
+  - created_at
+  - id
+  - message
+  - senderUserId
+  - type

openapi/components/schemas/NotificationDetailBoopEncoded.yaml

@@ -0,0 +1,12 @@
+title: NotificationDetailBoopEncoded
+type: object
+properties:
+  details:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailBoop.yaml
+    x-vrchat-double-encoding-type: NotificationDetailBoop
+required:
+  - details
+x-vrchat-double-encoding: true

openapi/components/schemas/NotificationDetailEncoded.yaml

@@ -0,0 +1,26 @@
+title: NotificationDetail
+properties:
+  type:
+    $ref: ./NotificationType.yaml
+required:
+  - type
+discriminator:
+  mapping:
+    boop: ./NotificationDetailBoopEncoded.yaml
+    friendRequest: ./NotificationDetailFriendRequestEncoded.yaml
+    invite: ./NotificationDetailInviteEncoded.yaml
+    inviteResponse: ./NotificationDetailInviteResponseEncoded.yaml
+    message: ./NotificationDetailMessageEncoded.yaml
+    requestInvite: ./NotificationDetailRequestInviteEncoded.yaml
+    requestInviteResponse: ./NotificationDetailRequestInviteResponseEncoded.yaml
+    votetokick: ./NotificationDetailVoteToKickEncoded.yaml
+  propertyName: type
+oneOf:
+  - $ref: ./NotificationDetailBoopEncoded.yaml
+  - $ref: ./NotificationDetailFriendRequestEncoded.yaml
+  - $ref: ./NotificationDetailInviteEncoded.yaml
+  - $ref: ./NotificationDetailInviteResponseEncoded.yaml
+  - $ref: ./NotificationDetailMessageEncoded.yaml
+  - $ref: ./NotificationDetailRequestInviteEncoded.yaml
+  - $ref: ./NotificationDetailRequestInviteResponseEncoded.yaml
+  - $ref: ./NotificationDetailVoteToKickEncoded.yaml

openapi/components/schemas/NotificationDetailFriendRequest.yaml

@@ -0,0 +1,6 @@
+title: NotificationDetailFriendRequest
+type: object
+properties:
+  # This exists to force generators to generate this struct, since it's referenced "manually" via `x-vrchat-double-encoding-type`
+  dontDeletePls:
+    type: integer

openapi/components/schemas/NotificationDetailFriendRequestEncoded.yaml

@@ -0,0 +1,12 @@
+title: NotificationDetailFriendRequestEncoded
+type: object
+properties:
+  details:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailFriendRequest.yaml
+    x-vrchat-double-encoding-type: NotificationDetailFriendRequest
+required:
+  - details
+x-vrchat-double-encoding: true

openapi/components/schemas/NotificationDetailInviteEncoded.yaml

@@ -0,0 +1,12 @@
+title: NotificationDetailInviteEncoded
+type: object
+properties:
+  details:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailInvite.yaml
+    x-vrchat-double-encoding-type: NotificationDetailInvite
+required:
+  - details
+x-vrchat-double-encoding: true

openapi/components/schemas/NotificationDetailInviteResponseEncoded.yaml

@@ -0,0 +1,12 @@
+title: NotificationDetailInviteResponseEncoded
+type: object
+properties:
+  details:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailInviteResponse.yaml
+    x-vrchat-double-encoding-type: NotificationDetailInviteResponse
+required:
+  - details
+x-vrchat-double-encoding: true

openapi/components/schemas/NotificationDetailMessage.yaml

@@ -0,0 +1,6 @@
+title: NotificationDetailMessage
+type: object
+properties:
+  # This exists to force generators to generate this struct, since it's referenced "manually" via `x-vrchat-double-encoding-type`
+  dontDeletePls:
+    type: integer

openapi/components/schemas/NotificationDetailMessageEncoded.yaml

@@ -0,0 +1,12 @@
+title: NotificationDetailMessageEncoded
+type: object
+properties:
+  details:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailMessage.yaml
+    x-vrchat-double-encoding-type: NotificationDetailMessage
+required:
+  - details
+x-vrchat-double-encoding: true

openapi/components/schemas/NotificationDetailRequestInviteEncoded.yaml

@@ -0,0 +1,12 @@
+title: NotificationDetailRequestInviteEncoded
+type: object
+properties:
+  details:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailRequestInvite.yaml
+    x-vrchat-double-encoding-type: NotificationDetailRequestInvite
+required:
+  - details
+x-vrchat-double-encoding: true

openapi/components/schemas/NotificationDetailRequestInviteResponseEncoded.yaml

@@ -0,0 +1,12 @@
+title: NotificationDetailRequestInviteResponseEncoded
+type: object
+properties:
+  details:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailRequestInviteResponse.yaml
+    x-vrchat-double-encoding-type: NotificationDetailRequestInviteResponse
+required:
+  - details
+x-vrchat-double-encoding: true

openapi/components/schemas/NotificationDetailVoteToKickEncoded.yaml

@@ -0,0 +1,12 @@
+title: NotificationDetailVoteToKickEncoded
+type: object
+properties:
+  details:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./NotificationDetailVoteToKick.yaml
+    x-vrchat-double-encoding-type: NotificationDetailVoteToKick
+required:
+  - details
+x-vrchat-double-encoding: true

openapi/components/schemas/WebsocketClearNotification.yaml

@@ -0,0 +1,4 @@
+title: WebsocketClearNotification
+type: object
+# Todo: is this correct, or is some special handling necessary in WebsocketMessageNormal?
+additionalProperties: false

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,12 @@
+title: WebsocketContentRefreshEncoded
+type: object
+properties:
+  content:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./WebsocketContentRefresh.yaml
+    x-vrchat-double-encoding-type: WebsocketContentRefresh
+required:
+  - content
+x-vrchat-double-encoding: true

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,12 @@
+title: WebsocketFriendActiveEncoded
+type: object
+properties:
+  content:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./WebsocketFriendActive.yaml
+    x-vrchat-double-encoding-type: WebsocketFriendActive
+required:
+  - content
+x-vrchat-double-encoding: true

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,12 @@
+title: WebsocketFriendAddEncoded
+type: object
+properties:
+  content:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./WebsocketFriendAdd.yaml
+    x-vrchat-double-encoding-type: WebsocketFriendAdd
+required:
+  - content
+x-vrchat-double-encoding: true

openapi/components/schemas/WebsocketFriendDelete.yaml

@@ -0,0 +1,7 @@
+title: WebsocketFriendDelete
+type: object
+properties:
+  userId:
+    $ref: ./UserID.yaml
+required:
+  - userId

openapi/components/schemas/WebsocketFriendDeleteEncoded.yaml

@@ -0,0 +1,12 @@
+title: WebsocketFriendDeleteEncoded
+type: object
+properties:
+  content:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./WebsocketFriendDelete.yaml
+    x-vrchat-double-encoding-type: WebsocketFriendDelete
+required:
+  - content
+x-vrchat-double-encoding: true

openapi/components/schemas/WebsocketFriendLocation.yaml

@@ -0,0 +1,22 @@
+title: WebsocketFriendLocation
+type: object
+properties:
+  canRequestInvite:
+    type: boolean
+  location:
+    $ref: ./LocationID.yaml
+  travelingToLocation:
+    $ref: ./LocationID.yaml
+  user:
+    $ref: ./User.yaml
+  userId:
+    $ref: ./UserID.yaml
+  worldId:
+    $ref: ./WorldID.yaml
+required:
+  - canRequestInvite
+  - location
+  - travelingToLocation
+  - user
+  - userId
+  - worldId

openapi/components/schemas/WebsocketFriendLocationEncoded.yaml

@@ -0,0 +1,12 @@
+title: WebsocketFriendLocationEncoded
+type: object
+properties:
+  content:
+    type: string
+    contentMediaType: application/json
+    contentSchema:
+      $ref: ./WebsocketFriendLocation.yaml
+    x-vrchat-double-encoding-type: WebsocketFriendLocation
+required:
+  - content
+x-vrchat-double-encoding: true