OAS 3.0: Support for media type examples (aka request/response body examples)

[hkosova]

Version: ft/oas3 branch, as of commit a1ce0e7

OpenAPI 3.0 has requestBody.content.<media-type>.example(s) and responses.<code>.content.<media-type>.example(s). UI currently does not use these examples, but it would be great if it did. They are supposed to override schema-level examples if any.

Spec:

openapi: 3.0.0
info:
  version: 0.0.0
  title: test

paths:
  /something:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Message'
            example:
              message: request body example
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Message'
              example:
                message: response body example

components:
  schemas:
    Message:
      type: object
      properties:
        message:
          type: string
          example: property-level example

[gentlewind]

@webron , would you please share if this feature will be put on the release plan?

[hvt]

Would like to add that also supporting requestBody.content.<media-type>.examples and responses.<code>.content.<media-type>.examples would be of great value.

[kopinions]

any updates about this?