swagger-api / swagger-api/swagger-codegen
appName and appDescription from config file json are ignored for html2 output
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 trying to use the docker container to generate html2 API docs, but when I specify a config with -c the appName and appDescription options within it are ignored by the template. However, infoEmail and infoUrl are working as expected.
Swagger-codegen version
docker image: swaggerapi/swagger-codegen-cli
Swagger declaration file content or url
No issue with the swagger content
My swagger-options.json:
{
"appName": "payments service",
"appDescription": "payments service combines fop and cardstore functionality"
}
Command line used for generation
docker run --rm -v ~/repos/swagger-codegen/modules/swagger-codegen/src/main/resources/htmlDocs2:/template --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli generate \
-i http://host.docker.internal:8080/v2/api-docs \
-c /local/swagger-options.json \
-l html2 \
-t /template \
-o /local/docs/html2
Steps to reproduce
Run swagger-codegen-cli with html2 language and a config file as done above. This happens whether or not I use a custom template folder.
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 html2 template under modules/swagger-codegen/src/main/resources/htmlDocs2 and reproduce the issue using the shown swagger-codegen-cli Docker command and swagger-options.json. Trace how the html2 generator handles appName and appDescription compared with infoEmail and infoUrl; done means both configured values appear in the generated HTML.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100