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 HOST servers (staging, QA, prod, etc)

    Currently one can define a single HOST endpoint that will be displayed in the right-hand column when viewing an API. It would be great if we could create multiple HOST definitions for different environments and name them descriptively.

    96 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

      We are not sure if multiple HOST headers are the right solution, but we definitely want to provide a way to use Apiary against staging environments.

    • History and Version Control

      The platform is missing change history and an ability to save draft versions.

      What happens if someone deletes everything by accident?

      114 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

        We do track revisions internally, but we are yet to release proper API and UI for that. It is fairly high on our list, though.

      • Create package for Textmate

        Create package with syntax highlighting for apiary blueprint format.

        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…)
        • Create webhooks for use with other collaboration tools such as Flowdock or Slack.

          It would be great if you guys had webhooks that would post to collaboration tools such as Flowdock, Slack, Asana, or Basecamp. This would be particularly useful for comments so that team members can see when comments are posted and respond in a timely manner.

          11 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 →
          • Add possibility to change the theme

            Default theme is nice, but not user-friendly.
            gray-white-gray-white %)

            Grouping and header backgrounds are very strange.

            Best, nZeus

            11 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 can be done using our enterprise embedding plan.

              However, we do plan to provide this in cheaper plans that will provide limited customisability, such as background or logo.

              We’ll let you know here once it will be available.

            • add JSON formatting.

              When entering JSON format data I take the junk spit out of my actual API implementation and enter in the blueprint. It's not normally pretty printed. You could use JSON Lint.

              https://github.com/zaach/jsonlint

              40 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 →
              • 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 →
                • Support for gzip encoding in mock server

                  If Content-Encoding: gzip is present, mock server should transparently encode the payload.

                  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…)
                    planned  ·  0 comments  ·  Admin →
                  • Fold/unfold all examples

                    Would be great to have a button to fold/unfold all examples so we don't need to click on each one of them.

                    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…)
                      planned  ·  1 comment  ·  Admin →
                    • Support generic git repositories

                      We'd like to store the blueprint in bitbucket, it would be nice if there was support for generic git repositories for that reason.

                      Thanks!

                      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…)
                      • Add a possibility to generate full code template

                        Well, I would love to describe API, have documentation and in one click get template with prepared methods and classes ready written in language of my choosing.

                        Obviously this is not usable by some frameworks and/or programming languages, but I can imagine many developers would appreciate it.

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

                          We plan to bootstrap community around blueprint tooling and framework bindings. Stay tuned!

                        • Add an activity feed for blueprints so you can track what's been happening.

                          An activity feed (like Trello for example) of all the actions that have taken place on the API (edits, deletions, comments etc). This would add a massive amount of value around the collaboration on a Blueprint.

                          73 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 for binary content

                            Provide a way to return binary content from resource.

                            29 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…)
                            • Custom Google Analytics Profile For API Documentation

                              Add the ability to include custom Google Analytics Profile tracking code on the API Documentation page.

                              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…)
                                planned  ·  1 comment  ·  Admin →
                              • Add "Default" and "Members" to Attributes.

                                Currently Parameter can have Default and Members added to them in the Blueprint, but Attributes do not. I need to be able to specify Default Values and a list of Possible values for Attributes.

                                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…)
                                  • 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.

                                    • Support customizing the apiary file saved to Github

                                      It would be nice to allow some customizations to the file saved into Github. Currently it's saved as "apiary.apib" at the root of the repo, but it would be nice to be able to change the name and/or location of that file.

                                      This feature would be useful if there are more than one apiary documents that need to be saved into the repo.

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

                                        That is definitely planned as overhauling the whole github experience is near.

                                      • Query parameters without space between them

                                        ### Get foo [GET /foo{?from,limit}]
                                        work fine but
                                        ### Get foo [GET /foo{?from, limit}]
                                        didn't work. I think it's so confusing because editor didn't tell me where is the problem..

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

                                          We plan to add better support for URI Templates error reporting.

                                        • Allow templating in responses

                                          Provide a way to populate some parts of response with "variables".

                                          Some ideas:

                                          * Provide "api base" that is corresponds to generated mock server URI
                                          * Provide same variables that are specified in templated URI

                                          62 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 →
                                          ← Previous 1 3
                                          • Don't see your idea?

                                          General

                                          Feedback and Knowledge Base