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. Support swagger enum query parameter

    I have a string enum query parameter in my swagger configuration, apiary shows the parameter details as "Possible values: [object Object] , [object Object] ." instead of my enum values. And in console view it would be nice to have a dropdown with enum values instead of a free-form text.

    12 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…)
    • I don't use Github. How can I retrieve a current version of .apib file?

      That's it. I saw there's a client that does that but I don't want to use it either. How can I retrieve the current API file over HTTP? Thanks!

      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…)
      • Match on request headers

        I was just thinking of mocking different responses, and one idea was to just throw in a Prefer header: https://tools.ietf.org/html/draft-snell-http-prefer-15

        GET /
        > Prefer: status=200
        < 200

        GET /
        > Prefer: status=404
        < 404

        If not Prefer request header was sent, or not match was found, just take the first mocked response.

        Wdyt?
        Could maybe be an extension to your latest addition "multiple actions on a single resource"

        PS: I guess for now, the only way to do this is add a query param &_preferStatus=404 ?

        27 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  ·  Jakub KorálJakub Korál responded

          You can now force Apiary mock server to return a particular Response of your choice.

          Perform a request with the header “Preferred:status=304” (without the quotes) and the finest Response with status code 304 (if defined) is returned.

        • add an option for word wrap in the editor

          Add an option to turn on/off word wrap text in the editor

          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…)
            1 comment  ·  Admin →
          • teach `drafter` to generate JSON schema into a text file.

            The JSON schema is available in the interactive documentation. I would like the same information in a format suitable for seeding a JSON validator.

            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…)
            • Create Basic Turorials

              Such as

              Creating an Endpoints Backend Project
              Writing the API: A Simple GET

              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…)
              • Bug: Missing icons on https://app.apiary.io/

                The People and Settings icons do not show up in Firefox 38.

                Screenshot here: http://imgur.com/WafCach

                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…)
                • Allow custom code examples

                  We have API libraries in a few languages, and would like to have the code examples use those libraries instead of generic REST calls.

                  2 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…)
                  • 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…)
                      completed  ·  Lukas LinhartLukas Linhart responded

                      As of now, you can just use

                      We are going to iterate on better way as part of our new blueprint format.

                    • Enable anchors in new documentation format

                      The new documentation format looks great. I would love to be able to share links to specific parts of the page, whether it's an API endpoint or one of the headers in the introduction or a group section.

                      21 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

                        Links are now generated for groups and resources. as well as heading in the introduction section.

                      • Support path parameters

                        Please support path parameters and let the users choose what values to test with.

                        37 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…)
                        • Mass code folding in Blueprint editor

                          I love the code folding, thanks!

                          It would be even better if I could collapse/expand all of them at once, or have an option to get them folded as default in Settings page.

                          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…)
                          • Printing Documentation

                            Can i print my documentation

                            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…)
                            • Fix problem with GitHub login

                              I am getting an error when trying to connect a project to GitHub (error details below). Seems like GH have made a breaking change in their API https://developer.github.com/changes/2015-06-10-breaking-changes-to-organization-permissions-coming-on-june-24/#migration-period.

                              The error:
                              Loading failed. Message from GitHub: {"message":"You need at least read:org scope or user scope to list your organizations.","documentation_url":"https://developer.github.com/v3/orgs/#list-your-organizations"}

                              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 →
                                completed  ·  Lukas LinhartLukas Linhart responded

                                See solution below; we are looking into our codebase to ask for proper permission immediately instead of requiring users to do manual revoke.

                              • 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…)
                                • Support application/x-www-form-urlencoded input parameters

                                  I want to describe method that accepts form-urlencoded POST parameters.
                                  I'd like to specify them somehow, so they will be displayed inside "In" section of method description.

                                  Might be it's possible already, but i didn't find how.

                                  59 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…)
                                  • Allow multiple response code definitions for the same response code and content-type

                                    In my use case, for a given request, there are a variety of possible responses of the same response code. For example...

                                    # GET /api/v1/resource

                                    + Response 200

                                    + Headers

                                    Content-Type:application/json

                                    + Body

                                    { <unique combination of attributes> }

                                    + Response 200

                                    + Headers

                                    Content-Type:application/json

                                    + Body

                                    { <unique combination of attributes> }

                                    Currently, this gives an error "Response payload `200` already defined for `GET` method".

                                    This seems like it would not be an uncommon requirement. Is there already a method to do this that I am missing?

                                    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…)
                                    • Make apiary work locally (offline) so that it can be used in tests

                                      It'd be awesome if Apiary can work locally. I want my tests not to depend on the internet. I want them to use the same API Mock that I use for the "real" app (while the API is being developed). It'd be great if I could make apiary work locally.

                                      That way
                                      1) Server documents a change to make
                                      2) Changing blueprint for document changes mock
                                      3) Tests go against new mocks
                                      4) Tests of the client fails.

                                      24 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 →
                                        completed  ·  Lukas LinhartLukas Linhart responded

                                        Dredd is now the testing tool for verifying your blueprint. For announcement, please see those blog posts: http://blog.apiary.io/2013/10/10/No-more-outdated-API-documentation/ and http://blog.apiary.io/2013/10/17/How-to-test-api-with-api-blueprint-and-dredd/ .

                                        For particular features and workflow improvements, everyone is more then welcome in Dredd’s issue tracker: https://github.com/apiaryio/dredd

                                        Dredd is open-source, so feel free to look around!

                                        Reporting & tigher integration with Apiary is going to be public very soon.

                                      • Non-route sidebar links

                                        I'd like to have sections in my api describing overall API behavior and have it be linkable in the sidebar. For example, Stripe's API Docs have sections on Authentication, Errors, etc: https://stripe.com/docs/api. Currently I can use the Introduction section for this, but none of the child headlines are linkable.

                                        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…)
                                          1 comment  ·  Admin →
                                        • syntax highlighter package for Atom

                                          Simple enough, here is a link to the documentation: https://atom.io/docs/v0.186.0/creating-a-package

                                          I'm sure you could re-use your stuff from Sublime

                                          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…)
                                            1 comment  ·  Admin →
                                          ← Previous 1 3 4 5
                                          • Don't see your idea?

                                          General

                                          Feedback and Knowledge Base