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. Simultaneous Edit

    Allow a team to collaboratively build out an API spec by editing the document simultaneously, as in Google Docs.

    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…)
    • Getting Started Walkthrough

      A basic getting started walkthough with a demo API.
      There are items on dialogs that are not explained anywhere, this would be a great place to explain them as well as give users a basic idea of how to use the system.

      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…)
      • Add example of an API with two resources in it.

        Suggest you have an example of an API with two resources in it. It just wasn't clear to me how to do it without validation errors. Sure, it's simple, but when you don't know it yet...

        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…)
        • Password protect documentation

          Our API contains some of our IP and we want to allow only validated clients access to the portal. Programmatic user management would be beneficial.

          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…)
          • Parse external references in swagger.yaml

            Would be great if references to other files were parsed and picked up by Apiary.

            So, if there is the following reference defined in the swagger.yaml:
            $ref: 'users.yaml#/User'

            It should look for the 'User' definition in 'users.yaml' file in the same directory as 'swagger.yaml'.

            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…)
            • Handling multiple actions on a single resource for Swagger

              Looks like you do not support Prefer header for API managed with Swagger.

              Could that be implemented?

              – Timur

              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…)
              • Better support touchscreen PC devices on Google Chrome

                The problem is that on touchscreen device with Windows 10 + Google Chrome (all versions I have tried) I can't select and copy any text from my API documentation.

                When I click on some text and move the mouse pointer to select a text instead marking a text web panels starts moving as though I touch and swipe by fingers - so I can't select any text.

                It is very, very frustrating. Always when I want to copy something I have to open other web browser.

                In Firefox, Opera and Edge it is working correctly.
                In Chrome it works only…

                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…)
                • Colorize code blocks with a declared language

                  When specifying a language, syntax highlighting is not done on the example code. This would be optimal for code examples in the human section of API documentation.

                  Example:

                  ```ruby
                  require 'redcarpet'
                  markdown = Redcarpet.new("Hello World!")
                  puts markdown.to_html
                  ```

                  Github support: https://help.github.com/articles/creating-and-highlighting-code-blocks/

                  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…)
                  • Fix word wrap styling for fields with dashes in them

                    When using an API format like jsonapi.org, multiple words in field names are separated by dashes (hyphens) not underscores. When using dashes in field names inside MSON descriptions, the generated tables word wrap your field name and it looks pretty bad.

                    e.g.: https://cloud.githubusercontent.com/assets/221693/17196153/492871e2-5417-11e6-8491-89b7a5adfb59.png

                    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…)
                    • Memory leak on editor

                      I'm running Apiary on Chrome 51.0.2704.63 beta (64-bit) @ Ubuntu 14.04 , and I'm getting a large memory usage, slowness when using the preview Example.

                      My Chrome running only the Apiary editor is using about 1GB of memory in a small API with a few actions.

                      8 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 Show Deleted Github Branches

                        The branch drop down in the editor shows all branches that have ever been created, even after they have been deleted from Github.

                        It should show only the existing branches.

                        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…)
                        • MSON: Render enum options

                          Let

                          + Request (application/json)
                          ____+ Attributes (object)
                          ________+ status (enum)
                          ____________+ created
                          ____________+ processing
                          ____________+ complete

                          Show enum options in rendered request attributes list.

                          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…)
                            1 comment  ·  Admin →
                          • MSON Bug: multiply nested arrays

                            In my blueprint, there is an object specified as:

                            + Attributes (object)
                            + id: 1 (number)
                            + items (array)
                            + item (object)
                            + id: 1 (number)
                            + bundle (object)
                            + products (array)
                            + product (object)
                            + id: 1 (number)

                            When I use this object in a response, section products gets rendered as an empty array.

                            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…)
                            • MSON Bug: Rendering of (array[number])

                              In my blueprint in an action section I define a request:

                              + Request (application/json)
                              + Attributes (object)
                              + orderIds: 1 (array[number], required)

                              In case of "array" for orderIds - values get rendered as strings - not what I want. If I specify number as array members type the array gets rendered as empty.

                              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…)
                                1 comment  ·  Admin →
                              • Allow editors (not just owner) to link with their repository

                                My colleague created API for our common project. The project is being developed on GitHub and I was added as an editor to Apiary.

                                The thing is, he is not the owner of the GitHub repository, I am. And I do not have permissions to link the API with the repository.

                                "You do not have rights to access this page, sorry. You are not owner of this API."

                                Are you planning on changing these permissions or is there a way to work around this?

                                Maybe I am doing something wrong.

                                Best wishes
                                Filip

                                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…)
                                  under review  ·  1 comment  ·  Admin →
                                • Enable Run in Postman

                                  It would be pretty slick if you could enable a "Run In Postman" button: https://www.getpostman.com/integrations/run-button?source=chrome_app The Apiary runner is decent, but many people would probably like to more easily call the services in Postman.

                                  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…)
                                  • Add a "Scroll to source" feature

                                    So when I click on a line in the preview, the editor will scroll to the matching line in the editor. The other way will also help (scroll to preview)

                                    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…)
                                      under review  ·  1 comment  ·  Admin →
                                    • Render data structures separately

                                      Sometimes it is necessary to lookup an entity to learn about it. In example, MSON supports additional information like "only three elements are expected in this array" or "we expect one of these values".

                                      To find such documentation, a separate page in the docs would be useful, only describing the entity and maybe referencing where the entity is being used (the actual endpoints).

                                      That way additional documentation can be viewed without opening the Markdown source.

                                      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…)
                                      • Support inline document linking when using custom embed.js

                                        The current reference for how to do internal linking does not support corporate use when using custom.js. (see: http://docs.internallinking.apiary.io/#) when you follow the recommendation for internal linking that is as follows, you always are redirected off your domain back to https://jsapi.apiary.io/apis which is not what we want. We want to stay on our custom branded site. External linking works, why can't I specify the full external link to the branded site anchor and have it work?

                                        Internal inline link – 1.1

                                        With manually defined HTML anchor e.g. <a name="my-anchor-2"></a> where a Markdown-formatted description is expected.

                                        Try it ([Try it](#my-anchor-2))

                                        13 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…)
                                          planned  ·  4 comments  ·  Admin →
                                        • Add GitLab support, similar to GitHub

                                          GitLab ist a cloud- or self-hosted code colaboration platform.

                                          35 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…)
                                          ← Previous 1 3 4 5 8 9
                                          • Don't see your idea?

                                          General

                                          Feedback and Knowledge Base