swagger-api / swagger-api/swagger-codegen
[HTML2] Not making use of method examples
Open
Nobody has claimed this yet.
Client: HTML
Enhancement: General
help wanted
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- 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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the HTML2 documentation generation path and the provided Swagger YAML, then reproduce the output for the body parameter and response schema. Compare the generated document with the schema examples in the issue; done means those examples appear in the resulting documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100