apiaryio / api-blueprint

API Blueprint
https://apiblueprint.org
MIT License
8.65k stars 2.14k forks source link

Sample request code should substistute parameters if they are provided #68

Closed aop closed 10 years ago

aop commented 10 years ago

In the notes example it should show curl example code like this

curl --include \ "http://test1156.apiary.io/notes/1"

instead of curl --include \ "http://test1156.apiary.io/notes/{id}"

and the response

200 (OK) Content-Type: application/json X-My-Header: The Value { "id": 1, "title": "Pick-up posters from post-office" }

with the corrseponding id

zdne commented 10 years ago

Hi @aop thanks for the input! Note this is question for the specific API Blueprint tool not for about the API Blueprint itself. In this case Apiary rendered documentation and inspector and as such it is better to ask the respective tool owner, which is Apiary support in this case.

Dubbing Apiary support here – this issue will be fixed in the upcoming rendered documentation redesign. See the attached screenshot of a console call performed on the Default API.

screen shot 2014-03-09 at 8 06 27 pm

zdne commented 10 years ago

Note to be able provide a meaningful value in the example the URI parameters description section must specify an example (or default) value.