Skip to content
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

Notifications from the websocket have receiverUserId and do not have seen #193

Merged
merged 3 commits into from
Nov 29, 2022
Merged

Notifications from the websocket have receiverUserId and do not have seen #193

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a899bc1
Notifications from the websocket have `receiverUserId` and do not hav…
Rexios80 Nov 17, 2022
e0ba143
Added docs to the new notification items
Rexios80 Nov 17, 2022
69f45ae
Consistent wording
Rexios80 Nov 17, 2022
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
7 changes: 5 additions & 2 deletions openapi/components/schemas/Notification.yaml
View file
Open in desktop
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