symbol-docs icon indicating copy to clipboard operation
symbol-docs copied to clipboard

Improve rendering of REST docs

Open segfaultxavi opened this issue 4 years ago • 3 comments

I'm not used to REST API docs, so maybe it's just me, but I find the docs hard to navigate. Specially when there's Any of fields with lots of options. It might be worth trying to find a different template or renderer for the OpenAPI spec because other people has complained already.

segfaultxavi avatar Feb 17 '21 07:02 segfaultxavi

Glad to know it's not just me! Heck - even an alternate rendering that doesn't collapse content would help.. I know it would be cluttered, but at least nothing would be hidden by default.

orisdorch avatar Nov 05 '21 13:11 orisdorch

I feel you, I feel you... we'll get to this eventually 😁

segfaultxavi avatar Nov 05 '21 13:11 segfaultxavi

Another openapi https://github.com/symbol/statistics-service/pull/75 to improve the doc style

fboucquez avatar Nov 05 '21 14:11 fboucquez