swagger-api / swagger-api/swagger-codegen

[html2] response schema missing with openapi 3.0

Open
#9,274 1 comment 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

The html2 documentation is missing the response schema.

Swagger-codegen version

3.0.4 (information provided by SwaggerHub)

Swagger declaration file content or url

https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/petstore.yaml

Command line used for generation
Steps to reproduce

Download and upload or copy/paste the petstore.yaml to your SwaggerHub API
export the to Documentation - html2 format.

I tried it locally as well, BUT since I couldn't find any v3.0.4 swagger-codegen binary available I tested it with the 3.0rc1 version.
java -jar swagger-codegen-cli-3.0.0-rc1.jar generate -i petstore.yaml -l html2 -o docs
(I had downloaded the yaml file previously).

Related issues/PRs
Suggest a fix/enhancement

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by generating html2 documentation from the linked OpenAPI petstore.yaml with the documented swagger-codegen command, then inspect the generated response documentation and the html2 generation path. Done means the generated documentation includes the response schema defined by the OpenAPI 3.0 example.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.