Skip to content

Commit

Permalink
#1234 - Update Swagger for callback create route require property not…
Browse files Browse the repository at this point in the history
…ification statues (#2262)

#1234 -  Update Swagger for callback create route require property notification statues (#2262)
  • Loading branch information
MackHalliday authored Jan 22, 2025
1 parent 6ce1243 commit 8ae8ed1
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions documents/openapi/openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: VA Notify API Documentation
version: 1.1.0
version: 1.1.1
description: |
<p>This documents the API schemas for consumption by internal VA developers.</p>
<h1>Authorization header</h1>
Expand Down Expand Up @@ -2166,8 +2166,6 @@ components:
type: array
items:
$ref: '#/components/schemas/NotificationStatus'
required:
- notification_statuses
UpdateCallbackRequest:
type: object
properties:
Expand Down Expand Up @@ -2195,6 +2193,7 @@ components:
- queue
NotificationStatus:
description: |
<p> 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.
<p>These statuses do not warrant additional action: cancelled, created, delivered, pending, sending, and sent.</p>
<p>These statuses indicate a client-side error, such as specifying a nonexistent template ID, or other condition that will result in VA Notify <b>not</b> retrying to send the notification: failed, permanent-failure, and validation-failed. See the associated status_reason for amplifying information.</p>
<p>"temporary-failure" indicates that VA Notify will retry sending the notification.</p>
Expand Down

0 comments on commit 8ae8ed1

Please sign in to comment.