Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

UI does not show the default value when one is assigned for an enum

See original GitHub issue

The GET in the below OpenAPI yaml contains a parameter named imageSize, but the rendering of the query parameters does not disclose the default. Note that swagger-codegen (-l html) includes the default at the end of the description field

swagger: "2.0"
info:
  version: "1"
  title: Missing default for enum 
  description: Demonstrate Swagger UI bug not showing default for an enum
basePath: /enumDefault
schemes:
- "http"
paths:
  /example:
    get:
      summary: Get a diagram
      description: Get a diagram
      produces:
      - application/json
      parameters:
      - name: imageSize
        in: query
        type: string
        enum:
        - thumbnail
        - icon
        - scaled
        - fullsize
        required: false
        default: thumbnail
        description: The layout type. 
      responses:
        200:
          description: OK
          schema:
            $ref: "#/definitions/diagram"
          headers:
            Location:
              description: The URL of the diagram.
              type: string
              format: uri
definitions:
  diagram:
    title: Diagram
    description: The representation of a diagram.
    properties:
      id:
        type: string
        description: The unique identifier for the diagram.
      imageSize:
        type: string
        enum:
        - thumbnail
        - icon
        - scaled
        - fullsize
        default: thumbnail
        description: The layout type.

current Swagger UI rendering: missing-default-for-enum-parameter

Issue Analytics

State:
Created 6 years ago
Reactions:1
Comments:8 (4 by maintainers)

Top GitHub Comments

1reaction

hkosovacommented, Nov 7, 2017

@masterof0 commented:

I am having a similar issue where the UI does not show enum options for parameters in the default view or the ‘try it out’ view.

@shockey commented:

I think you’re describing a related, but different issue. We’d appreciate it if you would open a new ticket for that!

I opened #3873 about rendering enums in parameter descriptions.

0reactions

shockeycommented, Jul 31, 2018

@DenisGorbachev, I believe this commit added the default value display: https://github.com/swagger-api/swagger-ui/commit/a47da98b54d122979bb8754e3050a4df0cc50d48