Update Workspace API `noteFunction` when more status details are available

[mccalluc]

On October 3, the PSC Users API experienced an outage which disabled the Workspaces API. Juan indicates that we should not be directly reporting on the Users API, but that instead he will add information to the status JSON.

• On the portal-ui side, when more information is available, we should add a noteFunction in ServiceStatusTable.jsx.
• Zhou has said that when an API is down, the status response will just be empty. We should either confirm that this will also be true for Workspaces API, or if Workspaces API will have special-case logic to determine if it's up or down, we need to know what it is.

---

Zhou (Joe) Yuan

is this Users API being used by the workpaces-api?

Juan Puerto

This is internal to PSC - something you all wouldn’t be aware of and definitely shouldn’t report outages on the services page. I use it for authenticating against for the workspaces users when they submit jobs. This should be reported by the user workspaces API, similar to how we report a database outage.

Zhou (Joe) Yuan

Currently the workspaces-api (the REST API part) only shows the build number and version number and they are the only two pieces get exposed from the Gateway's /status.json call. I'd assume if the PSC-internal Users API is down, it would not alert the Gateway status...

Juan Puerto

I have to update the workspaces so that it includes that information - just not in place yet. (edited)

[yuanzhou]

Gateway status returns {} empty object for a given API to indicate there's no status information available. When the gateway checks against workspaces-api, any HTTP status code other than 200 would cause this {} being returned. When workspaces-api is down, the https://workspaces.api.hubmapconsortium.org/status should return a non-200 status code so Gateway knows it's not available.