Jakub KorálJakub Korál

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

      Jakub KorálJakub Korál commented  · 

      Actually ...

      This URI-template `/{file}{.extension}` would work as expected.

      When you expand it with extension='', you get the url `/file` without extension
      When you expand it with extension='json', you'll receive a `/file.json` url.

      Jakub KorálJakub Korál commented  · 

      Hi Christian,

      As Z has releases new parser version ( https://github.com/apiaryio/protagonist/releases ) today, parameters will be available in a week or so, hopefully not more.

      The documentation, that apiary provides right now, is not ready for Parameters unfortunately... But we are preparing new Documentation for a while, and these New Docs will be available to public very soon.

      If you are willing to participate in debugging closed-beta of New Docs (And yes! It works with Parameters), please drop a note at support@apiary.io - Thanks

    • 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…)
        planned  ·  1 comment  ·  General  ·  Admin →
        Jakub KorálJakub Korál shared this idea  · 

      Feedback and Knowledge Base