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. indicate for API life cycle: Work-in-process, Beta, Production, Deprecated, RIP

    each end point might be in different state in the life cycle.
    I would like to be bale to indicate whether the end point is in:
    work-in-progress
    Beta
    Production
    deprecated
    or RIP

    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…)
      under review  ·  Lukas LinhartLukas Linhart responded

      We’ve thought about lifecycle along the lines of software versioning, but this is a fair point.

    • JSON-RPC Support

      It would be nice if you supported overloading the same URI for JSON-RPC and other RPC based APIs. Then allow the action to define the json-rpc method. At the moment when I provide multiple actions with the same verb (i.e. POST) to the same resource the editor give a warning the console will only return the Response for the first defined action.

      You could possibly accomplish this by adding another META tag in the header i.e.:

      FORMAT: 1A
      HOST: https://api.qwasi.com
      PROTOCOL: JSON-RPC

      Then the parser would then know to allow overloads of resources (multiple resources with same URI).

      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…)
        under review  ·  Lukas LinhartLukas Linhart responded

        The blueprint is now strongly biast towards request-response usage pattern. However, we are researching a version where protocol would be abstracted away, making JSON-RPC support possible. I cannot give any ETA for this, though.

      • Support spell checking through a commercially available dictionary, such as Merriam-Webster.

        Support spell checking through a commercially available dictionary, such as Merriam-Webster. Allow highlighting of the text to be spell checked so that it does not spell check the code part.

        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…)
          under review  ·  Lukas LinhartLukas Linhart responded

          Thanks for your feedback. I’ll leave this idea open to see what the interest in such feature is.

        • simple conversion tool to convert from google protobuff to native apiary

          It would be beneficial to support a few "standard" api DSL languages such as google protoBuff

          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…)
          • Code completion when writing blueprints

            I keep finding myself hitting ctrl+space expecting to get a code completion dropdown in the context I am in.

            e.g. providing a dropdown of different options after `+` symbol

            While the parser has a pretty good idea of what is allowed where, I would think it would be easy enough to get some basic autocomplete happening without going through all that complexity.

            16 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 →
            • 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…)
              • Add wildcarding for Users based on the @domain

                Instead of needing to add each users email separately there are some circumstances where it would be nice to add using a wildcard.
                For example, add all users @company.com

                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…)
                  under review  ·  Lukas LinhartLukas Linhart responded

                  That is a great point — although it might be part of our Apiary for Team offering.

                • Google Account Login

                  Integration with Google Accounts login would be nice. It is already a pretty feature rich and robust mechanism.

                  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…)
                  • provide an API to determine if all routes are currently "green/passing"

                    I think this would make CI integration much more painless. Then our CI can automatically:
                    1) publish the blueprint via the client gem 2) Call a healthy check which hits every route on our apiary.io project page 3) call this new API to make ensure all routes are passing.

                    Currently, I am trying to use Dredd without much success.

                    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…)
                      planned  ·  Lukas LinhartLukas Linhart responded

                      That is a good idea and great point! I’ll add it to our roadmap.

                    • 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…)
                      • ...make it possible to hide OPTIONS traffic

                        I've set up our blueprint as a transparent proxy and am now using that for our development server instance. This is great!

                        However, due to the cross-origin behavior, I now see an OPTIONS request for every one of our API endpoints.

                        I found it very helpful to use the traffic inspector to get an overview over which endpoints still need documenting. But I still see a lot of yellow indicators on it due to the OPTIONS requests.

                        I added OPTIONS documentations for all endpoints to our blueprint now, but they really aren't part of the API.

                        It would be nice…

                        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…)
                        • Mock Latency

                          Add an option to simulate higher response latency.

                          > developing backbone app, want to test spinners etc. could also mock on client-side ...

                          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…)
                          • Link blueprint raw file to the new documentation

                            When I open someone else new documentation (e.g. http://docs.queryparameters.apiary.io/). I am unable to see source of rendered documentation (raw markdown blueprint).

                            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…)
                              planned  ·  Lukas LinhartLukas Linhart responded

                              This is scheduled, but it’s waiting for the new terms of service and proper way to communicate them.

                            • Import Swagger configuration

                              We have a large API that already has some swagger documentation written for it.

                              I think it would be nice to be able to convert our swagger configuration files over to a markdown blueprint.

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

                                We are not sure about the userbase of swagger, but we might pursue it. Contributions certainly welcome!

                              • Make comments more visible and add notifications

                                Comments are currently quite well hidden. You have to expand the endpoint, and then click the Comments tab to see them at all.

                                More: there's currently no email notification of new comments, even if they're replies to something I posted myself. This makes it awkward to iterate with clients on an API design; you have to send them "I've replied to your questions" emails all the time.

                                44 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…)
                                • Organize and manage big lists of APIs better, use groups of APIs.

                                  The way in which the APIs are organized should allow from groups of APIs to be set. If you have dozens or hundreds of APIs you want to be able to group them in functional clusters. As it is today, they are all below a common root node, making them hard to manage if you have too many.

                                  The current way to list your APIs in the top dropdown menu is easy enough if you have a couple of APIs, but cumbersome if you have dozens of APIs.

                                  This is critical for the insertion of big sets of APIs.

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

                                    Agreed. As we are starting to have heavy users, we’ll have to provide such functionality.

                                  • Generate documentation info from JSON Schema

                                    When JSON schema is provided, inject documentation (in form of table?) into related resource.

                                    41 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  ·  7 comments  ·  Admin →
                                    • provide API to upload blueprint file

                                      We are hosting our blueprint file in a private SCM repository.

                                      I wonder how we can upload the blueprint file once we pushed a change.

                                      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…)
                                      • Auto indentation in editor

                                        Let me continue writing at same character position as previous line. Not to start each time from the beginning of the line.

                                        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…)
                                        • create an "include" directive so blueprint can be split across files

                                          Instead of

                                          + Body

                                          {"some":"json"}

                                          I'd like to be able to put

                                          + Body

                                          include "/link/to/json/file.json"

                                          It would make the blueprint a lot shorter, and allow it to concentrate on the api's behaviour rather than the json definition.

                                          19 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