Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiline markdown in response examples breaks table in Markdown #561

Open
dustinmoris opened this issue Mar 5, 2024 · 0 comments
Open

Comments

@dustinmoris
Copy link

dustinmoris commented Mar 5, 2024

Describe the bug

According to the OpenAPI v3 specification CommonMark may be used for the description field of a response object.

Example:

      responses:
        '201':
          description: |
            Foo bar:
              - item 1
              - item 2
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FooBar'

However, when generating docs from a specification like this then the Markdown table which describes the possible responses is broken because Markdown cells must be single line.

I think this is very similar to this issue which was already reported in the past: #211

Expected behavior

Flatten the contents of the table cells using HTML (e.g. <br>, etc).

Screenshots

image

Versions:

"widdershins": "^4.0.1"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant