Related
Recommended
Robyn Tippins

We have been receiving feedback about our API documentation and we'd love to extend this opportunity to our Developer Community to hear your views too.  It would be great to hear what you think about:

  • layout
  • content
  • any other changes we need in our API documentation

We will then combine the feedback we receive to make using the API documentation easier for our Developer Community users. 

Thank you for contributing! 

Parents

  • 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)

Comment

  • 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)

Children
No Data