How to write multiple examples in response body?

[Hao1995]

Scribe version

4.35.0

Your question

I want to add multiple examples to the response bodies. It is mentioned by swagger doc.

responses:
  '200':
    description: A user object.
    content:
      application/json:
        schema:
          $ref: '#/components/schemas/User'   # Reference to an object
        examples:
          Jessica:
            value:
              id: 10
              name: Jessica Smith
          Ron:
            value:
              id: 20
              name: Ron Stewart

Does it work on scribe?

Docs

• I've checked the docs, the troubleshooting guide, and existing issues, but I didn't find a solution

[shalvah]

Hey, yes Scribe supports multiple response samples using the "scenario" field. Check out https://scribe.knuckles.wtf/laravel/documenting/responses
But I'm not sure it's exactly handled correctly in OpenAPI, since OpenAPI doesn't let you add descriptions for examples.

[Dinushasilva]

@shalvah @Hao1995 This is introduced in #855

[Hao1995]

@shalvah @Hao1995 This is introduced in #855

Thanks your PR!!

[shalvah]

Unfortunately, that PR seems to be abandoned.