Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
7 tasks
cris-oddball opened this issue Sep 20, 2024 · 1 comment
Open
7 tasks

Comments

@cris-oddball
Copy link

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.

  • 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

  • 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.
  • 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.
  • 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
  • This work is added to the sprint review slide deck (key win bullet point and demo slide)

QA Considerations

  • QA to review and approve swagger changes
  • 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.

@cris-oddball cris-oddball changed the title Update Swagger and Postman for the new callback property in POST/GET notification requests Update Swagger and Postman for the new callback property in POST/GET notifications Sep 20, 2024
@npmartin-oddball
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants