OpenAPITools / OpenAPITools/openapi-generator
(`value1` and `value2`) in parameters:description leads to error in Confluence
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Description
I have a value of
(`value1` and `value2`)
in one of my descriptions in a parameter. Copying the resulting confluence markup into Confluence (Version 6.8.2) leads to a server error.
In Confluence wiki it results to:
(`spVon` und `spBis`)
It works if I put a space after and before the parenthesis. Or if I escape the parenthesis.
openapi-generator version
3.3.2
OpenAPI declaration file content or url
generate -g cwiki -i <file.yaml> -o
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 cwiki generator using the supplied YAML parameter description and the generate -g cwiki command, then reproduce the failure in Confluence 6.8.2. Compare the generated markup with the working spaced or escaped variants; done means the original parenthesized description can be copied into Confluence without a server error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100