Anonymous

My feedback

  1. 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…)
      14 comments  ·  General  ·  Admin →
      started  ·  ZZ responded

      Updated information.

      You can already describe URI parameters in structured way with the new API Blueprint format. Refer to https://github.com/apiaryio/api-blueprint/blob/master/examples/7.%20Parameters.md for details.

      The new format is now default and URI parameters are properly rendered in the documentation.


      We are still working on description of http message–body properties (parameters). It is planned in the upcoming revision 1B of API Blueprint – as discussed in https://github.com/apiaryio/api-blueprint/issues/25

      Anonymous commented  · 

      I couldn't find a way to describe response parameters/objects attributes. Is this refering to the same issue.

      Anonymous supported this idea  · 
    • 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.

        Anonymous supported this idea  · 

      Feedback and Knowledge Base