Add: summary to Notification endpoints

This commit is contained in:
Nicholas Wallace 2024-07-09 01:55:35 +00:00
parent e2e5449d25
commit 7ba4e9e66d

View File

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