swagger-api/swagger-codegen

[HTML2] Not making use of method examples

Open

#3,660 opened on Aug 29, 2016

View on GitHub
 (4 comments) (0 reactions) (0 assignees)HTML (5,474 forks)batch import
Client: HTMLEnhancement: Generalhelp wanted

Repository metrics

Stars
 (12,701 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Description

Examples for parameters or return values are nowhere to be found in the resulting document.

Swagger-codegen version

2.2.1

Swagger declaration file content or url
swagger: '2.0'
info:
  version: 0.0.0
  title: Simple API
paths:
  /:
    get:
      parameters:
      - name: body
        in: body
        schema:
          type: string
          example: |
              foo
              bar
      responses:
        200:
          description: OK
          schema:
            type: string
            example: |
              foo
              bar

Contributor guide

Research direction
Investigate the HTML2 template files (e.g., mustache templates) to find where parameters and responses are rendered, and ensure the example field is included in the output.
Tech stack
htmljavascript
Domain
backenddocumentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Swagger/OpenAPIHTML templating
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70