Skip to main content Skip to complementary content

Creating a response component

Create a response component that can be used in several operations.

About this task

In this example, you need to define a response in case of an error. The same response should be used for all operations.

Procedure

  1. Click the + button in the left panel and click Response.
  2. Enter Error in the Name field and add a description.
  3. Click Add next to BODY, then click Add property under TYPE.
  4. Enter message in the Name field and enter An error occurred, please try again or contact support in the Examples field.
  5. Click Save.

Results

Your response component is created, you can now reference it in any operation in your API.
Definition of the Error response.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!