Moved schemas into objects/ definitions

2026-07-14 21:31:43 +00:00 · 2024-02-25 18:32:04 +00:00 · 2024-02-25 18:32:04 +00:00 · cc53f16185
commit cc53f16185
parent cc37c3d41f
30 changed files with 3380 additions and 3241 deletions
--- a/server/objects/Notification.js
+++ b/server/objects/Notification.js
@ -1,5 +1,133 @@
 const uuidv4 = require("uuid").v4

+/**
+ * @openapi
+ * components:
+ *   schemas:
+ *     notification:
+ *       type: object
+ *       properties:
+ *         id:
+ *           description: The ID of the notification.
+ *           type: string
+ *           example: noti_nod281qwkj5ow7h7fi
+ *         libraryId:
+ *           description: The ID of the library the notification is associated with.
+ *           type: [string, 'null']
+ *         eventName:
+ *           description: The name of the event the notification will fire on.
+ *           type: string
+ *           example: onPodcastEpisodeDownloaded
+ *         urls:
+ *           description: The Apprise URLs to use for the notification.
+ *           type: array
+ *           items:
+ *             type: string
+ *             example: apprises://apprise.example.com/email
+ *         titleTemplate:
+ *           description: The template for the notification title.
+ *           type: string
+ *           example: New {{podcastTitle}} Episode!
+ *         bodyTemplate:
+ *           description: The template for the notification body.
+ *           type: string
+ *           example: '{{episodeTitle}} has been added to {{libraryName}} library.'
+ *         enabled:
+ *           description: Whether the notification is enabled.
+ *           type: boolean
+ *           example: true
+ *         type:
+ *           description: The notification's type.
+ *           type: string
+ *           example: info
+ *         lastFiredAt:
+ *           description: The time (in ms since POSIX epoch) when the notification was last fired. Will be null if the notification has not fired.
+ *           type: [integer, 'null']
+ *           example: 1668776410792
+ *         lastAttemptFailed:
+ *           description: Whether the last notification attempt failed.
+ *           type: boolean
+ *           example: false
+ *         numConsecutiveFailedAttempts:
+ *           description: The number of consecutive times the notification has failed.
+ *           type: integer
+ *           example: 0
+ *         numTimesFired:
+ *           description: The number of times the notification has fired.
+ *           type: integer
+ *           example: 5
+ *         createdAt:
+ *           $ref: '#/components/schemas/createdAt'
+ *     notificationEvents:
+ *       type: object
+ *       properties:
+ *         name:
+ *           description: The name of the notification event.
+ *           type: string
+ *           example: onPodcastEpisodeDownloaded
+ *         requiresLibrary:
+ *           description: Whether the notification event depends on a library existing.
+ *           type: boolean
+ *           example: true
+ *         libraryMediaType:
+ *           description: The type of media of the library the notification depends on existing. Will not exist if requiresLibrary is false.
+ *           type: [string, 'null']
+ *           example: podcast
+ *         description:
+ *           description: The description of the notification event.
+ *           type: string
+ *           example: Triggered when a podcast episode is auto-downloaded
+ *         variables:
+ *           description: The variables of the notification event that can be used in the notification templates.
+ *           type: array
+ *           items:
+ *             type: string
+ *             example: libraryItemId
+ *               - libraryId
+ *               - libraryName
+ *               - mediaTags
+ *               - podcastTitle
+ *               - podcastAuthor
+ *               - podcastDescription
+ *               - podcastGenres
+ *               - episodeId
+ *               - episodeTitle
+ *               - episodeSubtitle
+ *               - episodeDescription
+ *         defaults:
+ *           type: object
+ *           properties:
+ *             title:
+ *               description: The default title template for notifications using the notification event.
+ *               type: string
+ *               example: New {{podcastTitle}} Episode!
+ *             body:
+ *               description: The default body template for notifications using the notification event.
+ *               type: string
+ *               example: '{{episodeTitle}} has been added to {{libraryName}} library.'
+ *         testData:
+ *           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.
+ *           type: object
+ *           properties:
+ *             libraryItemId:
+ *               type: string
+ *               example: li_notification_test
+ *             libraryId:
+ *               type: string
+ *               example: lib_test
+ *             libraryName:
+ *               type: string
+ *               example: Podcasts
+ *             podcastTitle:
+ *               type: string
+ *               example: Abs Test Podcast
+ *             episodeId:
+ *               type: string
+ *               example: ep_notification_test
+ *             episodeTitle:
+ *               type: string
+ *               example: Successful Test
+ */
 class Notification {
  constructor(notification = null) {
    this.id = null