diff --git a/docs/objects/Notification.yaml b/docs/objects/Notification.yaml index 52c2e69ff..859eda588 100644 --- a/docs/objects/Notification.yaml +++ b/docs/objects/Notification.yaml @@ -55,3 +55,64 @@ components: default: 0 createdAt: $ref: '../schemas.yaml#/components/schemas/createdAt' + NotificationEvent: + type: object + properties: + name: + type: string + description: The name of the notification event. The names and allowable values are defined at https://github.com/advplyr/audiobookshelf/blob/master/server/utils/notifications.js + requiresLibrary: + type: boolean + description: Whether the notification event depends on a library existing. + libraryMediaType: + type: string + description: The type of media of the library the notification depends on existing. Will not exist if requiresLibrary is false. + nullable: true + description: + type: string + description: The description of the notification event. + variables: + type: array + items: + type: string + description: The variables of the notification event that can be used in the notification templates. + defaults: + type: object + properties: + title: + type: string + description: The default title template for notifications using the notification event. + body: + type: string + description: The default body template for notifications using the notification event. + testData: + type: object + description: The keys of the testData object will match the list of variables. The values will be the data used when sending a test notification. + additionalProperties: + type: string + NotificationSettings: + type: object + properties: + id: + $ref: '#/components/schemas/notificationId' + appriseType: + type: string + description: The type of Apprise that will be used. At the moment, only api is available. + appriseApiUrl: + type: string + nullable: true + description: The full URL where the Apprise API to use is located. + notifications: + type: array + items: + $ref: '#/components/schemas/Notification' + description: The set notifications. + maxFailedAttempts: + type: integer + description: The maximum number of times a notification fails before being disabled. + maxNotificationQueue: + type: integer + description: The maximum number of notifications in the notification queue before events are ignored. + notificationDelay: + type: integer + description: The time (in ms) between notification pushes.