swagger-api / swagger-api/swagger-codegen
Request headers not displaying correctly in html generated documentation
Open
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
I'm using Swagger Hub to generate html documentation. The generated html does not display request headers correctly. I looked at similar issues on github but the problem has not been resolved.
Swagger-codegen version
3.0
Swagger declaration file content or url
paths:
/ping:
get:
summary: Checks if the server is alive
parameters:
- in: header
name: userId
schema:
type: integer
required: true
description: Numeric ID of the user to get
Related issues/PRs
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
Reproduce the generated HTML documentation from the supplied OpenAPI paths example, focusing on the GET /ping operation and its required userId header. Compare the rendered request-header section with the attached screenshots and verify that the header is displayed correctly in the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100