Sideband API sequence diagram

Processing steps

  1. When the API gateway receives a request from an API gateway plugin, it makes a call to the Sideband API to process the request.
  2. The Sideband API returns a response that contains a modified version of the HTTP client's request.

    The API gateway forwards the response to the REST API.

  3. If the Sideband API returns a response that indicates the request is unauthorized or not to be forwarded, the response includes the response to be returned to the client.

    The API gateway returns the response to the client without forwarding the request to the REST API.

  4. When the API gateway receives a response from the REST API, it makes a call to the Sideband API to process the response.
  5. The Sideband API returns a response that contains a modified version of the REST API's response.

    The API gateway forwards the response to the client.