Removal of 500 status response and use-400-error-response parameter from Add labels to content endpoint

What is changing?

Invalid requests sent to the Add labels to content endpoint ( POST /wiki/rest/api/content/{id}/label ) now always return 400 status responses. We have removed the old 500 status response, and the use-400-error-response query parameter is now ignored.

We will remove the use-400-error-response parameter from the documentation soon.

Why is it changing?

In February, we fixed an issue in which invalid requests would return 500 status responses with difficult-to-understand payloads. We changed the error response to have 400 status and a meaningful payload. However, to prevent a breaking change for apps relying on the old 500 response, we introduced the use-400-error-response parameter to toggle between the two responses and gave the 500 response a 3-month deprecation period, which passed in June. See the full announcement here: Update to POST /wiki/rest/api/content/{id}/label.

As the deprecation period is over, the 500 response is now removed, and the 400 response is returned instead for invalid requests, regardless of the presence of the use-400-error-response parameter.

What do I need to do?

Developers who currently make requests to POST /wiki/rest/api/content/{id}/label with the use-400-error-response parameter can safely remove this parameter.

By when do I need to do it?

The removal of the 500 response is live now.

In one week, the use-400-error-response parameter will be removed from the REST API documentation.

1 Like