Uploaded image for project: 'HipChat'
  1. HipChat
  2. HCPUB-3768

Improve API Docs

This issue belongs to an archived project. You can view it, but you can't modify it. Learn more

    XMLWordPrintable

Details

    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

    Description

      Atlassian - I (mostly) love all the stuff you guys build and release, but have to say, your API documentation for HipChat is among the worst I've ever seen. Like absolutely god awful. The split links between what looks like was originally a Confluence page, and the v2 docs, and the cyclical references between each - where each page just refers you back to the previous one - is intensely frustrating.

       

      Case in point - searching around all your API docs: try and find the domain for the REST API for where to send requests to. Seriously, please take 5 minutes and try to find it. There are references to authentication, tokens, endpoints, rate limits, etc. - but nowhere is it documented what freaking domain to send a request to.

       

      Your example ["sending a notification message" ](https://developer.atlassian.com/server/hipchat/about-the-hipchat-rest-api/) shows the route path /v2/etc. BUT WHAT DOMAIN DO YOU SEND THAT TO.

      ```

      POST /v2/room/{id_or_name}/notification Authorization: Bearer <token> { "color": "green", "message": "My notification message", "notify": false, "message_format": "text" }

      ```

       

      Further - all the references to HipChat Rest API in the sidebar go back to https://www.hipchat.com/docs/apiv2; then most of the links from there send you back to https://developer.atlassian.com/server/hipchat/about-the-hipchat-rest-api/

       

      Please for the love of god get your documentation lined up.

      Attachments

        Activity

          People

            Unassigned Unassigned
            600f3349cb62 Jon Hartman
            Archiver:
            mandreacchio Michael Andreacchio

            Dates

              Created:
              Updated:
              Resolved:
              Archived: