apiblueprint Questions

1

Solved

I want to document a multipart request like the following: Content-Length: 477 Content-Type: multipart/form-data; boundary=---BOUNDARY -----BOUNDARY Content-Disposition: form-data; name="image[fi...
Shigella asked 13/6, 2014 at 14:16

2

Solved

I want to specify the various exceptions/errors that have to be returned while making an API call. How do I achieve this with Apiary.
Waneta asked 29/5, 2014 at 6:50

1

Solved

I am trying out API Blueprint and found some things, which are not quite clear to me. 1. How can I document POST body parameters? There is + Parameters but it just documents query parameters. If ...
Blaze asked 19/5, 2014 at 10:44

2

Solved

In API blueprint I am looking to specify an optional json element for a POST message. Example for; ### Add a new User [POST] To add a User send a JSON ..... + Request (application/json) { "...
Interlocution asked 29/3, 2014 at 17:8

1

Solved

We all know that apiary rocks (or not.. I think it does), and I was wondering what would it take to take it a step further allow users to export a JSON description of the API? (So developers can sc...
Ammieammine asked 8/4, 2014 at 19:41

1

Solved

I'm writing a spec for an API where the fields included in the response vary. I would like to be able to provide more than one example to show this. My use cases are: One of the API calls has an...
Yolanda asked 24/2, 2014 at 13:18

1

thanks for your time I have a POST request that I want to document in the blueprint apiary, the header is something like this: text/html _method:POST data[User][username]: data[User][password]:...
Blayze asked 7/11, 2013 at 15:57

1

Solved

Is it possible to specify description for every response to some request? Suppose, we have a request ### Retrieve resource [GET] + Headers If-None-Match: "Version1" And 2 responses + Respon...
Heterocyclic asked 15/10, 2013 at 5:58

© 2022 - 2024 — McMap. All rights reserved.