HTML clients have Apache 2.0 license URL as default
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 64/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- java
- Domain
- documentation
Research direction
Start with src/main/java/io/swagger/codegen/v3/generators/html/StaticHtmlCodegen.java at line 58 and StaticHtml2Codegen.java at line 71, then inspect how each generator renders license information. Confirm the generated HTML omits license information when the OpenAPI document has no explicit license, while preserving explicitly supplied license details.
Written by the indexing model from the issue text.
Description
Relates to #140
It looks like the "html" and "html2" client generators use the Apache 2.0 license URL as default if the OpenAPI document does not specify a license:
https://github.com/swagger-api/swagger-codegen-generators/blob/e34685e086e0372a205563768ee80a89ec5cae3d/src/main/java/io/swagger/codegen/v3/generators/html/StaticHtmlCodegen.java#L58
https://github.com/swagger-api/swagger-codegen-generators/blob/e34685e086e0372a205563768ee80a89ec5cae3d/src/main/java/io/swagger/codegen/v3/generators/html/StaticHtml2Codegen.java#L71
This is problematic because it is not clear in the generated HTML documentation what this license applies to, and maybe the developer who publishes the documentation for their API does not want to provide the documentation under that license.
It would be best if this default license URL was omitted, and license information was only shown in case a license is explicitly specified.
- Dominant language
- Mustache
- Stars
- 299
- Forks
- 439
- PR merge metrics
- No merged PRs in 30d
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.
More from swagger-api/swagger-codegen-generators
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
Python generated code: Delete API Requests can be blocked in API Gateways when sends empty body Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
swagger-api/swagger-codegen-generators#1370 · 3 comments · 1 reaction ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
All issues in swagger-api/swagger-codegen-generators
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
bug triage:deciding
Difficulty 1/5 Under an hour Newbie friendliness 88/100
open-telemetry/otel-arrow#4132 ·
-
Ecosystem: ClawMetry — the Qwen Code reader is now free and open source (follow-up to #9294 / #9338) Opencategory/integration priority/P3 scope/documentation status/ready-for-human type/feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100