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. Validate XML using RelaxNG

    Be able to validate XML against given RNG/RNC.

    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…)
    • Notify when invalid request was passed through proxy

      Send an email or intercom message when invalid request was passed through proxy. To avoid spam, group messages into bulks.

      In most-wanted case, "invalid" means "status code differ" (for catching 404/500s).

      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…)
        under review  ·  1 comment  ·  Admin →
      • Allow build of apiary off existing code comments

        What I want is a self-documented API. My REST API is written in Python, and I want all the API docs to be generated off the Python codebase. It should be possible to inject all the apiary doc comments into the docstrings of the python code and provide some config file for apiary to read and scour my codebase for apiary commentary.

        One of my requirements is self-documenting API code. I really appreciate your invitation to your beta program, and your product looks very sharp.

        Please let me know if I missed something and your product actually can do this.

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

          This is certainly an area we’ve been exploring. I can’t give you an ETA at this point, but if we build this into Apiary, I’ll make sure to update the status this idea and you’ll be notified automatically.

        • Store API definitions in more than one file, enable linking

          With just 4 api calls the file is already getting pretty big, I would welcome being able to organize the API blueprints into subdirectories somehow.

          Also being able to identify an API call and link to it both from outside (as in: use THIS api call to do what ou wish) and inside (this api call is the same as THIS except for ...)

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

            Undocumented pre-alpha is live, but not all in-product edges are fine-tuned properly.

            Please let us know (e-mail to support@apiary.io) if you want to use this feature, we will give you a howto.

          • Generate Blueprint from HTTP API tests

            A lot of people usually test the HTTP API by sending requests.

            It would be a VERY nice feature if we could generate Blueprint out of these tests.

            Eg.

            In one test I send a POST /categories with a JSON body and relevant HTTP headers. You capture that since it's going through your proxy. You also capture what the response is from my server. There you have all the info you need to generate the request/response information. We could in our source documentation provide information like:

            POST /categories

            POST /categories?skip=100&limit=200

            POST /categories?limit=200

            POST /categories?q=comp

            The URL that match the HTTP…

            26 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  ·  6 comments  ·  Admin →
            • 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…)
              • Add support for Github webhooks and deploy keys

                It would be really useful to me to support Github's webhooks for commits and deploy keys for pull to integrate Apiary into my private github repositories.

                Giving access to all private repos is a bit much for me.

                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…)
                • Show HTTP verb button colors

                  When mouse is over the HTTP verb buttons they will be highlighted I can see. GET -> blue, POST -> green etc.

                  Would be better I think to have them in their color by default.

                  It's easier to see eg, https://apigee.com/resources/facebook

                  Johnny

                  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…)
                    planned  ·  2 comments  ·  Admin →
                  • filter the http methods

                    Make some sort of a filter where a user (document consumer) can filter the http methods in the documentation (get,put,post,etc). Even more flexible, allow the blueprint to place 'calls' into a group. (admin, client, etc)

                    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  ·  1 comment  ·  Admin →
                    • Switching context shouldn't refresh the page

                      Switch context tabs, Blueprint, Documentation, Inspector, Settings look like they're posting back to the server, if this could be a little more seamless, the workflow experience will be a tonne better! Happy to help.

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

                        David,

                        I really want to avoid building Apiary into a single-page-application with heavy frontend Javascript. I’ve done that in the past and often the benefit doesn’t justify the added complexity.

                        Our goal is to be similar to Github: lightweight Javascript on the frontend, but not hesitating to dive deeper when it makes good sense.

                        Do I understand it correctly that in this case, you’d like a more interactive, immediate experience between editing your code and seeing the results?

                        Thanks,

                        Jakub

                      • 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 →
                        • Allow condensing of request types under one endpoint

                          When you're making an endpoint that only allows one verb and will give an error for the other three, the interface looks cluttered when you want to show the results of each request type.

                          If we could let the request type on the documentation page turn into a dropdown to choose the one we want to view at a time, it would look much better.

                          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

                            Thanks for your feedback Jeremy. We suggest documenting only main/functional aspects of the API. It is assumed that not-mentioned URLs+verb combinations return some sort of error code. You could specify common behavior of the API (for example error handling for unsupported verbs/URLs) in the header comments of your API.

                            Does that make sense? My worry is that featuring all verbs for all URLs will clutter the documentation, too.

                          • In-Documentation Edits

                            I fully understand that the blueprint concept for data entering works great. However, you could complement it with the following features;

                            As a administrator i would like to

                            - be able to easy drag 'n drop items in the documentation (or even in between categories) so i have logic order on wich the items appear for the 'visitors' (i know i can do this in the blueprint)
                            - be able to change some basic things in the documentation (instead of going to the blueprint) like; switching between post/delete/put/etc. Change description, or even the URL).

                            Great service guys, keep up the…

                            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 →

                              Thank you for the ideas. From a usability point of view those are all good ideas. But we chose the text format, because it is the most common way developers can cooperate with each other – merge each others changes, version the changes etc.

                              Thus, making interactive changes in the documentation would have to be propagated by Apiary back tnto the text blueprint, so that we can keep the blueprint as the inter-op format. This becomes even more important when using Github as an external blueprint repository.

                              We’re thinking about adding two-way sync support for Github. Feel free to add your vote to it if that’s something that would be helpful for you: https://apiary.uservoice.com/forums/120125-general/suggestions/2986278-support-github-2-way-sync

                            • New button

                              It would be save a lot of typing and silly mistakes if while working on the blueprint we could press "New API" (or hotkey) and it would fill in the basic structure after the currently selected api.

                              I'm not sure what it would put, maybe something like:

                              --
                              Section Name
                              Description
                              --
                              Resource Name
                              GET /
                              < 200

                              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  ·  1 comment  ·  Admin →
                              • Indicators for documentation completeness

                                i would like to have an slider in the admin interface for each api call

                                % coverage in documentation
                                % complete in actual implementation

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

                                  This is a very nice idea. We cannot promise any release date, it probably won’t happen in the next few months, but we’ll keep it in mind when adding more testing support in the product.

                                • Support dynamic subdomains

                                  We use account specific subdomains (ala basecamp) for most of our stuff. Would be nice to have some way of better showing that.

                                  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…)
                                  • Use single quotes in Node example to avoid escaping doublequotes.

                                    From the Node example, the body could be easier to read:

                                    Current with double quotes:

                                    body: "{ \"username\": \"username\", \"password\": \"password\" }",

                                    Proposed with single quotes:

                                    body: '{ "username": "username", "password": "password" }',

                                    There is no change in functionality when using single quotes and many developers prefer using them for all attributes other than JSON and HTML.

                                    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…)
                                    • Parsed Description Links - Jump to Section

                                      I want to be able to click on a particular GET/POST in the parsed description and jump straight to the definition - so that it's a really useful outlining tool.

                                      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 2 5 6 7 9 Next →
                                      • Don't see your idea?

                                      General

                                      Feedback and Knowledge Base