diff --git a/openapi/components/schemas/Notification.yaml b/openapi/components/schemas/Notification.yaml index 96dfa994..0c2a17e7 100644 --- a/openapi/components/schemas/Notification.yaml +++ b/openapi/components/schemas/Notification.yaml @@ -5,7 +5,7 @@ properties: type: string details: default: '{}' - description: '**NOTICE:** This is not a JSON object, this is a json **encoded** object, meaning you have to json-de-encode to get the NotificationDetail object depending on the NotificationType.' + 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.' example: 'OneOf: {}, NotificationDetailInvite, NotificationDetailInviteResponse, NotificationDetailRequestInvite, NotificationDetailRequestInviteResponse, NotificationDetailVoteToKick' type: string id: @@ -17,7 +17,11 @@ properties: type: string seen: default: false + description: 'Not included in notification objects received from the Websocket API' type: boolean + receiverUserId: + description: 'Not included in notification objects received from the REST API' + $ref: ./UserID.yaml senderUserId: $ref: ./UserID.yaml senderUsername: @@ -34,7 +38,6 @@ required: - type - message - details - - seen - created_at title: Notification type: object