Stack Overflow
Stack Overflow

Questions tagged [apiblueprint]

API Blueprint is a Markdown-based DSL for describing HTTP APIs.

API Blueprint is a Markdown-based DSL for describing HTTP APIs.

Documentation, opensourced parser and other utilities available at http://apiblueprint.org/

250 questions
2
votes
1 answer

API Blueprint - How to perform a simple UPDATE

I have went through the documentation of Apiary but did not find out how to create a blue print to update a resource. What I am trying to achieve here is a simple scenario such as having a list of users, being able to list them, retrieve a single…
dukable
  • 3,968
  • 11
  • 31
  • 42
2
votes
2 answers

How to best manage versions with API Blueprint format

How are people managing multiple API versions with API Blueprint? It doesn't seem that the format supports version sections within a single file, so I'm left thinking that multiple files with indicators in the filename are the best option. We want…
Preston Holmes
  • 21
  • 2
2
votes
1 answer

Is it possible to specify parameters which go into the post body with blueprint?

I'd like to be able to document the parameters as if they were URL parameters, since I like how that bit of documentation renders a handy table. However, in my API, I would like those paremeters to plug into the JSON body rather than the URL. Is…
Eugene
  • 2,946
  • 2
  • 26
  • 30
2
votes
2 answers

Does Apiary.io throttle responses?

I have an angularjs app that calls a RESTful service at apiary.io Does apiary.io throttle responses and delay responses after a certain number have been received? If so what are the parameters?
Greg Pagendam-Turner
  • 2,356
  • 5
  • 32
  • 49
2
votes
1 answer

Apiary: Refer to multiple models in a body

It seems you can only refer to the model itself in an unmodified form from a payload/body section: # Item [/] + Model { "name" : "an item" } ## GET + Response 200 [Item][] Is there any way to return an array of the model or use the…
billc.cn
  • 7,187
  • 3
  • 39
  • 79
1
vote
0 answers

How to maintain release versions of the API

Is there a way to maintain history of API releases in Apiary Blueprint? I would like to show a dropdown with release versions on my API documentation page so that user could view documentation for a specific version of the API. May be by telling…
Sadiq Khoja
  • 522
  • 1
  • 5
  • 23
1
vote
0 answers

apiary authentication description not work?

I currently have this blueprint as https://help.apiary.io/api_101/apib-authentication/#describing-basic-auth-in-api-blueprint described. FORMAT: 1A # Basic Auth API ## Basic Auth protected resource [/protected] ### Status [GET] + Response 401 …
Josie Zhang
  • 11
  • 1
1
vote
0 answers

MSON data structures from external file

I want to use the MSON data structure defined in an external file and refer to it in my API blueprint file. Is it possible? As of now I define both in the same file. FORMAT: 1A HOST: https://polls.apiblueprint.org/ # Suppliers CRUD API to…
anil
  • 154
  • 1
  • 8
1
vote
1 answer

Document API Request with Query Parameters with Square brackets

I'm trying to use Apiary to document my API. The URL for the request has parameters that contain objects so the parameter has a square bracket. Here is an example of what the URL path looks…
Michael Turnwall
  • 649
  • 7
  • 21
1
vote
0 answers

How to describe a `multipart/form-data` request in blueprint documentation standard?

i'm trying to document an API and one of these endpoints works as multipart/form-data content-type recipient to catch user uploads, and the whole other endpoints works as application/json content-type recipients. In my documentation i have…
thau0x01
  • 877
  • 1
  • 7
  • 18
1
vote
0 answers

Parameterize a Data Structure in API-Blueprint

I vaguely have the following document: # Group Cats ## Get ALl The Cats [GET /api/v1/cats{?page%5bsize%5d,page%5bnumber%5d,sort,filter}] + Parameters + page%5bsize%5d: 10 (number, optional) - Maximum number of resources in a single paginated…
leifg
  • 8,668
  • 13
  • 53
  • 79
1
vote
0 answers

Repeating a MSON data structure with different values

I have many places in my API where I will need to describe a list of objects. Each object has the same keys / structure but different values. How can I tweak the values of each instance of some data structure while retaining all the original type,…
zelusp
  • 3,500
  • 3
  • 31
  • 65
1
vote
1 answer

SailsJS blueprint GET model with no limit

I have a problem. I need to use GET blueprints and I would like to receive all (without a limit) of my Models objects (think in one Model called Student). So, to do that I added in sails.config.blueprints the attribute parseBlueprintOptions and set…
Lucas Penén
  • 41
  • 2
  • 6
1
vote
1 answer

Apiary Blueprint attributes under headers and body are not recognized

Final Edit: This works with no semantic errors: + Request + Headers Accept: application/json Content-Type: application/json X-Auth-Client: Your Client Id X-Auth-Token: Your Token + Body …
T.J.
  • 415
  • 3
  • 17
1
vote
1 answer

Do IBM Bluemix and Azure provide equal support to API Blueprint and OpenAPI? To describe APIs

I could use some help deciding which API Description Language to use for the APIs our team has deployed on IBM Cloud and possibly Azure in the future. We have been using API Blueprint informally, but when registering the APIs on Bluemix I noticed it…
Alo
  • 974
  • 2
  • 8
  • 24
1 2 3
…
16 17