department-of-veterans-affairs / notification-api

Notification API
MIT License
16 stars 9 forks source link

Update swagger to include all delivery statuses for notifications #2035

Open cris-oddball opened 1 month ago

cris-oddball commented 1 month ago

User Story - Business Need

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

Screenshot 2024-10-04 at 1.06.41 PM.jpg

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.

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

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

Statuses that should be in the enum:

OpenAPI spec Swagger Editor Our application's swagger document

Acceptance Criteria

QA Considerations

Potential Dependencies

npmartin-oddball commented 1 month ago

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