Respuestas múltiples

Muestra variaciones de respuesta para el mismo endpoint

Si tu API devuelve distintas respuestas según los parámetros de entrada, el contexto del usuario u otras condiciones de la solicitud, puedes documentar varios ejemplos de respuesta con la propiedad examples.

Esta propiedad se puede añadir a cualquier respuesta y tiene el siguiente esquema.

responses:
  "200":
    description: Respuesta exitosa
    content:
      application/json:
        schema:
          $ref: "#/components/schemas/YourResponseSchema"
        examples:
          us:
            summary: Respuesta para Estados Unidos
            value:
              countryCode: "US"
              currencyCode: "USD"
              taxRate: 0.0825
          gb:
            summary: Respuesta para Reino Unido
            value:
              countryCode: "GB"
              currencyCode: "GBP"
              taxRate: 0.20