Multiple responses - Mintlify
If your API returns different responses based on input parameters, user context, or other conditions of the request, you can document multiple response examples with the examples property.
This property can be added to any response and has the following schema.
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: "#/components/schemas/YourResponseSchema"
examples:
us:
summary: Response for United States
value:
countryCode: "US"
currencyCode: "USD"
taxRate: 0.0825
gb:
summary: Response for United Kingdom
value:
countryCode: "GB"
currencyCode: "GBP"
taxRate: 0.20