Forum Discussion

AayushiYadav's avatar
AayushiYadav
Frequent Visitor
4 years ago

How can we write different message samples for the same response status code in OAS 3.0?

Hi,

How can we write different message samples for the same response status code?

'400':
description: Any exception occured.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
'400':
description: Plain text cannot be blanked.
content:
application/json:
schema:
$ref: "#/components/schemas/error"
400:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/responsenestedobj"

 

how to achieve it?

 

Thanks and Regards,

Aayushi Yadav

1 Reply

Sort By
  • HKosova's avatar
    HKosova
    SmartBear Alumni (Retired)
    4 years ago

    Hi AayushiYadav,

     

    Each HTTP status code can be defined only once per operation, so you'll need to merge all the 400 response definitions into one. For example, like this:

     

            '400':
          description: >-
            Possible reasons:
            
            * Plain text cannot be blanked.
            * Any exception occurred.
            * Unexpected error.

          content:
            application/json:
              schema:
                oneOf:
                  - $ref: "#/components/schemas/error"
                  - $ref: "#/components/schemas/responsenestedobj"