Merge pull request advplyr#3139 from nichwall/email_notification_lint…

…ing_fixes Email notification linting fixes
glorenzen · Jul 9, 2024 · f0a1ea4 · f0a1ea4
2 parents 10cb8eb + 4fd93ce
commit f0a1ea4
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 13 deletions.
diff --git a/docs/controllers/EmailController.yaml b/docs/controllers/EmailController.yaml
@@ -25,7 +25,8 @@ components:
 paths:
   /api/emails/settings:
     get:
-      description: Get email settings
+      summary: Get email settings
+      description: Get email settings for sending e-books to e-readers.
       operationId: getEmailSettings
       tags:
         - Email
@@ -42,7 +43,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/EmailSettings'
+              $ref: '../objects/settings/EmailSettings.yaml#/components/schemas/EmailSettings'
       responses:
         200:
           $ref: '#/components/responses/email200'

diff --git a/docs/controllers/NotificationController.yaml b/docs/controllers/NotificationController.yaml
@@ -18,6 +18,7 @@ paths:
   /api/notifications:
     get:
       operationId: getNotifications
+      summary: Get notification settings
       description: Get all Apprise notification events and notification settings for server.
       tags:
         - Notification
@@ -41,8 +42,9 @@ paths:
         '404':
           $ref: '#/components/responses/notification404'
     patch:
-      operationId: updateNotificationSettings
-      description: Update Notification settings.
+      operationId: configureNotificationSettings
+      summary: Update select notification settings
+      description: Update the URL, max failed attempts, and maximum notifications that can be queued for Apprise.
       tags:
         - Notification
       requestBody:
@@ -64,7 +66,8 @@ paths:
           $ref: '#/components/responses/notification404'
     post:
       operationId: createNotification
-      description: Update Notification settings.
+      summary: Create notification settings
+      description: Create or update Notification settings.
       tags:
         - Notification
       requestBody:
@@ -107,6 +110,7 @@ paths:
   /api/notificationdata:
     get:
       operationId: getNotificationEventData
+      summary: Get notification event data
       description: Get all Apprise notification event data for the server.
       tags:
         - Notification
@@ -127,6 +131,7 @@ paths:
   /api/notifications/test:
     get:
       operationId: sendDefaultTestNotification
+      summary: Send general test notification
       description: Send a test notification.
       tags:
         - Notification
@@ -151,6 +156,7 @@ paths:
           $ref: '../objects/Notification.yaml#/components/schemas/notificationId'
     delete:
       operationId: deleteNotification
+      summary: Delete a notification
       description: Delete the notification by ID and return the notification settings.
       tags:
         - Notification
@@ -168,7 +174,8 @@ paths:
           $ref: '#/components/responses/notification404'
     patch:
       operationId: updateNotification
-      description: Update individual Notification
+      summary: Update a notification
+      description: Update an individual Notification by ID
       tags:
         - Notification
       requestBody:
@@ -213,7 +220,8 @@ paths:
           $ref: '../objects/Notification.yaml#/components/schemas/notificationId'
     get:
       operationId: sendTestNotification
-      description: Send a test to the given notification.
+      summary: Send a test notification
+      description: Send a test to the given notification by ID.
       tags:
         - Notification
       responses:

diff --git a/docs/openapi.json b/docs/openapi.json
@@ -422,7 +422,8 @@
     },
     "/api/emails/settings": {
       "get": {
-        "description": "Get email settings",
+        "summary": "Get email settings",
+        "description": "Get email settings for sending e-books to e-readers.",
         "operationId": "getEmailSettings",
         "tags": [
           "Email"
@@ -1162,6 +1163,7 @@
     "/api/notifications": {
       "get": {
         "operationId": "getNotifications",
+        "summary": "Get notification settings",
         "description": "Get all Apprise notification events and notification settings for server.",
         "tags": [
           "Notification"
@@ -1199,8 +1201,9 @@
         }
       },
       "patch": {
-        "operationId": "updateNotificationSettings",
-        "description": "Update Notification settings.",
+        "operationId": "configureNotificationSettings",
+        "summary": "Update select notification settings",
+        "description": "Update the URL, max failed attempts, and maximum notifications that can be queued for Apprise.",
         "tags": [
           "Notification"
         ],
@@ -1235,7 +1238,8 @@
       },
       "post": {
         "operationId": "createNotification",
-        "description": "Update Notification settings.",
+        "summary": "Create notification settings",
+        "description": "Create or update Notification settings.",
         "tags": [
           "Notification"
         ],
@@ -1302,6 +1306,7 @@
     "/api/notificationdata": {
       "get": {
         "operationId": "getNotificationEventData",
+        "summary": "Get notification event data",
         "description": "Get all Apprise notification event data for the server.",
         "tags": [
           "Notification"
@@ -1334,6 +1339,7 @@
     "/api/notifications/test": {
       "get": {
         "operationId": "sendDefaultTestNotification",
+        "summary": "Send general test notification",
         "description": "Send a test notification.",
         "tags": [
           "Notification"
@@ -1372,6 +1378,7 @@
       ],
       "delete": {
         "operationId": "deleteNotification",
+        "summary": "Delete a notification",
         "description": "Delete the notification by ID and return the notification settings.",
         "tags": [
           "Notification"
@@ -1399,7 +1406,8 @@
       },
       "patch": {
         "operationId": "updateNotification",
-        "description": "Update individual Notification",
+        "summary": "Update a notification",
+        "description": "Update an individual Notification by ID",
         "tags": [
           "Notification"
         ],
@@ -1471,7 +1479,8 @@
       ],
       "get": {
         "operationId": "sendTestNotification",
-        "description": "Send a test to the given notification.",
+        "summary": "Send a test notification",
+        "description": "Send a test to the given notification by ID.",
         "tags": [
           "Notification"
         ],