OpenAPITools / OpenAPITools/openapi-generator
[BUG][Asciidoc] Equal sign in Description converted to Unicode
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Description
Asciidoc generator converts any equal sign in Operation/Parameter description to Unicode i.e. =
Customized the Mustasche Templates to use unescapedDescription but still see same behavior in .adoc file.
We convert this .adoc file to PDF using Asciidoctor and asciidoctor has no support for Unicode. There decimal codes are supported.
openapi-generator version
5.1.0
OpenAPI declaration file content or url
{
"description": "Values with possible meanings: green=approved, yellow=pending, e.g., needs additional authentication, red=declined.",
"enum": [
"GREEN",
"YELLOW",
"RED"
],
"type": "string"
}
Generation Details
in generated adoc file it is
Values with possible meanings: green=approved, yellow=pending, e.g., needs additional authentication, red=declined.
Steps to reproduce
Run asciidoc generator with sample data and see output
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 Asciidoc generator and reproduce the issue using the sample OpenAPI declaration and its description containing equal signs. Compare the generated .adoc output with the expected decimal-code representation, and confirm that the equal signs are preserved in the generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100