ApiaryAdminApiary (Admin, apiary.io)

My feedback

  1. 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…)
      under review  ·  3 comments  ·  General  ·  Admin →
      ApiaryAdminApiary (Admin, apiary.io) commented  · 

      Hi Ian,

      this is a bit different: your case isn't really about highlighting, but about how values are actually parsed.

      In your case, you need to enclose the attributes in backticks (`) in order for the values to be treated like values and not like italic:

      + `one_two`: `three_four` (string)

      Also, for those questions, it's better to ask on Stack Overflow or contact us using in-app messenger.

      Hope it helps,

      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 →
        ApiaryAdminApiary (Admin, apiary.io) commented  · 

        Thanks for bringing this our attention. The individual APIs are quite separate from the Team APIs currently. We are investigating the pros/cons of not having individual APIs for teams, but that doesn't seem to be the way to go. We'll look at it as a UX improvement.

      • 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 →
          ApiaryAdminApiary (Admin, apiary.io) commented  · 

          Hi Rajiv,

          `apiary preview --server` should already work as you wish it worked. I've tried to reproduce your problems, but I wasn't able to do so. Would you be able to share your stack and exact commands you use so we are able to debug your situation and help you to get apiary client's server running properly?

          Maybe also file an issue in apiary-client's issue tracker here: https://github.com/apiaryio/apiary-client/issues

          My steps were:
          - I installed apiary-client and fetched an apiary.apib file with sample contents.
          - I've ran `apiary preview --server`.
          - I've opened `http://localhost:8080` in my browser. The docs got rendered properly.
          - I switched to editor, changed something and saved the file.
          - I've switched back to the browser and just reloaded the page. The change was visible.

          Thanks in advance for getting back to us. I'd be happy to help if you share more.
          Honza Javorek

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

            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.

            ApiaryAdminApiary (Admin, apiary.io) commented  · 

            Hello Matthew,

            thanks, that definitely sounds reasonable, we will look into it.

            I also think that this can be an open-source effort. We will let you know here once we have the basic skeleton in place.

            Cannot promise any ETA though; we also take uservoice into account, so let us see how this ticket will be voted.

            Thanks for the feedback!

            Lukas

            ApiaryAdminApiary (Admin, apiary.io) commented  · 

            Hello Matthew,

            thanks for the feedback. Just to clarify, explore some shortcuts and to help us shape the feature:

            If I understand you correctly, you would like Apiary to be configured in similar way Sphinx or Doxygen is and to generate blueprint in a similar way?

            This is certainly on our map, but it will probably take a while as we have to support a variety of popular environments.

            However, there is a way that may satisfy your need and with some support on your side would be available shortly.

            I would propose to generate blueprint file at build time, together with the rest of the documentation. Then it can be sent to our API and we will generate your new site from that.

            Unfortunately, I cannot provide proof-of-concept without knowing which environment/tools are you using (pure Python? Django, django-rest? Flask? What for documentation generation: doxygen, sphinx?).

            We want to provide an ecosystem for the most popular choices (and are probably going to opensource them or let the community handle them), but if you want to speed things up for you, you can add some code-gathering hack on your own and it should work for you shortly.

            What are your thoughts on that?

            Thanks again for your feedback,

            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  ·  2 comments  ·  General  ·  Admin →
              ApiaryAdminApiary (Admin, apiary.io) commented  · 

              Ryan - just for clarification - did you know Apiary will install a commit webhook into the repository that you choose, right? We have a separate privilege for public and private repositories - so you can install the webhook into a public repository without granting us access to your private repositories at all.

              If I understand it correctly you need to keep your blueprint in a private repository - but you don't want to grant Apiary access to ALL your private repositories - and so you'd like us to provide a key you could add to deploy keys in your repository - is that correct?

              Thanks for the feedback,

              Jakub

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

                ApiaryAdminApiary (Admin, apiary.io) commented  · 

                Actually there is another idea with the same content, please send all your votes here:

                https://apiary.uservoice.com/forums/120125-general/suggestions/2873414-store-api-definitions-in-more-than-one-file-enabl

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

                  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

                  ApiaryAdminApiary (Admin, apiary.io) commented  · 

                  David,

                  this is a very good observation, I couldn't agree more. To be honest, we believe our website will never match the simplicity of a workflow where you work in your own code editor on your own computer and commit through git.

                  That's why we started working on Github integration. You can set up your API documentation to be pulled (only 1-way sync now) from Github into Apiary on each commit. That way, you can edit files locally, push them to Github - and the rest happens automatically.

                  It's a starting point. There are rough edges. We realized it's hard for you to preview the result of the API Blueprint while working locally - so we created a ruby gem you can install (https://github.com/apiaryio/apiary-client). Hopefully soon, you'll be able to run it in the background continuously and preview results in your browser locally.

                  Would this improve your workflow?

                  Jakub

                • 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 →
                    ApiaryAdminApiary (Admin, apiary.io) commented  · 

                    Hello,

                    thanks for the idea. We are in the process of redesigning of our editor, we will definitely think about this.

                    Lukas

                  • 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  ·  General  ·  Admin →
                      ApiaryAdminApiary (Admin, apiary.io) commented  · 

                      Hello,

                      we definitely thought about this. However, as you said -- this one is bigger and we have to prioritize. But it should come to the product in the future.

                      Thanks,

                      Lukas

                    • 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  ·  General  ·  Admin →
                        ApiaryAdminApiary (Admin, apiary.io) commented  · 

                        Hello,

                        good idea, thanks! On our roadmap now.

                        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…)
                          planned  ·  2 comments  ·  General  ·  Admin →
                          ApiaryAdminApiary (Admin, apiary.io) commented  · 

                          Hello,

                          thanks, this is great idea, we will put that on our roadmap.

                          Lukas

                        Feedback and Knowledge Base