2

In Swagger/OpenAPI 2, I used Markdown tables, something like this:

| A | B | C |
|---|---|---|
| T | F | F |
| T | F | T |

But after upgrading to OpenAPI 3, where Commonmark is used instead of Github-flavoured Markdown, it seems that the tables aren't supported anymore. Are there any alternatives to this, or alternatives to displaying data in a tabular form?

sle
  • 165
  • 1
  • 1
  • 8
  • The CommonMark spec does not support tables at this time, and it's unknown whether it will in the future. – Colin O'Dell Nov 07 '17 at 23:08
  • @ColinO'Dell Indeed, so I was wondering what sorts of other alternatives there are to displaying data in table-like forms. I tried plain-text tables, but those didn't format quite that well unfortunately. – sle Nov 08 '17 at 14:40
  • Until tables are standardized in CommonMark I would suggest just following the GitHub conventions. That should provide you with the most comprehensive tooling support. – Darrel Miller Nov 12 '17 at 22:09

1 Answers1

1

CommonMark supports html blocks, so you can embed html tables in your OpenAPI 3.0.x descriptions etc, at the expense of some readability.

MikeRalphson
  • 2,247
  • 2
  • 15
  • 16