swagger-api / swagger-api/swagger-codegen

[html] methods are empty if -Dapis=.. -DsupportingFiles=.. -Dmodels=.. are supplied

Open
#1,875 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: HTML Feature: Documentation
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

hello if I run trunk code with -l html and -Dapis=.. -DsupportingFiles=.. -Dmodels=.. it produces empty methods section in the generated static html, just because https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/StaticHtmlGenerator.java#L94 ignores the given tag parameter. I suppose I can provide a test case (the fix is trivial for sure), but I'm afraid there is some reasoning for using ALL_OPERATIONS "" istead of the given tag value.

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 inspecting modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/StaticHtmlGenerator.java around line 94 and trace how the supplied tag parameters reach the methods section. Reproduce the HTML generation with -l html and the three -D options, then add a regression test if the existing test structure supports it. Done means the generated static HTML contains the expected methods instead of an empty section.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, java
Domain
documentation, tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.