As part of the VA's Zero Silent Failure Initiative (see epic), we are updating the OpenAPI spec and Postman collections to add in a new property, callback_url, to POST v2/notifications/<email | sms> payloads and the GET v2/notifications/:notification_idresponse, so that our clients can be aware of this property.
Updates the simplified Postman collection for the POST v2/notifications/<email | sms> routes.
Updates the Internal Developer Postman collection for the POST v2/notifications/<email | sms> routes.
Adds path descriptions to the Swagger POST v2/notifications/<email | sms> for additional information on all properties.
Updates the Swagger POST v2/notifications/<email | sms> examples, schemas and response object
Updates the Swagger GET v2/notifications/:notification_id examples, schemas and response object
issue #2000
How Has This Been Tested?
Opened the openapi.yml file in the Swagger editor and uploaded the file from this branch to see the changes. For the sake of brevity, only the email route and email example are shown below:
Description
As part of the VA's Zero Silent Failure Initiative (see epic), we are updating the OpenAPI spec and Postman collections to add in a new property,
callback_url, to POSTv2/notifications/<email | sms>payloads and the GETv2/notifications/:notification_idresponse, so that our clients can be aware of this property.v2/notifications/<email | sms>routes.v2/notifications/<email | sms>routes.v2/notifications/<email | sms>for additional information on all properties.v2/notifications/<email | sms>examples, schemas and response objectv2/notifications/:notification_idexamples, schemas and response objectissue #2000
How Has This Been Tested?
Opened the openapi.yml file in the Swagger editor and uploaded the file from this branch to see the changes. For the sake of brevity, only the email route and email example are shown below:
Used the Postman collection to send email and sms
Checklist