scientist-softserv / palni-palci

Other
1 stars 0 forks source link

Build the SUSHI status endpoint #653

Open labradford opened 1 year ago

labradford commented 1 year ago

Story

Part of #586

Create the status endpoing in JSON format. The report should be COUNTER compliant. The status report will be at this url: /api/sushi/r51/status

Acceptance Criteria

Testing

Notes

Returns the current status of the COUNTER_SUSHI API service. This path returns a message that includes the operating status of the API, the URL to the service’s entry in the COUNTER Registry, and an array of service alerts (if any).

This path MUST be public, i.e. not protected by the methods described in Section 8.2, to allow report consumers to easily check whether a SUSHI server is live.

https://countermetrics.stoplight.io/docs/counter-sushi-api/f0dd30f814944-server-status

alishaevn commented 1 year ago

per today's standup: we may or may not need this feature. it's required for counter compliance certification, but the client doesn't plan on getting that.

summer-cook commented 1 year ago

We will need to complete this work

Image

ctgraham commented 1 year ago

My read of the spec is that the Alerts entity is optional, and should not be present if entirely empty.

labradford commented 1 year ago

QA - Alerts has been removed from the status report