swagger-api / swagger-api/swagger-codegen

HTML2 output contains errors and does not match API code or documentation

Open
#12,310 2 comments 0 reactions 1 assignee View on GitHub

@HugoMario is already working on this.

Since Jan 23, 2024.

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

Description

Description

The HTML2 doc generated from our APIs contains the following errors:

  1. The capitalization is incorrect in the HTML2 output and does not match the API.
  2. The calls have been reorganized in the HTML2 and do not match the order shown in the original code.
  3. Some of the call names are different, and incorrect, in the HTML2 version. For example, some of the GET calls have been changed to ADD.

image
image

This is a problem because we cannot generate accurate documentation from our APIs.

Swagger-codegen version
The current version in SwaggerHub cloud.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.