General

I suggest you ...

You've used all your votes and won't be able to post a new idea, but you can still search and comment on existing ideas.

There are two ways to get more votes:

  • When an admin closes an idea you've voted on, you'll get your votes back from that idea.
  • You can remove your votes from an open idea you support.
  • To see ideas you have already voted on, select the "My feedback" filter and select "My open ideas".
(thinking…)

Enter your idea and we'll search to see if someone has already suggested it.

If a similar idea already exists, you can support and comment on it.

If it doesn't exist, you can post your idea so others can support it.

Enter your idea and we'll search to see if someone has already suggested it.

  1. Allow multiple APIs per user account

    Currently, only a single API can be described by a user. Allow multiple APIs & documentations per user.

    54 votes
    Vote
    Sign in
    Check!
    (thinking…)
    Reset
    or sign in with
    • facebook
    • google
      Password icon
      I agree to the terms of service
      Signed in as (Sign out)
      You have left! (?) (thinking…)
    • Share one API among several users

      Allow multiple users to collaborate on the same API inside Apiary (without the use of Github)

      90 votes
      Vote
      Sign in
      Check!
      (thinking…)
      Reset
      or sign in with
      • facebook
      • google
        Password icon
        I agree to the terms of service
        Signed in as (Sign out)
        You have left! (?) (thinking…)
        completed  ·  Lukas LinhartLukas Linhart responded

        Sharing is now available for free and for everyone. Please go to people tab in your blueprint.

        Support for organisations is now also completed. Please let us know if you want to try it.

      • Customize Documentation Visual Style

        Offer the ability to customize documentation visual style, likely using custom CSS you can inject into the documentation.

        10 votes
        Vote
        Sign in
        Check!
        (thinking…)
        Reset
        or sign in with
        • facebook
        • google
          Password icon
          I agree to the terms of service
          Signed in as (Sign out)
          You have left! (?) (thinking…)
          completed  ·  Lukas LinhartLukas Linhart responded

          You can now embed documentation into your own pages and customise it completely. We are offering this as part of our enterprise plan. Please contact support@apiary.io if you want to try it out.

        • Support GitHub 2-way Sync

          Currently, GitHub integration only downloads new blueprints from GitHub repository when a push occurs. Editing the file in Apiary web editor is no longer supported when linked to GitHub.

          It would be great if editing the file on the web resulted into a commit back into the GitHub repository.

          9 votes
          Vote
          Sign in
          Check!
          (thinking…)
          Reset
          or sign in with
          • facebook
          • google
            Password icon
            I agree to the terms of service
            Signed in as (Sign out)
            You have left! (?) (thinking…)
            completed  ·  Lukas LinhartLukas Linhart responded

            If you have your account connected with github repository, editor save now results in repository commit.

          • Allow multiple response code definitions under a verb section

            Perhaps I just can't tell from your example, but I can't see to define more than one response type under each verb section. For example, for a POST operation, I could return a 200, 201, 404, 409, or 500 status. Would be nice to just add another line for each

            < 200
            < Content-Type: application/json
            { .. details .. }
            < 404
            < Content-Type: application/json
            { .. details .. }
            < 409
            < Content-Type: application/json
            { .. details .. }

            25 votes
            Vote
            Sign in
            Check!
            (thinking…)
            Reset
            or sign in with
            • facebook
            • google
              Password icon
              I agree to the terms of service
              Signed in as (Sign out)
              You have left! (?) (thinking…)
            • Hide documentation from public

              I'd like to hide my API page from users without access using either a simple password or something more complex.

              This is important as our API is not yet public and I don't want people to try it until it is ready.

              36 votes
              Vote
              Sign in
              Check!
              (thinking…)
              Reset
              or sign in with
              • facebook
              • google
                Password icon
                I agree to the terms of service
                Signed in as (Sign out)
                You have left! (?) (thinking…)
              • code choices: jQuery's $.ajax

                The raw javascript example is nice but I think using jQuery will make it easier to understand, like how you used the request module in the Node example.

                1 vote
                Vote
                Sign in
                Check!
                (thinking…)
                Reset
                or sign in with
                • facebook
                • google
                  Password icon
                  I agree to the terms of service
                  Signed in as (Sign out)
                  You have left! (?) (thinking…)
                • Blueprint syntax is very brittle, confusing and failing

                  With bueprint file http://honzakral.com/apiary.apib the Documentation tab is all wrong, is uses the title of the second API call as overall title, doesn't even display the overall title or the title for the first API call.

                  So far no amount of fiddling helped, no idea what's going wrong. The syntax highlighting in the browser is slightly off: the --- something --- is sometimes grey, sometimes white.

                  It's confusing and frustrating

                  1 vote
                  Vote
                  Sign in
                  Check!
                  (thinking…)
                  Reset
                  or sign in with
                  • facebook
                  • google
                    Password icon
                    I agree to the terms of service
                    Signed in as (Sign out)
                    You have left! (?) (thinking…)
                    completed  ·  1 comment  ·  Admin →
                  • commas in JSON

                    from this blueprint:
                    --- List all availible categories ---
                    GET /api/listbliss/categories/
                    < 200
                    < Content-Type: application/json
                    [
                    { "id": 123, "title": "Some category"}
                    ]

                    it expects this JSON:
                    [, { "id": 123, "title": "Some category"},]

                    1 vote
                    Vote
                    Sign in
                    Check!
                    (thinking…)
                    Reset
                    or sign in with
                    • facebook
                    • google
                      Password icon
                      I agree to the terms of service
                      Signed in as (Sign out)
                      You have left! (?) (thinking…)
                      completed  ·  1 comment  ·  Admin →
                    • Wrong author on git commits

                      When committing to github repo in organization, use the logged-in user as Author, not the organization

                      1 vote
                      Vote
                      Sign in
                      Check!
                      (thinking…)
                      Reset
                      or sign in with
                      • facebook
                      • google
                        Password icon
                        I agree to the terms of service
                        Signed in as (Sign out)
                        You have left! (?) (thinking…)
                      • API ignores bold formatting

                        When text is formatted by "__", API CSS styles it as font-weight normal.

                        docs.css?v=4 on line 369:
                        ---------------------------------
                        #leftColumn > div.details strong, section.resource > .details strong, hgroup.chapter > .details strong {
                        font-weight: normal;
                        }

                        1 vote
                        Vote
                        Sign in
                        Check!
                        (thinking…)
                        Reset
                        or sign in with
                        • facebook
                        • google
                          Password icon
                          I agree to the terms of service
                          Signed in as (Sign out)
                          You have left! (?) (thinking…)
                          1 comment  ·  Admin →
                        • Invite to organisation workflow has poor UX

                          When I'm invited to join an organisation, it would be great to be able to accept it directly from the notification e-mail. Currently there is just plain text:

                          > It's easy to accept or decline this invitation. Simply sign-in, go to your Account and click the appropriate link.

                          Well, even with this instructions it took me a while an I need help from my colleague to find, where exactly should I accept the invitation - (Apiary.io > Sign-in > click My Account > find it somewhere on the bottom of the page).

                          1 vote
                          Vote
                          Sign in
                          Check!
                          (thinking…)
                          Reset
                          or sign in with
                          • facebook
                          • google
                            Password icon
                            I agree to the terms of service
                            Signed in as (Sign out)
                            You have left! (?) (thinking…)
                            completed  ·  Lukas LinhartLukas Linhart responded

                            We have revamped our invitation workflow. Please let us know how it works for you,

                          • 3 votes
                            Vote
                            Sign in
                            Check!
                            (thinking…)
                            Reset
                            or sign in with
                            • facebook
                            • google
                              Password icon
                              I agree to the terms of service
                              Signed in as (Sign out)
                              You have left! (?) (thinking…)
                            • ensure that prior to linking a Github repo, you check for overwriting existing Apiary blueprint.

                              This is to prevent a human error and slight painful experience. When working with two seperate blueprints, i accidentally linked the second one to the same Github which ended up overwriting the first blueprint document.

                              I realized quickly that you can't have two Blueprints syncing in the same Github.

                              Could you fix this so that perhaps it uses a different filename or would suggest an error or warning that you are linking to a repo with an existing Blueprint document which will be overwritten.

                              6 votes
                              Vote
                              Sign in
                              Check!
                              (thinking…)
                              Reset
                              or sign in with
                              • facebook
                              • google
                                Password icon
                                I agree to the terms of service
                                Signed in as (Sign out)
                                You have left! (?) (thinking…)
                                completed  ·  Lukas LinhartLukas Linhart responded

                                If blueprint is present in the repository, You can now choose whether to overwrite the version in Apiary or to transfer the Apiary version into your github repository, overwriting the file there.

                              • Provide admin screen for blueprints of the organization

                                I'm using the enterprise feature of "Organizations": collections of users and blueprints. The existing "Manage organizations admins and members" panel (for managing membership) is useful, if a bit rudimentary, but I see nothing analogous for managing the blueprints of the organization.

                                I'd like a table, with
                                - blueprint title
                                - blueprint domain
                                - user name of creator
                                - user name of last editor
                                - a link directly to the blueprint (actually, it's specifically Settings I want)

                                5 votes
                                Vote
                                Sign in
                                Check!
                                (thinking…)
                                Reset
                                or sign in with
                                • facebook
                                • google
                                  Password icon
                                  I agree to the terms of service
                                  Signed in as (Sign out)
                                  You have left! (?) (thinking…)
                                  completed  ·  Lukas LinhartLukas Linhart responded

                                  We’ve deployed our redesigned team page. If you go manage it via link under settings, these is a new “API” link on the top of the page that should provide you with what you need.

                                • Move ’Feedback & Support’ Bookmark

                                  ‘Feedback & Support’ bookmark that is glued to the right side of the screen overlays the scrollbar of the block with API description and sometimes that doesn't allow to grab the scroll and drag it.
                                  Not very much of a problem, but still, placement of the bookmark might be good to reconsider.

                                  7 votes
                                  Vote
                                  Sign in
                                  Check!
                                  (thinking…)
                                  Reset
                                  or sign in with
                                  • facebook
                                  • google
                                    Password icon
                                    I agree to the terms of service
                                    Signed in as (Sign out)
                                    You have left! (?) (thinking…)
                                    completed  ·  Lukas LinhartLukas Linhart responded

                                    Feedback & Support button has been removed completely. Please use “Help” link on top of the page to reach support now.

                                  • Reference Markdown on http://apiary.io/blueprint

                                    I felt stupid for this but... I just spent several minutes trying to find the Markdown link link in your documentation(I couldn't remember what it was called). I finally remembered that it's embedded in the Sample API. On http://apiary.io/blueprint it's there in the Sample API on the left, but I wasn't looking there... I was looking in the actual Blueprint documentation on the right side.

                                    1 vote
                                    Vote
                                    Sign in
                                    Check!
                                    (thinking…)
                                    Reset
                                    or sign in with
                                    • facebook
                                    • google
                                      Password icon
                                      I agree to the terms of service
                                      Signed in as (Sign out)
                                      You have left! (?) (thinking…)
                                    • Fold/Unfold Long Example Code

                                      I have some responses which can be 100+ lines of JSON. Is there any plan to implement a collapse-able example request/response the code is greater than n lines of text?

                                      1 vote
                                      Vote
                                      Sign in
                                      Check!
                                      (thinking…)
                                      Reset
                                      or sign in with
                                      • facebook
                                      • google
                                        Password icon
                                        I agree to the terms of service
                                        Signed in as (Sign out)
                                        You have left! (?) (thinking…)
                                      • Send an invitation/registration link to anyone through People > Viewers

                                        Be able to do this: Even if the email address is of a user, who is not yet a registered user in Apiary, invite him and after registration is complete, handle the rest of "privileges for viewer" things.

                                        4 votes
                                        Vote
                                        Sign in
                                        Check!
                                        (thinking…)
                                        Reset
                                        or sign in with
                                        • facebook
                                        • google
                                          Password icon
                                          I agree to the terms of service
                                          Signed in as (Sign out)
                                          You have left! (?) (thinking…)
                                        • Create Widgets/Snippets Embeddable into Documentation Portal

                                          Sometimes the raw API Reference is not enough in terms of a developer portal. You want to create your own set of help pages and structure it as you see fit - but you'd still like to use Apiary documentation to illustrate specific API calls, complete with code examples, interactive debugger etc.

                                          7 votes
                                          Vote
                                          Sign in
                                          Check!
                                          (thinking…)
                                          Reset
                                          or sign in with
                                          • facebook
                                          • google
                                            Password icon
                                            I agree to the terms of service
                                            Signed in as (Sign out)
                                            You have left! (?) (thinking…)
                                          • Don't see your idea?

                                          General

                                          Feedback and Knowledge Base