danielgtaylor / aglio

An API Blueprint renderer with theme support that outputs static HTML
4.75k stars 480 forks source link

Hyphens on example of string parameters cannot be escaped. #342

Closed djansyle closed 5 years ago

djansyle commented 6 years ago

Consider this situation.

This is how it's being rendered. screen shot 2017-11-16 at 9 28 46 am

It only take the words after the first hyphen.

JoeNg93 commented 5 years ago

Hi, not sure if you found the solution already but enclosing the value inside `` will work, example:

lastId: `d26e615d-7de0-44e6-83e0-7b6937ddef33` (optional, string) - about lastId

Gasol commented 5 years ago

According to MSON spec, The hyphens is a reserved character, Please use backtick to escape the whole value.

Related issues: https://github.com/apiaryio/api-blueprint/issues/224 https://github.com/apiaryio/api-blueprint/issues/248 https://github.com/apiaryio/drafter/issues/697#issuecomment-491337276