RE: Documentation feedback required

Robyn Tippins — Wed, 25 Jul 2018 09:56:00 GMT

Thank you very much Mitch Grant. Yes the look and feel of Swagger is great and we should make our documentation easy to navigate and use in the same way. Good point re the comments too - we should definitely bear that in mind if and when we move things. Thank you again!

RE: Documentation feedback required

Mitch Grant — Tue, 24 Jul 2018 21:59:00 GMT

Layout - It is particularly difficult to navigate as you have broken the sections across pages depending on API version. Obviously the specific version info is important but it may be able to be integrated a little better

Content - I think you have all of the content available but it is spread throughout a large number of pages

There are some really useful comments from both the HighQ team and clients. It would be good to have these incorporated back into the documentation as tips or notes rather than scrolling through comments.

A number of companies are using Swagger to display API endpoints to great advantage (screenshot below)