Update Swagger and Postman for the new callback property in POST/GET notifications

cris-oddball commented 2 months ago

User Story - Business Need

As part of the VA's Zero Silent Failure Initiative (see epic), we need to update the OpenAPI spec and Postman collections to add in a new property to POST v2/notifications/<email|sms>payloads for a callback URL and the GET v2/notifications/:notification_id response so that our clients can be aware of this property.

[x] Ticket is understood, and QA has been contacted (if the ticket has a QA label).

User Story(ies)

As a business line I want to have documentation as to the new callback payload So that I can make use of it to have zero silent failures.

Additional Info and Resources

Callback property name TBD.
It could be nice to include in swagger a description if a callback URL added to the POST payload, it overrides any service level callback.

Acceptance Criteria

[x] OpenAPI is updated for POST v2/notifications/email to include the new callback property in and that it is an optional string in the schema, examples, and responses.
[x] OpenAPI is updated for POST v2/notifications/sms to include the new callback property in and that it is an optional string in the schema, examples, and responses.
[x] The two Postman collections (for internal developers and clients) are updated to include the new callback property in the POST v2/notifications/email and v2/notifications/sms payloads
[x] This work is added to the sprint review slide deck (key win bullet point and demo slide)

QA Considerations

[x] QA to review and approve swagger changes
[x] QA to use Postman to exercise the routes to ensure they work as expected

Potential Dependencies

This work has dependencies on other tickets that have not been created at the time of this writing. Tickets will be linked as blockers at that time.

npmartin-oddball commented 2 months ago

Hey team! Please add your planning poker estimate with Zenhub @coreycarvalho @cris-oddball @EvanParish @k-macmillan @kalbfled @MackHalliday @mchlwellman

cris-oddball commented 1 month ago

PR is up and in draft mode.

cris-oddball commented 1 month ago

This PR is code complete. Waiting for #2104 and #2012 to open the PR for review.

cris-oddball commented 1 month ago

Decided to open the PR now for review. It can be sent up the pipeline later.

cris-oddball commented 1 month ago

PR approved and merged.

department-of-veterans-affairs / notification-api