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. Reservations API

    I can't seem to find any documentation about how the singleplatform actions API works for restaurant reservations. I'm looking here:

    http://docs.singleapi.apiary.io/

    I see that there's an action type called "foodreservation", but I don't see information about how to invoke it, what the expected returned information is, etc. Is there a write-up somewhere that describes how to use this? Or maybe just an example?

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

      Apiary provides a platform that SinglePlatform utilises. It seems your question is about the singleplatform API directly—unfortunately, for that you need to reach out to them directly.

    • Add Bitbucket support, similar to GitHub

      bitbucket.org is a code hosting platform, similar to GitHub. It supports Merurial and Git repos.

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

        For time being, this feature is marked as declined because BitBucket refuses to add an API to make this possible.

        If you’d like to change their mind, please go to their support system and vote here: https://bitbucket.org/site/master/issue/8672/is-there-any-api-to-make-a-commit

        I’ll revisit this feature once we’ll be rewriting our system to allow us to clone repository in background and communicate with origin server via SSH keys.

        We are taking security very seriously and we don’t want to have any of your code in our system. As distributed systems make it hard to clone a path subset of a repository (only the blueprint file), this requires a lot of security infrastructure on our side and thus will not happen soon.

        Any particular ideas on overcoming those limitations are welcome in comments.

      • Don't change header capitalization when sending it to the server!

        If I send an Authorization header it shows up as authorization..

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

          Unfortunately, we can’t do that in the near future. Normalising headers is part of how some of our infrastructure works, and it’s not possible to change that in the near future.

          I know it can be annoying for some purposes, but ultimately, it shouldn’t matter; header names are case insensitive: https://tools.ietf.org/html/rfc7230#section-3.2

        • Allow multiple actions for the same HTTP verb

          Consider this example:
          Get User [/api/users] # returns all user objects
          Get User [/api/users/{user_id}] # returns one specific user object
          Get User [/api/users/{user_email}] # returns one specific user object

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

            This example describes multiple actions to different URLs, which is allowed.

            Alternatively, this describes two different resources, the latter one having two possible options in the parameters.

          • SOAP support

            We've received requests for supporting SOAP in Apiary, probably as an extension of WSDL. Here's a place to discuss that.

            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…)
              declined  ·  3 comments  ·  Admin →
            • 2 space tabs

              Allow 2 space tabs in Blueprint :)

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

                Johnny, can you give me an example of where this matters? Do you mean tabs in your JSON examples?

              • update the code samples to be up-to-date with CORS/proxy/etc settings

                Activating CORS under Settings doesn't seem to change the code samples, which I find rather important for transparency.

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

                  CORS samples are returned, not requested, so it should be OK this way.

                  Mock/proxy settings will be separated by using different urls.

                • Recommend changing font size that to 12px for the blueprint

                  The smallest font size setting in the blueprint currently renders the font at 18px. This is too large. Recommend a font size 0f 12px

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

                    Thank you for your recommendation. We have done multiple iterations and the larger font size is ultimately driven by our focus on readability for the wider audience.

                    If you want to customise your documentation, you can use our Apiary for Teams Premium plan which allows you to embed the documentation into your page, and customise it there, including the font overrides.

                  • Where do I just ask a question? I'm not suggesting a feature.

                    I'm trying to document an API that contains lots of non-restful routes. Things like /api/some_custom_report which takes a number of parameters. I can't seem to guess my way how to do this in the editor - it wants a group and then http verb routes under it.

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

                        API blueprint is now focused on request-response paradigm very heavily.

                        We do have an ongoing research that might unify a HATEOAS approach with socket.io-style messaging, but I can’t give any ETA whatsoever.

                        Therefore, while we may consider reopening this ticket in the future, I’d like to close it for the time being.

                        Suggestions to remediate the situation are welcome on the API Blueprint issues: https://github.com/apiaryio/api-blueprint

                      • Add Flash Player support crossdomain.xml

                        this tool work great for HTML and other env's, but i am a ActionScript3 developer and when i do new server call the flash check in the domain main folder for crossdomain.xml file and read the authentication info from it before it can do any call.
                        please add this file as default, or not default, to new API sub domain so Flash testers could use it while doing API mockups and design.

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

                          You can add crossdomain.xml as a resource that’s going to return whatever you want it to.

                        • Add possibility to use models in other models when getting a response

                          There should be possibility to use model within other model in response, for example I have:
                          - user model
                          - address model

                          and I would like to get response in such a format:

                          {
                          //user data
                          "addresses": [
                          //collection of address models
                          ]
                          }

                          Is such feature currently available?

                          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 →
                          • Give the possibility to use the owner mock server

                            Imagine that a have a endpoint who gives the possibility to order de reponse with a 'orderBy' parameter, if you want test this with mock server you can't.

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

                              Can you please elaborate on what do you mean by “you can’t test orderBy with mock server”?

                            • support asciidoc as a base type

                              markdown is good, but asciidoc is just as, if not more concise markup format. Supporting asciidoc would allow people to include apiary application definitions inline in their technical specs, as well presentations.

                              Here are some examples of asciidoc used in this way:

                              formal specification:
                              https://github.com/jboss/cdi/tree/master/spec
                              renders to http://jcp.org/aboutJava/communityprocess/pr/jsr346/index.html

                              presentation:
                              http://mojavelinux.github.com/decks/

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

                                For our new format, we have decided to be deeply rooted in Markdown format (every valid Blueprint will be valid Markdown), which mostly rules out plugging in asciidoc/reST/etc.

                                We want our blueprint to be lingua franca of the API description and using multiple formats would fragment our community.

                                For those who care deeply about other formats, please provide preprocessor which will export rest documentation into blueprint.

                              • 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 an syntax highlighter for ACE

                                  Create a syntax highlighter for ACE http://ace.c9.io/#nav=higlighter apiary blueprint format.

                                  Which could then be pushed to many different web code editors automatically (including git, Cloud9, Code Academy... etc)

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

                                    We are actually using ACE under the hood.

                                    However, current format is going to be deprecated and new format is clean markdown superset, so Markdown syntax highlighting will be working just fine.

                                    Our editor contains a lots of additions to default ACE, but they are unfortunately integrations with underlying parser, not just syntax highlighting package.

                                    Thus, please just stay tuned for the upcoming format and your experience will improve soon!

                                  • Group resource by request

                                    When you create something like this.

                                    GET /payment/{id}
                                    < 200
                                    {
                                    "type" : "templated"
                                    }

                                    GET /payment/123
                                    < 200
                                    {
                                    "type" : "special case, matched without a template"
                                    }

                                    It'' be great if the get grouped when you see the documentation.

                                    Just one resource /payment/{id}, the other one is just an example for the mock api server..

                                    thanks

                                    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…)
                                      declined  ·  ZZ responded

                                      Dear Juan,
                                      I am afraid this would not be feasible approach. Please consider following:

                                      Returns payment for given id (id can be for example = abcdef1234)
                                      GET /payment{/id}

                                      and:

                                      Returns total number of all payments made.
                                      GET /payment/count

                                      There is not enough information to guess whether count is a value of {id} or something else.

                                      Luckily, if specifying default value is what you are looking for, the New API Blueprint Format will bring support for specifying default values for URI parameters so you would be able to write something like:

                                      1. GET /payment{/id}
                                        1. Parameters
                                          + id = 123 … An id of a payment to get.

                                      With this I am closing this idea. Please let me know (z@apiary.io) if specifying default value is what you need or want to discuss this topic in detail.

                                      Thank you.

                                      With kind regards,

                                      – Z.

                                    • add IMDB id to person data

                                      We get the IMDB id for movies, would be really nice to have this id for persons as well.

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

                                        I am really sorry, but this is a support for Apiary product, not themoviedb.

                                        Please contact their support. I am really sorry for confusion, we are working hard on solvind this.

                                      • Underline my username

                                        ..so it'll be clear that it's clickable :)

                                        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…)
                                        • Popular API Examples

                                          Perhaps host an up to date set of "popular" API's such as twitter, facebook whatever so that developers DONT have to write their own mocks and can just point their apps at this site to get quick "fake" response for popular existing APIs.

                                          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 does sound obvious at first, but we decided against this. An API documentation is something that the API publisher needs to take responsibility of.

                                            If we are going to produce documentation on behalf of 3rd-parties, it’s going to become quickly outdated.

                                            Rather then hosting bad, misleading documentation it’s better it doesn’t exist at all.

                                          • Don't see your idea?

                                          General

                                          Feedback and Knowledge Base