Skip to content

Swagger UI renders parameter descriptions and response descriptions in monospace #4173

Open
@DavidBiesack

Description

@DavidBiesack

Swagger UI renders parameter descriptions and response descriptions in monospace

Q A
Bug or feature request? bug
Which Swagger/OpenAPI version? 2.0
Which Swagger-UI version? 3.6.1
How did you install Swagger-UI? pull from GigHub and deploy dist to localhost web server
Which browser & version? Chrome 63.0.3239.132 (Official Build) (64-bit)
Which operating system? OS X Hi Siersa 10.13.1
your: "API definition goes here"

Configuration (browser query string, constructor, config.yaml)

swagger: '2.0'

info:

  title: Swagger UI Markdown Issue
  description: Is [Markdown](http://commonmark.org/help/) handled in Swagger UI?
  version: '2018-01-29'
basePath: /exampleApi
paths:
  /models/{modelId}:
    parameters:
      - name: modelId
        in: path
        description: Is [Markdown](http://commonmark.org/help/) handled in Swagger UI?
        type: string
        required: true
    get:
      responses:
        '200':
           description: >-
             *OK*

             Is [Markdown](http://commonmark.org/help/) handled in
             Swagger UI?
             
             The response contains a `date` and a unique `id`
           schema: 
             $ref: '#/definitions/model'
             
definitions:

  model:
    properties:
      date:
        description: >-
          The model's date

          Is [Markdown](http://commonmark.org/help/) handled in Swagger UI?
        type: string
        format: date-time
      id:
        description: "The model's unique ID"
        type: string
    example:
      id: 1
      date: 2018-01-22T03:43:57.375Z

Expected Behavior

descriptions and other text should be in normal text font, not monospace.
Text within the descriptions may use backticks to result in monospace,
but

Current Behavior

if everything is monospace, such text is not distinguishable.
See screenshot
screen shot 2018-01-29 at 9 07 28 am

Possible Solution

Context

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions