Skip to content

Bug: long markdown monospace text in description in schema is not wrapped correctly #1074

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

Open
Fethbita opened this issue Feb 4, 2025 · 0 comments

Comments

@Fethbita
Copy link

Fethbita commented Feb 4, 2025

As explained in the title. Must be switched to multi line description.

Image

Same happens in "schema-style=table" but if zoomed in, the descriptions completely disappear (not sure if this is a bug or intended behavior):

Image

It can be reproduced with the following schema:

{
    "openapi": "3.0.0",
    "paths": {
      "/": {
        "post": {
          "requestBody": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "veryLongNameForAFieldLongLongLong": {
                      "type": "object",
                      "properties": {
                        "text": {
                          "type": "string",
                          "description": "Markdown text with a very long monospace text `veryLongNameForAFieldLongLongLongLongLongLongLongLong`."
                        }
                      }
                    },
                    "shortName": {
                      "type": "object",
                      "properties": {
                        "text": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }

And html:

<rapi-doc
    spec-url="../../_/static/test.json"
    render-style="view"
    theme="light"
>
</rapi-doc>
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