Breaking Change: Backend Service 502s Will Be Mapped to 503s Instead In Public API

[Daniel_Fruland]

Description

Public API now maps a 503 SERVICE_UNAVAILABLE status to 502 BAD_GATEWAY errors. Customers will therefore be returned 503s instead.

Change Category

API

Change Context

Currently, the Platform API receives 502 error statuses in response to failures in backend services and sends it to customers. Customers are not meant to see this as it is an inaccurate representation of platform stability.

Change Impact

Customers who are currently returned a 502 from Public API will now instead be given a 503. Users who keep track of this status code and have a protocol for it will have to monitor 503 status codes instead or remove said protocol.

Date of Change

February 10, 2025

Impacted APIs

Resource endpoints with documented 502 usage:

/api/v2/{authorityName}/{externalKey}

/api/v2/workforcemanagement/businessunits/{businessUnitId }/weeks/{weekDateId}/shorttermforecasts/generate/legacyweightedaverage

/api/v2/workforcemanagement/businessunits/{businessUnitId }/weeks/{weekDateId}/shorttermforecasts/generate/

References

[API-7241]

Update

Due to the changing nature of costs, this change will not be deployed.

[maruyama]

You have listed the APIs that are affected, but is it correct to assume that other APIs are not affected?

Impacted APIs

Resource endpoints with documented 502 usage:

/api/v2/{authorityName}/{externalKey}

/api/v2/workforcemanagement/businessunits/{businessUnitId }/weeks/{weekDateId}/shorttermforecasts/generate/legacyweightedaverage

/api/v2/workforcemanagement/businessunits/{businessUnitId }/weeks/{weekDateId}/shorttermforecasts/generate/

[Daniel_Fruland]

Not necessarily, these are just endpoints whose docs will break which we can see from our end.