Redoc: Why is not `example` attribute of `properties` object displayed?

Created on 18 May 2019  路  3Comments  路  Source: Redocly/redoc

What is happen?

I written following yaml and I create redoc html.

$ npx redoc-cli bundle petstore.yamlnpx redoc-cli bundle petstore.yaml
        tag:
          type: string
          example: "Test Example"
          description: "Test Description"

But example value was not displayed in redoc html.

image

Question

Why is not example attribute of properties object displayed?

petstore.yaml

openapi: "3.0.0"
info:
  version: 1.0.0
  title: Swagger Petstore
  license:
    name: MIT
servers:
  - url: http://petstore.swagger.io/v1
paths:
  /pets:
    get:
      summary: List all pets
      operationId: listPets
      tags:
        - pets
      parameters:
        - name: limit
          in: query
          description: How many items to return at one time (max 100)
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: A paged array of pets
          headers:
            x-next:
              description: A link to the next page of responses
              schema:
                type: string
          content:
            application/json:    
              schema:
                $ref: "#/components/schemas/Pets"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      summary: Create a pet
      operationId: createPets
      tags:
        - pets
      responses:
        '201':
          description: Null response
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /pets/{petId}:
    get:
      summary: Info for a specific pet
      operationId: showPetById
      tags:
        - pets
      parameters:
        - name: petId
          in: path
          required: true
          description: The id of the pet to retrieve
          schema:
            type: string
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pets"
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
components:
  schemas:
    Pet:
      required:
        - id
        - name
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        tag:
          type: string
          example: "Test Example"
          description: "Test Description"
    Pets:
      type: array
      items:
        $ref: "#/components/schemas/Pet"
    Error:
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string

Environment

  • Windows10
$ node --version
v10.15.1

$ npx --version
6.4.1

$ npx redoc-cli --version
0.8.4

Most helpful comment

Examples are rendered at the right side - where response and request JSON examples are displayed. Each JSON field's value contains value from example property.

image

All 3 comments

Examples are rendered at the right side - where response and request JSON examples are displayed. Each JSON field's value contains value from example property.

image

Examples are rendered in the right column for payloads.

Thanks!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

JFCote picture JFCote  路  3Comments

raderio picture raderio  路  4Comments

jaroslawr picture jaroslawr  路  3Comments

skllcrn picture skllcrn  路  3Comments

gauravmokhasi picture gauravmokhasi  路  4Comments