Skip to content

Commit

Permalink
Notifications from the websocket have receiverUserId and do not hav…
Browse files Browse the repository at this point in the history
…e `seen` (#193)

* Notifications from the websocket have `receiverUserId` and do not have `seen`

* Added docs to the new notification items

* Consistent wording
  • Loading branch information
Rexios80 authored Nov 29, 2022
1 parent 7d5ce86 commit ed6735c
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions openapi/components/schemas/Notification.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -34,7 +38,6 @@ required:
- type
- message
- details
- seen
- created_at
title: Notification
type: object

0 comments on commit ed6735c

Please sign in to comment.