swagger2markup icon indicating copy to clipboard operation
swagger2markup copied to clipboard

Markup in descriptions not working

Open ghost opened this issue 7 years ago • 2 comments

The problem ist with nested tables. your example descrition above with the html tables will be transformed to the following if the description ends up beeing inside a table already.

\|===
\|Header Column

\|Content column
\|===

In nested tables "|" must be replaced by "!" instead of beeing escaped as "|".

See http://mrhaki.blogspot.com/2017/04/awesome-asciidoctor-nested-tables.html

The follwoing will work inside nested tables as it is not escape by swagger2markup, but will not work in swagger-ui as it is asciidoc not markdown.

!===
!head1!head2!
!a!b!
!===

Test case:

swagger: "2.0"
info:
  title: Simple API overview
  version: v2
tags:
- name: Tag1
  description: great tag
paths:
  /:
    get:
      tags:
      - Tag1
      operationId: listVersionsv2
      summary: List API versions
      produces:
      - application/json
      responses:
        "200":
          description: |
            Multiple status values can be provided with comma seperated strings
            This a list
    
              * item1
              * item2
    
              - item1
              - item2
                - subitem 1
    
            This is a table
    
            <table>
              <tr><th>Header Column</th></tr>
              <tr><td>Content column</td></tr>
            </table>
            
            more tables
            
            |aa|bb|
            |--|--|
            |11|22|
            
            

Originally posted by @thomasbuengener in https://github.com/Swagger2Markup/swagger2markup/issue_comments#issuecomment-437321857

ghost avatar Nov 09 '18 12:11 ghost

@thomasbuengener hi, I check this but i'm not sure what is expected cen you add there any result or more information about this issue ? now i just localize where is problem with genereting of builder

Demmi94 avatar Dec 17 '18 12:12 Demmi94

In nested tables "|" must be replaced by "!" instead of beeing escaped as "|".

Von: Demmi94 [email protected] Gesendet: Montag, 17. Dezember 2018 13:16 An: Swagger2Markup/swagger2markup [email protected] Cc: Thomas Büngener [email protected]; Mention [email protected] Betreff: Re: [Swagger2Markup/swagger2markup] Markup in descriptions not working (#352)

@thomasbuengenerhttps://github.com/thomasbuengener hi, I check this but i'm not sure what is expected cen you add there any result or more information about this issue ? now i just localize where is problem with genereting of builder

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/Swagger2Markup/swagger2markup/issues/352#issuecomment-447824752, or mute the threadhttps://github.com/notifications/unsubscribe-auth/ACcb1UWB6t6NLksMAv_2WiosJUQcHKwEks5u54rjgaJpZM4YWdba.

ghost avatar Dec 17 '18 12:12 ghost