OpenAPITools / OpenAPITools/openapi-generator
[BUG] Unexpected escaped HTML entities in documentation generated via typedoc
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Bug Report Checklist
Ref https://github.com/kubernetes-client/javascript/issues/457
Description
There's some (I think) double escaping happening in HTML docs generated by the open api generator.
openapi-generator version
4.0.3
OpenAPI declaration file content or url
https://github.com/kubernetes/kubernetes/blob/master/api/openapi-spec/swagger.json
Command line used for generation
Used the maven generator:
https://github.com/kubernetes-client/gen/blob/master/openapi/typescript.xml
Steps to reproduce
git clone https://github.com/kubernetes-client/typescript
cd typescript
npm install
npm run generate
Suggest a fix
I think it might be due to double-escaping but it requires further investigation.
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
Reproduce the issue with the openapi/typescript.xml Maven generator and the Kubernetes swagger.json declaration using the listed npm commands. Compare the generated typedoc HTML output with the source text to identify where escaping happens twice; the work is done when generated documentation displays HTML entities correctly without double escaping.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100