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. highlighting

    Fix syntax highlighting of words with underscores. Specifically, params, descriptions and JSON responses that have params with underscores in them currently start highlighting in the middle of the word (at the underscore). Likely, this must be considerably hindering page parsing & processing.

    6 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…)
    • Render data structures separately

      Sometimes it is necessary to lookup an entity to learn about it. In example, MSON supports additional information like "only three elements are expected in this array" or "we expect one of these values".

      To find such documentation, a separate page in the docs would be useful, only describing the entity and maybe referencing where the entity is being used (the actual endpoints).

      That way additional documentation can be viewed without opening the Markdown source.

      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…)
      • Pull the private setting flag when creating a new document

        We have our settings enabled so that new documents are private to start. When I went to make a new document the default is to select my personal user (which is not set to make documents private by default). When I select our team account for the document the private setting is not updated to reflect the setting. This may be an issue if someone accidentally posts a private document to the public

        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 →
        • Plugin for WebStorm

          Create plugin to display markdown in WebStorm IDE like:
          https://plugins.jetbrains.com/plugin/7701

          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…)
          • Allow user to link the remote JSON Schema

            Hello, thanks a lot for the JSON Schema Draft 4 support. Now I would like to suggest you if there is possible to allow the user to incude a remote JSON Schema.

            What I mean: We have a downloable JSON Schema on our website and I would like to have an option just simply link this existing URL to Apiary as a JSON Schema for the "Schema" section.

            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…)
            • real time viewing of changes to document while using apiary CLI, preview server

              Hi,

              This may already be happening but I couldn't find how to do it. It would be nice to start in preview mode using 'apiary preview --server' and then whenever I change the document in my local editor, to see the changes reflected immediately in the opened up page in the browser.

              Right now, I have make the change and go to the terminal and execute 'apiary preview --server' every time to see the change reflected on the page in the browser. I tried refreshing the browser page but that did not work for me.

              Regards,
              Rajiv

              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 →
              • Visual representation of API blueprint

                It will be useful if we could get a visual representation of the API blueprint which shows the relationships between various resources in the API. It will be helpful for APIs with a large number of resources as a diagram is usually easier to navigate

                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…)
                  under review  ·  1 comment  ·  Admin →
                • 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.

                  • Can Apiary register a valid SSL cert and support HTTPS only on its UI?

                    Would be nice to have SSL in place to prevent any snooping (since people are entering their API Keys into the Console).

                    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…)
                    • Highlight required attributes and parameters

                      Currently required options and parameters use the same font as optional ones. It would be nice to at least make the word "required" bold to easily spot them in a long table.

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

                        Currently, required parameters are signified by “full dot”, while optional ones are signified by "empty dot’.

                        This may not be obvious to some users, so we are looking into possible improvements.

                      • Allow repeated HTTP Headers defined in the Response

                        Apiary only supports one occurrence of each Response Header. If multiple headers are included in the API Blueprint, only the last one is represented in the documentation.

                        This is problematic when documenting that an API Response sets multiple cookies.

                        Per RFC 6265: " Origin servers SHOULD NOT fold multiple Set-Cookie header fields into a single header field. The usual mechanism for folding HTTP headers fields (i.e., as defined in [RFC2616]) might change the semantics of the Set-Cookie header field because the %x2C (",") character is used by Set-Cookie in a way that conflicts with such folding."

                        Suggestion: Modify the behavior…

                        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…)
                        • Admonition blocks

                          When creating technical documentation in general, it is sometimes nice to highlight a small part of the text to emphasise something.
                          reStructuredText uses what they call Admonitions for it which
                          Specific Admonitions (http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions) include "attention", "caution", "danger", "error", "hint", "important", "note", "tip", "warning", "admonition". But you can also create generic ones too.
                          I realise that this is something not included in the Markdown spec but it feels like API Blueprint could greatly benefit from such addition.

                          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…)
                          • display all attributes for a Data Structure in the Example pane

                            Currently all I get are the entries in the top level object returned, my payloads contain a lot of nested objects which mean my options are either:
                            1. Repeat the information in Data Structures elsewhere / reformat so it is included in the documentation
                            2. Not have a data dictionary displayed to uses which greatly reduces understandability.

                            As it stands I waste my time documenting my data dictionary in the Data Structures section as it's not displayed anywhere.

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

                              MSON is still in beta, and we are working on displaying all its’ facets, including nested objects and Arrays.

                              Feel free to describe them, they are going to show up over time.

                            • Make API Blueprint Searchable.

                              I love blueprints but usings plan old google search doesn't seem to work for them. I suggest you help make the interface somehow better for folks with large API where searching would be required.

                              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…)
                              • Groups in Teams

                                Can you please share more info on the new groups(sub teams) functionality with in Teams that would allow different level of API access for each group?

                                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…)
                                • Restrict Traffic Inspector to groups or individuals

                                  The apiary API that my team uses has a different proxy address for each team member, which means that an API developer can't see the traffic generated by a frontend developer.

                                  It would be useful to be able to (in the settings) set the proxy address to be shared between all team members, OR even better provide a url for the team AND one for each team member

                                  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 need to assess that because of its security implications; we got quite a few people very sensitive to the traffic content.

                                  • to parse correctly internal emphasis

                                    As specified in http://daringfireball.net/projects/markdown/syntax, emphasis in the middle of a word should work, which is currently not the case for your markdown parser.

                                    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…)
                                    • Semantic errors in valid URI template

                                      According to the URI templates page, you should be able to use '*' as a parameter to indicate multiple variable expansion. But when using * in an API endpoint, a semantic error is raised, indicating that the URI template expression contains invalid characters.

                                      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…)
                                      • Allow the "Introduction" and "Reference" sections to be renamed from within the document

                                        At the moment, my document is always divided into an introduction section and a reference section. I would like to be able to
                                        a. Remove the introduction
                                        b. Rename it
                                        c Might as well do the same for the reference section.

                                        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 →
                                        • Shared API blueprint templates to bootstrap new projects

                                          I apologize in advance if this is something I was just unable to find. From the products page I see the feature for bootstrapping new projects. Is there an ability to either use or create a base/template document that is used whenever creating a new API? Is the Notes example currently the only one available?

                                          Thank you. Looking forward to learning much more about apiary!

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

                                            It is so. We are now actively working on changing that documentation: extending the documentation and better sharing of the real-world blueprints and their organisation into the galleries.

                                          • Don't see your idea?

                                          General

                                          Feedback and Knowledge Base