From 4fd93ce64c36345c4e90997da1687ab21712280f Mon Sep 17 00:00:00 2001 From: Nicholas Wallace Date: Tue, 9 Jul 2024 01:55:55 +0000 Subject: [PATCH] Update bundled spec --- docs/openapi.json | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/docs/openapi.json b/docs/openapi.json index 2f79a422..33669d58 100644 --- 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" ],