Machiel GroeneveldMachiel Groeneveld

My feedback

  1. 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 →
      Machiel GroeneveldMachiel Groeneveld supported this idea  · 
      Machiel GroeneveldMachiel Groeneveld commented  · 

      I agree, our responses are quite large and are unreadable if unformatted

    • 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

        Machiel GroeneveldMachiel Groeneveld supported this idea  · 
        Machiel GroeneveldMachiel Groeneveld commented  · 

        I would like to describe each parameter and give example value(s). These example values can be used to generate a sample request url, the example code (e.g. curl) now has the raw uri template code in it, which is not usable straight away

      Feedback and Knowledge Base