Stack Overflow
Stack Overflow

Questions tagged [apiary.io]

Next generation platform for building and using REST APIs.

158 questions
3
votes
1 answer

Rendering attributes on aglio?

I'm new to aglio I was trying to render attributes for my documentation, but it does not work. ## Modify User [/users/{id}.json?{token}=API_TOKEN] Modify any accessible fields if authorized ### Modify User [PUT] + Parameters + id: 1 (required,…
Jonathan Bouchard
  • 423
  • 4
  • 13
3
votes
1 answer

Apiary API endpoint returning null data when called from web

I have a mock API in Apiary where if I hit my endpoint with cURL or just in the browser, it returns: [ { "id": 1, "user_id": 1, "status": "Review" "name": "New York Songwriter", "negotiable": true, "description": "", "created_at":…
Cassidy Williams
  • 2,840
  • 2
  • 34
  • 62
3
votes
1 answer

How to document Webhooks in Apiary/API Blueprint

I'm just starting with api blueprint, using apiary to generate the docs for our api. We have both a REST api and a number of webhooks. The REST api is easy enough to create, but I can't figure out how best to generate the documentation for the…
CTC
  • 431
  • 1
  • 7
  • 18
3
votes
1 answer

How to show an optional header in markdown for apiary?

How to indicate that one particular header of a request is optional with the markdown of apiary? My code: Request The apiKey can be passed in the header (note the camelcase for "apiKey") The Content-Encoding: gzip is optional, only if you gzip the…
seinecle
  • 8,419
  • 13
  • 55
  • 107
3
votes
1 answer

Blueprint array of objects (apiary)

I'm trying to describe array of objects with syntax based on this answer + Response 200 (application/json) + Attributes + time (object, required) + default (string, required) - `HH:MM` default time + times (array,…
Aleš Oskar Kocur
  • 1,189
  • 1
  • 10
  • 26
3
votes
1 answer

MSON specifying a date-time

How can the following MSON output a schema with "format":"date-time", similar to the stated below? Mson: FORMAT: 1A # Some API ## series [/api/v1/series] Returns a list of series. ### View all series [GET] + Response 200 (application/json;…
user1990009
  • 685
  • 6
  • 13
3
votes
1 answer

How do you specify request body attributes in Apiary.io / API Blueprint?

I'm trying to figure out how to describe/define the request body attributes/parameters for POST/PUT. Here is an example of what I'm trying to do, but I can't find it anywhere in the documentation (I wish there was a way to view the markdown of any…
booshong
  • 687
  • 5
  • 20
3
votes
2 answers

Dredd testing of APIary calls returning an image / PNG

Dredd tests of APIary calls returning an image / PNG fail. Is it possible to check not the content of the returned image but just that there is an image not null as response? Here is the output of my test: [31mfail [39m: GET…
user3328145
  • 51
  • 5
3
votes
2 answers

API Bluprint documentation of query string parameters with Rails' array notation

I'm not having much luck trying to use resourceful documentation for an API URI which uses Rails' array parameter notation For example (the unencoded URL for clarity): /api/v2/profiles?ids[]=35&ids[]=47&ids[]=12&ids[]=132 and the actual encoded…
James H
  • 1,607
  • 20
  • 22
3
votes
1 answer

Reuse a resource model as an array

I'm documenting an API and I have 2 responses very similar. One of them is the call /resource/{id}. This response returns a resource model. The other call is /resource/search{?name,category} which returns a list of resources so I need to return an…
Germán Lena
  • 847
  • 1
  • 6
  • 15
3
votes
1 answer

What is the convention to specify data types of attributes in apiary.io markdown?

The apiary.io list resource attributes in point form. Is there a specific convention to show what data type these attributes are, or met data specifying formats?
Jev Björsell
  • 831
  • 9
  • 23
3
votes
1 answer

Encoded request bodies in Blueprint at apiary.io

We have one existing API, which we're trying to build a Blueprint for, that requires certain request bodies to be URI-encoded JSON. Is there some way to specify a body as "like this, but encoded"? Existing (mere text) documentation just shows the…
jackr
  • 1,346
  • 1
  • 13
  • 29
2
votes
1 answer

Api blueprint failing with dredd on a realtime api?

I am in the middle of upgrading dredd from 1.08 to the latest version, while at it, I am trying to validate our api documentation, written in blueprint with the realtime test api and it is failing. Since the tests are running against a real time…
Nauman Bashir
  • 1,672
  • 3
  • 17
  • 25
2
votes
2 answers

Dredd / apiary / MSON array of any size

we're struggling describing an array of any size in our API. Using API Blueprint and MSON format for Dredd testing. Endpoint /spots should return an array of "Spots" (those are objects). We don't know how many though. Currently we have only been…
vicdup
  • 149
  • 4
2
votes
1 answer

How can I specify a shared Headers section across all Apiary/Blueprint API requests?

I have a large API document and each request has the same request headers like Accept: application/json and Cookies: SessionID. Is there a way I can declare these globally to avoid the duplication?
Art
  • 5,704
  • 3
  • 28
  • 32
1 2
3
…
10 11