Update swagger to include all delivery statuses for notifications

[cris-oddball]

User Story - Business Need

Our swagger documentations has a single enum, "created", in the schema for the GET v2/notifications response.

There are other delivery statuses than "created", we should complete the enum with all available status strings.

Swagger also provides a Description section for the route, which should be populated with a list or table or paragraph explaining which states are final and which states are transient and will be retried.

Note that the callback routes also contain statuses, which should also be updated.

This ticket is based off a client request received for more information.

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

User Story(ies)

As a client of VANotify
I want to understand all the possibilities of a notification's delivery status
So that I can categorize the states into final/absolute states, and states that are intermediary/transient

Additional Info and Resources

• Update notification statuses enum for the status property in GET /v2/notifications/{notification_id} response
  

• Update notification statuses enum for the notification_statuses property in

  • GET /service/{service_id}/callback response schema
  • GET /service/{service_id}/callback/{callback_id} response schema
  • POST /service/{service_id}/callback request schema and response schema
  • POST /service/{service_id}/callback/{callback_id} request schema and response schema
    

See this ADR and follow the code to make sure this is the definitive list:

• created
• sending
• sent
• delivered
• permanent-failure
• temporary-failure
• cancelled

OpenAPI spec
Swagger Editor
Our application's swagger document

Acceptance Criteria

• Be sure to increment the version number of the swagger doc
• The enum for status in the sms response schema for the GET v2/notifications/{notification_id} includes all possible status strings
• The enum for status in the email response schema for the GET v2/notifications/{notification_id} includes all possible status strings
• The enum for status in the response schema for GET /service/{service_id}/callback includes all possible status strings
• The enum for status in the response schema for GET /service/{service_id}/callback/{callback_id} includes all possible status strings
• The enum for status in the request and responses schemas for POST /service/{service_id}/callback includes all possible status strings
• The enum for status in the request and responses schemas for POST /service/{service_id}/callback/{callback_id} includes all possible status strings
• The description for the path includes a section describing which of these statuses are final and which are retried and who retries them (client? VANotify?) - or that the status reason will provide that information (see linked ADR)
• Portal is notified so that they can pull in these changes to the documentation displayed in the Portal.
• This work is added to the sprint review slide deck (key win bullet point and demo slide)

QA Considerations

• Double-check the work

Potential Dependencies

[npmartin-oddball]

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