OpenAPITools / OpenAPITools/openapi-generator
[BUG] how to avoid generator to escape the characters for the description of parameters?
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Hi, how to avoid generator to escape the characters for the description of parameters?
for example, I have a description in yaml spec file, like this
'Should be used only if `pageNo=1`.'
the generated the comments for that parameter is
'Should be used only if `pageNo=1`'
The character ` and = are escaped to html character code. Is there anyway to avoid this behavior?
I am using typescript-axios generator
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 typescript-axios generator's handling of parameter descriptions and reproduce the YAML example from the issue. Trace where backticks and equals signs become HTML entities, then verify that generated parameter comments preserve the intended characters without breaking other descriptions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100