Endpoint for listing generated notifications with results

[SandGrainOne]

Description

swagger: https://app.swaggerhub.com/apis/STEPHANIEBUADU/Notifications/1.0

Tasks

• Set up suggestion in swagger
• QA of endpoint design
• Implementation
• K6 tests
• QA
• Manual testing

Consideration

• We improve performance if we don't include the senders reference in the response. Is it important to include this value or could we drop it?

• What behavior do we want if the user is not authorized to review the notifications e.g. it is not the creator requesting the notifications. Do we want to return 403 or could we simply return:

{
    "orderId": "guid from request path"
    "notifications": [],
    "generated": 0,
    "succeeded": 0
}

An important note here, is that this would also be the respose if you call this endpoint before the requested send time of the order.

• Success results are: succeeded (accepted by communication services) and delivered. Meaning the success count might change if anything bounced back for instance. Is this ok?

Test

Acceptance Criteria

• 200 OK response if orderId exists and user has access
• 404 Not found if orderId does not exist
• 404 NOT found if orderId exists, but user does not have access
• 403 response if missing access token or scopes
• 401 if missing bearer token
• Senders reference should be included in response if it exists
• Expected mapping between status and descriptions

[acn-sbuad]

Current state of swagger is a starting point for discussing the design of the endpoint. Considerations with current state are

• how to see what is sent to a specific user across notification channels

[acn-sbuad]

/notifications/email endpoint is ready for implementation. Swagger is up to date and can be used as reference