$ in model description causes exception, html will not load

Question

$ in model description causes exception, html will not load

DavidBiesack opened this issue 7 years ago · 10 comments

Run the command

pretty-swag -i openapi.yaml -o /tmp/openapi.html

on the below openapi.yaml ; when viewing in the browser (Chrome on Mac OS X), the JavaScript gets an exception

Uncaught SyntaxError: Invalid or unexpected token

and the document is not rendered.

It looks like something is truncated:

                     "schema": "{\n   \"value\": \"string\"     /* Strings which follow the regular expression pattern: `-?\\d{1,15}\\.\\d{1,9}<!DOCTYPE html>

Here is the openapi.yaml:

swagger: '2.0'
info:
  title: pretty-swag-bug
  description: parse error in schema/javascript
  version: '1'
  termsOfService: Pending.
consumes:
  - application/json
produces:
  - application/json
paths:
  /:
    get:
      responses:
        '200' : 
          description: OK
          schema:
            $ref: '#/definitions/model'
definitions:
  model:
    properties:
      value: 
        description: "Strings which follow the regular expression pattern:
          `-?\\d{1,15}\\.\\d{1,9}$`
          such as 325.50 or -200.75."
        type: string

Answer 1 · 2017-11-30T16:50:59.000Z

Thanks for reporting I'll make a patch this evening.

Answer 2 · 2017-12-01T07:26:45.000Z

rolled out the patch. Check it out and let me know.

Answer 3 · 2017-12-01T14:09:26.000Z

thanks - works for this test case.

The problem still shows up when I try this on my full openapi.yaml (which I can't post here) but that may be my npm environment.

Answer 4 · 2017-12-01T16:01:07.000Z

The earlier problem was about templating that I use. Can you shrink your schema again and see if the problem is still around $ sign?

Answer 5 · 2017-12-02T03:10:39.000Z

The schema I reported here was taken from my larger openapi.yaml file. Your patch works in the small case, but fails the same way on the larger file (same problem - the description string gets clipped at the dollar sign backtick combination.) If I can carve off time, I'll try to successively trim the file down to something that still exhibits the problem

Answer 6 · 2017-12-03T03:37:17.000Z

I am able to reproduce the bug. Thanks for reporting!

Answer 7 · 2017-12-03T04:22:24.000Z

I rolled out another patch. It should address this problem for good. Let me know!

Answer 8 · 2017-12-06T16:33:41.000Z

Have you had a chance to try?

Answer 9 · 2017-12-07T23:54:13.000Z

Yes, the latest update resolves the problem in my full test case. Thanks for the patches.

Answer 10 · 2017-12-08T01:46:50.000Z

Thanks for reporting back 👍