I have a table: | This | Is | A | Table | | :--- | -- | - | ----: | | foo | ba | r | elbaT | I'd like the table to display in the center of my Markdown file instead of left-aligned. I am not ...

We would like to integrate images into our API documentation on Apiary, as a way of documenting the underlying application architecture or to illustrate sample workflows/sequence diagrams. However,...

I'm trying to document a query parameter in API Blueprint, but I'm not entirely sure if I have done it correctly. The resource looks like this: DELETE http://baasar.apiary-mock.com/user/{appId}/{u...

I am trying to develop application in cloud native way. I am trying have API first design of my application. Which API documentation tool should I use? which one is more suitable for API fir...

We have an API end point where an image file can be uploaded along with the name of the file (a string) as well as a description (string). Apiary / API Blueprints won't allow me to have something ...

How can I use generic named type in my API Blueprint definition? I try like this: FORMAT: 1A HOST: http://test.com/ # API Blueprint testing. ## Resource [/resources] ### Action [GET] + Respons...

I have a data structure defined as follows: # Data Structures ## PlayerRank (object) Represents the minimum amount of data the the client needs to send to give rank information about a particular...

My supposed solution for parameters section is + fields: [firstField, secondField] (array[enum], optional) + Members + firstField + secondField + extraField + dummyField But it failed on se...

I have been considering a documentation tool for building a backend for a web service to be used in multiple clients along with OAuth and possibility of multiple revisions. I already knew abo...

Does api blueprint or Apiary.io support the notion of versioning your API? In particular, I'm versioning my API via the URI like this: GET /api/v2/SomeResource/ In the example above, this means ...

I'm investigating the possibilities of the new Data Structures syntax in API Blueprint, especially MSON. Is it possible to attach or rather specify something like a pattern (regex)? Don't found any...

I have an issue similar to what is described here. I have a JSON that looks like this: { "photos": [ { "key": "y37dmj10jkwof/moOIUB8912JKVgh", "caption": "A world of gamers.", "tags": [ "ga...

I have created an API that delivers a resource named "Thumbnail" (/thumbnails) { "name": "toto", "uri": "http://xxx" } In other hand I have multiple resources that includes that Thumbnail reso...

I am editing some Apiary documentation on a project I am working on, and need to denote that a parameter to one of my API calls is a datetime string. Apiary seems to be choking on the formatting of...

I am just wondering exactly what the valid data types are when working with API Blueprints? The documentation seems unclear to me. More specifically, it says: type is the optional parameter typ...

I am trying to get different responses passing different parameters but something is not working. This is my API: ## Question [/questions/{question_id}] A Question object has the following attri...

I would like to document what the actual JSON fields themselves represent. I have documented the GET statement, and parameters but this does not make a complete documentation to give to users. So...

I am trying to define an API blueprint for a resource that utilises request headers to understand what content type to return. ## Offer [/offers/{offerCode}] + Parameters + offerCode: summer2015...

I am currently trying to depict a existing API with apiary.io. The system implements authentication via a login request that returns a http-cookie containing a session-id. As far as I know it is s...

I'm developing api documentation for a RESTful search API using Api Blueprint. I would like to be able to pass filters to the API so I can assemble: filter[filtername1]=filtervalue1 filter[filtern...

We are looking at using the API Blueprint. There are cases where we would like one request to return a proper response and another request to return an 'error' response such as a 400 bad request so...

I'm trying to document an endpoint with API Blueprint, using the new Attributes and DataStructures sections of the spec. My request payload looks like this: { "url": "http://requestb.in/11v7i7e1...

Consider the following relationship between two resources College has many Faculties Faculty belong to a College Obviously a Faculty is not a first class resource here. Now I need endpoints fo...

Where I can find the Facebook API in a format like http://swagger.io, https://apiblueprint.org or http://raml.org? I want to read and request the facebook server (api) "half-atomatic". My script k...

With the Rails Way of adding hashes in the parameter of an URL like so: http://api.example.com?person[first]=Jane&person[last]=Doe&person[email][email protected] How do I format th...