From 991ed96df73f867485cadcba906b309a8f13906f Mon Sep 17 00:00:00 2001 From: Mackenzie Halliday Date: Wed, 22 Jan 2025 10:31:06 -0500 Subject: [PATCH 1/2] #1234 - Update swagger doc for creating callbacks with type notification delivery_status --- documents/openapi/openapi.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/documents/openapi/openapi.yaml b/documents/openapi/openapi.yaml index 301aa1d4fc..b777cedaae 100644 --- a/documents/openapi/openapi.yaml +++ b/documents/openapi/openapi.yaml @@ -2166,8 +2166,6 @@ components: type: array items: $ref: '#/components/schemas/NotificationStatus' - required: - - notification_statuses UpdateCallbackRequest: type: object properties: @@ -2195,6 +2193,7 @@ components: - queue NotificationStatus: description: | +

This field is optional. If not provided, the service will receive updates on all notification statuses by default. If included, the service will only receive updates for the specific statuses listed in this field.

These statuses do not warrant additional action: cancelled, created, delivered, pending, sending, and sent.

These statuses indicate a client-side error, such as specifying a nonexistent template ID, or other condition that will result in VA Notify not retrying to send the notification: failed, permanent-failure, and validation-failed. See the associated status_reason for amplifying information.

"temporary-failure" indicates that VA Notify will retry sending the notification.

From 068275222dc36ec8b28ff24f57147e56b887c212 Mon Sep 17 00:00:00 2001 From: Mackenzie Halliday Date: Wed, 22 Jan 2025 12:57:28 -0500 Subject: [PATCH 2/2] Squash #1234 - Update verison of swagger doc --- documents/openapi/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documents/openapi/openapi.yaml b/documents/openapi/openapi.yaml index b777cedaae..982923f729 100644 --- a/documents/openapi/openapi.yaml +++ b/documents/openapi/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: VA Notify API Documentation - version: 1.1.0 + version: 1.1.1 description: |

This documents the API schemas for consumption by internal VA developers.

Authorization header