Lukas LinhartLukas Linhart

My feedback

  1. 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…)
      3 comments  ·  General  ·  Admin →
      Lukas LinhartLukas Linhart commented  · 

      Our new API is still in internal testing, but you can use our Apiary CLI which will abstract away the future changes.

      See https://github.com/apiaryio/apiary-client#publish for more details.

    • 110 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…)
        24 comments  ·  General  ·  Admin →
        started  ·  Lukas LinhartLukas Linhart responded

        We are working on the initial workflow support using git branches.

        Lukas LinhartLukas Linhart commented  · 

        Hi Steely,

        this feature is currently available for Apiary Pro customers only.

        If you with to try it out, please do not hesitate to reach out to support@apiary.io.

        Cheers,

        Lukas

        Lukas LinhartLukas Linhart commented  · 

        Hi,

        yes, we are testing it with selected customers, and there is a development based on user testing.

        Stay tuned! :)

        — Lukas

        Lukas LinhartLukas Linhart commented  · 

        Hi Nathan,

        unfortunately, there is no update yet. We went through multiple iterations "under the hood", but we have nothing to show yet. Receiving hooks from multiple branches / blueprints is somehow easy, but having an elegant "publishing workflow" is tricky.

        I know it's frustrating for you as a user, but please be patient. Once we are going to have some usable beta, we're going to let you know here.

        Regards,

        Lukas

        Lukas LinhartLukas Linhart commented  · 

        Evan: Just a thought, I'd say you may want to have them as separate blueprints.

        IMHO, once released, your API is "frozen" and development ends. You git cp your blueprint and move on (because, if you are using dredd, you want to test all the older versions, not just the new one).

        Good food for thought, thanks.

        Lukas LinhartLukas Linhart commented  · 

        Hi William,

        we'll be improving our git workflow soon, but for now, we plan just multiple branches support. What is your exact use-case, please?

        As for HOST array, we believe that specifying staging/dev serves should not be done in blueprint, but overriden in Apiary itself instead. We'll be adding some UI support for that.

        Regards,

        Lukas

      • 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  ·  General  ·  Admin →
          Lukas LinhartLukas Linhart commented  · 

          Hi Neil,

          could you please elaborate more on what you mean by that and provide an example of how you think this should work?

          Thanks,

          Lukas

        • 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  ·  3 comments  ·  General  ·  Admin →
            Lukas LinhartLukas Linhart commented  · 

            Hi Maxime,

            currently, we are leaning more towards handling what you are writing as a form of lifecycle.

            Therefore, it's not about marking sections as private, but about having devel/prepro/beta/production cycle for the API. This is also related to branching and our github support.

            Would that make sense for you?

            Regards,

            Lukas

            Lukas LinhartLukas Linhart commented  · 

            Hi Matt,

            just to clarify: is this for the purpose of the workflow (dark launches & feature switches) or for the purpose of security (obfuscating some parts of the API)?

            I am asking because of implications for the Apiary's API, exposing the blueprint through github/sharing API etc.

            Thanks,

            Lukas

          • 15 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…)
              6 comments  ·  General  ·  Admin →
              under review  ·  Lukas LinhartLukas Linhart responded

              We are investigating such options under an umbrella term of “Programmable mock server”.

              Lukas LinhartLukas Linhart commented  · 

              Not so far.

              Lukas LinhartLukas Linhart commented  · 

              No, not yet: we are now focusing on the delivery of the proper attributes description, which is a requirement for this feature as well.

            • 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…)
                under review  ·  7 comments  ·  General  ·  Admin →
                Lukas LinhartLukas Linhart commented  · 

                Hi Romain,

                no, it isn't as we are still not sure how many people would this annoy instead of helping them (in the prototyping phase) given that not many devs are using JSON Schema.

                I think it may be bumped after MSON is completely done, significantly increasing amount of people using it.

                Regards,

                Lukas

                Lukas LinhartLukas Linhart commented  · 

                Hi Marko,

                just as a thought — how would you like to decide which key is significant for the matching?

                Regards,

                Lukas

                Lukas LinhartLukas Linhart commented  · 

                Hi Dan,

                I get the idea, but it doesn't fit with some use-cases.

                Would X-Apiary-Validation-Status header suffice?

                Regards,

                Lukas

              • 248 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…)
                  30 comments  ·  General  ·  Admin →
                  started  ·  Lukas LinhartLukas Linhart responded

                  We are working on http auth support as part of our blueprint overhaul.

                  Lukas LinhartLukas Linhart commented  · 

                  Hi,

                  I agree there is no excuse for it taking so long, but in case you are interested and want to follow-up, the current proposal is available for comments here: https://github.com/apiaryio/api-blueprint/pull/201

                  As I've mentioned, getting MSON polished is our current priority, but auth should head into production right after that.

                  — Lukas

                  Lukas LinhartLukas Linhart commented  · 

                  Unfortunately not yet, as we want to finish MSON first.

                  As said before, OAuth2 is available in closed beta for console, but we are not ready in blueprint yet.

                  Matt, may I ask you what your use-case is? Is your primary concern to be able to describe the authentication in blueprint or to have the support in console and mock server?

                  Thank You,

                  Lukas

                  Lukas LinhartLukas Linhart commented  · 

                  Hi George,

                  yes, I've definitely learned something about public promises.

                  There is no in-product update yet. We are testing OAuth2 support for console; my hope is that deriving http auth from that is going to be easy, but I can't really provide a deadline yet.

                  — Lukas

                  Lukas LinhartLukas Linhart commented  · 

                  There is no excuse for the fact that we haven't delivered yet and we are taking the responsibility.

                  I don't think there is much I can add here except "we shipped" once it happens.

                  Lukas LinhartLukas Linhart commented  · 

                  Horse is not dead, but I fully accept the responsibility for being so late with this one.

                  Unfortunately, during testing, we discovered that the format didn't played well with the other proposed changes.

                  We iterated to the unified solution that will solve this as well as a lot of other issues: https://github.com/apiaryio/api-blueprint/issues/47 , unfortunately it is still not released yet.

                  I fully understand your frustrations and cannot really offer anything else than doubling my efforts.

                  I'll let you guys know once I have something. I'd hate to make other empty promises here.

                  Lukas LinhartLukas Linhart commented  · 

                  Neil,

                  actually, there is, but it's not visible yet. We've iterated over several designs and I hope we'll get it final soon.

                  Sorry to let you waiting,

                  Lukas

                  Lukas LinhartLukas Linhart commented  · 

                  Hi,

                  as we finally rolled the new API blueprint format as default into production last week, I am iterating with Z on the auth format on the blueprint side.

                  I hope to push this into production in the upcoming 2-3 weeks, at least in beta. I'll keep you posted here.

                  Regards,

                  Lukas

                  Lukas LinhartLukas Linhart commented  · 

                  Tschela,

                  only way we currently support is documented here: http://docs.authapi.apiary.io/

                  "True" support is part of our blueprint format overhaul outlined in blogpost linked below; it will be rolling in beta in upcoming month.

                  Thanks for your patience,

                  Lukas

                  Lukas LinhartLukas Linhart commented  · 

                  Hi,

                  format overhaul is in progress and should slowly blend into the current one.

                  HTTP/OAuth is part of it, but honestly, it will take few more weeks before we'll be satisfied with syntax and before it will appear on production.

                  We'll keep you posted!

                  Lukas

                • 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…)
                    6 comments  ·  General  ·  Admin →
                    Lukas LinhartLukas Linhart commented  · 

                    We are testing the API with selected customers, as one of the blocking parts is tokens infrastructure we are working on.

                    However, that's unrelated to bitbucket support: for information about it, please see http://support.apiary.io/forums/120125-general/suggestions/3284954-add-bitbucket-support-similar-to-github (and eventually vote :))

                    Lukas LinhartLukas Linhart commented  · 

                    Hi Jan,

                    nothing so far, our focus is on Github for Enterprise integration right now.

                    However, it shouldn't be hard to write those hooks and we'd definitely accept any 3rd party examples as well.

                    Regards,

                    Lukas

                    Lukas LinhartLukas Linhart commented  · 

                    Hi Evan,

                    to clarify: we are currently using github API to fetch our blueprint from github repository, so we never access other data stored in git repo.

                    This is obviously not workable for generic repository, so we plan to provide "apiary publish <blueprint>" command in our CLI (https://github.com/apiaryio/apiary-client) and build our hook around it.

                    It is fairly high on our roadmap as it empowers client with custom, more flexible tooling around blueprint build & publishing. We'll keep you posted ;)

                    Regards,

                    Lukas

                  • 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  ·  General  ·  Admin →
                      Lukas LinhartLukas Linhart commented  · 

                      Hi,

                      JSON should be highlighted in the rendered documentation. If not, please open a ticket by writing to support@apiary.io — we are going to take a look!

                      Regards,

                      Lukas

                    • 504 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…)
                        21 comments  ·  General  ·  Admin →
                        started  ·  Jakub KorálJakub Korál responded

                        Apiary now has a print stylesheet for the generated Docs.

                        It uses numbering + table of contents and displays the examples with language you have selected in the language-dropdown.

                        The preferred way of sharing the documentation with 3rd-parties is through People settings (add viewers). However printing now looks great.

                        Feel free to comment.

                        Lukas LinhartLukas Linhart commented  · 

                        @Santiago: Any reason why you have to version the resulting PDF instead of the source blueprints?

                        Lukas LinhartLukas Linhart commented  · 

                        Hi Shailesh,

                        we are working on it—and also figuring out what should we put into the print version.

                        Would you share with us what are you missing in the current print version?

                        Thank You,

                        Lukas

                        Lukas LinhartLukas Linhart commented  · 

                        Hi,

                        we are aware of those shortcomings and working on those.

                        Justin, the new, 3column documentation is actually still in beta, so the minimal stylesheets were attached just last week and we are designing the better docs as we speak. The non-beta version provides all the information you need for printing.

                        The plan is to provide really beautiful print docs — after the new documentation is ready to be the default one.

                        However, I think you are going to be pleasantly surprised once it graduate from its beta status.

                        Regards,

                        Lukas

                        Lukas LinhartLukas Linhart commented  · 

                        Hi Jano,

                        by displaying Markdown, you mean taking a look at the blueprint?

                        Regards,

                        Lukas

                      • 113 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…)
                          22 comments  ·  General  ·  Admin →
                          started  ·  Lukas LinhartLukas Linhart responded

                          We are working on this one. Stay tuned, and let us know here if you’d be willing to betatest.

                          Lukas LinhartLukas Linhart commented  · 

                          @Brian (or Maksym): We are testing it with courageous users. Please send an inquiry to support@apiary.io if you want to try it out as well :)

                          Lukas LinhartLukas Linhart commented  · 

                          Hi Mohan,

                          unfortunately, there are no updates yet. We are unifying this concept with splitting blueprints into multiple files and being able to have non-text response bodies.

                          I hope to give more details soon, but there is still no ETA yet.

                          Regards,

                          Lukas

                        • 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…)
                            3 comments  ·  General  ·  Admin →
                            Lukas LinhartLukas Linhart commented  · 

                            Hi Ben,

                            we are going to work on this in the upcoming month, hopefully with some visible results.

                            We are just very cautious and doing it step-by-step as it affects everyone.

                            Regards,

                            Lukas

                            Lukas LinhartLukas Linhart commented  · 

                            Hi Ben,

                            we definitely plan to do that.

                            The reason why it isn't in-place yet is that docs are on docs.*.apiary.io, a SSL certificate noone wants to issue. The plan is to move documentation to *.apiary.io and enforce SSL there.

                            Unfortunately, originally this is where mock & proxy server lived. We have deprecated it for some time, but we are waiting for residual traffic to cease before flipping the switch.

                            Thanks for your understanding,

                            Lukas

                          • 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…)
                              13 comments  ·  General  ·  Admin →
                              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.

                              Lukas LinhartLukas Linhart commented  · 

                              Hi,

                              unfortunately nothing visible so far. As said, most of our users are achieving this capability via git.

                              However, we are working on improving the whole API lifecycle management, announcement should be on our blog soon.

                              Regards,

                              Lukas

                              Lukas LinhartLukas Linhart commented  · 

                              Hi,

                              unfortunately nothing visible so far. As said, most of our users are achieving this capability via git.

                              However, we are working on improving the whole API lifecycle management, announcement should be on our blog soon.

                              Regards,

                              Lukas

                              Lukas LinhartLukas Linhart commented  · 

                              Hi brent,

                              this is currently not achievable without the actual git blame, but it's a good point! I'll add it to our stack and we'll think what can we do about it.

                              Thanks for the feedback,

                              Lukas

                              Lukas LinhartLukas Linhart commented  · 

                              Hi,

                              Can, you can, using "apiary publish" command in our CLI gem. Please see https://github.com/apiaryio/apiary-client#install

                              Sina, we internally keep all the versions and we'll definitely expose them, but we need to prepare for that process a bit...especially with the web UI side. As said, it's on our roadmap, but we are now focusing on other product aspects.

                              Regards,

                              Lukas

                            • 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…)
                                18 comments  ·  General  ·  Admin →
                                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.

                                Lukas LinhartLukas Linhart commented  · 

                                Hi Alex,

                                unfortunately not yet as we've focused on the payload reusability with the release of MSON.

                                We'll let you know.

                                Regards,

                                Lukas

                                Lukas LinhartLukas Linhart commented  · 

                                Hi Matt,

                                there is currently no such way, but we are aware of the issue from our own experience ;)

                                We are thinking about how to solve this in an elegant way, probably using one of the "generic" features that are on the way. Stay tuned!

                                Regards,

                                Lukas

                              • 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  ·  General  ·  Admin →
                                  Lukas LinhartLukas Linhart commented  · 

                                  Hi Olivier,

                                  MSON was released just few days ago—and we are now actively working on the way the informations are represented.

                                  Regards,

                                  Lukas

                                  Lukas LinhartLukas Linhart commented  · 

                                  Hi,

                                  we are working on better way of writing schemas (called MSON). We are going to extract descriptions from it, but I can't yet tell whether Schema is going to be supported together with it as well.

                                  Regards,

                                  Lukas

                                  Lukas LinhartLukas Linhart commented  · 

                                  Hi Wissam,

                                  no update yet. We are, however, starting to implement MSON (https://github.com/apiaryio/mson) — and once it'll be available in Apiary, documentation from JSON schema is going to be supported as well.

                                  Lukas

                                  Lukas LinhartLukas Linhart shared this idea  · 
                                • 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…)
                                    under review  ·  4 comments  ·  General  ·  Admin →
                                    Lukas LinhartLukas Linhart commented  · 

                                    It is. We will be soon dedicating more love to the editor; it might be a while before the improvements will surface, but you should see significant improvements :)

                                    Lukas LinhartLukas Linhart commented  · 

                                    Hi Olivier,

                                    we have plans to polish our editor, but unfortunately, it's now still in the queue behind more high-priority stuff.

                                    We'll update you here once we start working on it (and we'll be definitely looking for feedback then).

                                    Regards,

                                    Lukas

                                  • 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…)
                                      under review  ·  2 comments  ·  General  ·  Admin →
                                      Lukas LinhartLukas Linhart commented  · 

                                      Hi Matt,

                                      could you please provide the snippet blueprint and what functionality doesn't work for you?

                                      On parser level, multiple Set-Cookies should be supported: https://github.com/apiaryio/snowcrash/issues/75#issuecomment-58886108

                                      We intent to support it in our ecosystem as well and we are interested in eventual gaps.

                                      Thanks,

                                      Lukas

                                    • 133 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…)
                                        19 comments  ·  General  ·  Admin →
                                        started  ·  Lukas LinhartLukas Linhart responded

                                        We are offering embedding as part of our Apiary for Companies plan. Please contact support@apiary.io if you want to try it out.

                                        That said, we are going to offer simpler & cheaper possibility by using CNAME. This is planned to be available this year.

                                        Lukas LinhartLukas Linhart commented  · 

                                        Hi Chris,

                                        not yet, as we are still working on the UX for that one.

                                        Could you please share with me how can we make the UX for the embedding version better? E-mail to support@apiary.io (or to me directly, at lukas@apiary.io) would definitely be appreciated.

                                        Thanks!

                                        Lukas

                                        Lukas LinhartLukas Linhart commented  · 

                                        We have multiple customers hosting Apiary documentation on their site, like Akamai and Microsoft.

                                        The CNAME plan hasn't been introduced yet, however there are going to be some news before the end of the year.

                                        Lukas LinhartLukas Linhart commented  · 

                                        Raj, it isn't. If you want to, you can generate the documentation using some OSS parser, like iglo (https://github.com/subosito/iglo), but the hosted Apiary version is only part of the enterprise plan.

                                        Lukas LinhartLukas Linhart commented  · 

                                        Hi Kerr,

                                        we offer only embedding now as it satisfies most use-cases. CNAME is planned, but I cannot make any promises or dates.

                                        Regards,

                                        Lukas

                                        Lukas LinhartLukas Linhart commented  · 

                                        Hi,

                                        please have just a little bit more patience. There is a testing in progress with few customers and we are currently busy incorporating their feedback.

                                        We promise we'll let you know once we'll be able to keep up with the load. At that point, we'll invite few more users to the beta.

                                        Thanks,

                                        Lukas

                                        Lukas LinhartLukas Linhart commented  · 

                                        Hi Zbytek,

                                        we are now testing our prototype where you can embed parts of your documentation (or all of it) into you webpage (or development portal).

                                        If this satisfy your needs, we can give you access to private beta soon.

                                        Regards,

                                        Lukas

                                      • 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…)
                                          10 comments  ·  General  ·  Admin →
                                          Lukas LinhartLukas Linhart commented  · 

                                          Vojtech: For example, this would link to "Create Step" action in my testing API: [create step](#reference/test-steps/test-steps/create)

                                          Lukas LinhartLukas Linhart commented  · 

                                          Hi Maxim,

                                          at least for me (Chromium), in the new documentation, if I click on resource group in TOC and then on the resource in TOC and hit back, I am navigated to the resource group heading as expected.

                                          Regards,

                                          Lukas

                                          Lukas LinhartLukas Linhart commented  · 

                                          Hi steve,

                                          yes, we are working on it.

                                          The new docs are already generating permalinks for resources and resource groups. We are now working on generating permalinks for the headers in the introduction section.

                                          Regards,

                                          Lukas

                                          Lukas LinhartLukas Linhart commented  · 

                                          Hi Maxim,

                                          we are not actively trying to discontinue HTML support, but there are some major overhauls due regarding sanitisation and XSS prevention.

                                          Most of the things should continue to work, but I don't want to guarantee anything in case we'd have to close some security loopholes.

                                          As for the use-case, we will definitely support it and we'll let you know here once we have the "official" way we can guarantee.

                                          And yes, we realise it's fairly important for handling larger API descriptions.

                                          Regards,

                                          Lukas

                                        • 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…)
                                            under review  ·  2 comments  ·  General  ·  Admin →
                                            Lukas LinhartLukas Linhart commented  · 

                                            Hi Charles,

                                            would you please post the particular URL Template you are using? I see only the expanded one in the docs, and it would help us a lot with debugging.

                                            Thank You,

                                            Lukas

                                          ← Previous 1 3

                                          Feedback and Knowledge Base