Describe the bug Example responses shows line breaks as <code cla

Hi <a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="

Hi, I've created PR <a class="issue-link js-issue-link" data-error-text="Failed to loa

[BUG] example response not showing line breaks correctly about express-jsdoc-swagger HOT 3 CLOSED

brikev commented on June 5, 2024 1

[BUG] example response not showing line breaks correctly

from express-jsdoc-swagger.

Comments (3)

kevinccbsg commented on June 5, 2024 2

Hi @Azraelless and @Brenndoerfer,

As @Brenndoerfer said we are sending the info as the OpenAPI says so we think there is a problem related to the swagger-ui library. We could only reproduce this by adding the yaml in the https://editor.swagger.io/ website If you use the page that this library renders you can see the example in the right format like in this screenshot.

We created an issue in the swagger-ui library swagger-api/swagger-ui#6595 to track this or see if there is another solution 🤔

from express-jsdoc-swagger.

Brenndoerfer commented on June 5, 2024

Experiencing the same.

I've looked at the parsePaths output but both look the same. Could that be an issue with swagger-ui-express rendering?

"requestBody": {
        "content": {
          "application/json": {
            "schema": {
              "type": "object"
            },
            "examples": {
              "example1": {
                "summary": "example payload",
                "value": "{\n  \"c\": \"Bury The Light\",\n  \"artist\": \"Casey Edwards ft. Victor Borba\",\n  \"year\": 2020\n}"
              }
            }
          }
        },

 "responses": {
        "200": {
          "description": "Success response",
          "content": {
            "application/json": {
              "schema": {
                "type": "object"
              },
              "examples": {
                "example1": {
                  "summary": "example success response",
                  "value": "{\n  \"claim_email\": \"[email protected]\"\n  \"claim_expire_ts\": \"TODO\",\n}"
                }
              }
            }
          }
        }