OpenAPITools / OpenAPITools/openapi-generator
[BUG] [python] [python-pydantic-v1] generator template malformats markdown in description sections
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Bug Report Checklist
- Have you provided a full/minimal spec to reproduce the issue?
- Have you validated the input using an OpenAPI validator (example)?
- Have you tested with the latest master to confirm the issue still exists?
- Have you searched for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
When generating documentation for the Topdesk incident API the parameter sections of the documentation is mangled up, output for incidents_id_id_archive_put is like this:
| Permission | Remark | |---------|-----------| | Operator | With 1st line incident write permission and write permission for archiving incidents; Category/Branch/Operator filters apply | | Person | No access | **NOTE**: * _PATCH_ operation can be used as well * If the incident has partial incidents they will also archived.
where it should be:
| Permission | Remark |
|---------|-----------|
| Operator | With 1st line incident write permission and write permission for unarchiving incidents; Category/Branch/Operator filters apply |
| Person | No access |
**NOTE**:
* _PATCH_ operation can be used as well
to render properly.
openapi-generator version
7.10.0
OpenAPI declaration file content or url
https://developers.topdesk.com/swagger/incident_specification_3.8.5.yaml
Generation Details
openapi-generator-cli generate -i https://developers.topdesk.com/swagger/incident_specification_3.8.5.yaml -g python
Steps to reproduce
openapi-generator-cli generate -i https://developers.topdesk.com/swagger/incident_specification_3.8.5.yaml -g python
Related issues/PRs
Suggest a fix
I think the templates miss a newline
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 by running openapi-generator-cli with the Topdesk incident specification and the python generator, then inspect the generated documentation for incidents_id_id_archive_put. Compare its parameter table and NOTE block with the expected Markdown in the issue; done means the sections render with separate table rows and list lines rather than one malformed line.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100