swagger-api / swagger-api/swagger-codegen
[HTML] Not making use of parameter value examples
Open
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
Not making use of parameter value examples.
Especially for in: body stuff this would be quite important for documentation purposes.
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
foo is nowhere to be found.
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 supplied Swagger declaration and inspect the generated HTML documentation for the body parameter. Confirm whether the schema example containing “foo” and “bar” is omitted, then use its presence in the generated documentation as the completion check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100