Boris  StaalBoris Staal

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

      Boris  StaalBoris Staal supported this idea  · 
      Boris  StaalBoris Staal commented  · 

      Using hand-written markdown with custom structure is so uncomfortable. A lot of reasons for that: Markdown limitations, text overhead, the need to come up with structure, etc.

      As a fast solution you can add proposed structure to the default blueprint. At least we could all start with something, not "okay, how am I supposed to do that?". Seriously. At the first step you don't even know which header to use cause you are not aware of resulting documentation's CSS.

      At long term though you won't be able to ignore this requirement. I believe that sooner or later you'll have to come up with some kind of DSL to extend current blueprint syntax. So... +3 :)

    Feedback and Knowledge Base