Stack Overflow
Stack Overflow

Questions tagged [apiary.io]

Next generation platform for building and using REST APIs.

162 questions
2
votes
1 answer

Apiary multiple response

I'm documenting my api with Apiary and I'm using the old syntax of the blueprint. I read somewhere about the separation of different responses with "+++++", but I do not know how to tell when apiary to use my first or second response.
Lachezar Todorov
  • 903
  • 9
  • 21
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
1 answer

Why is my json response not conforming to my struct?

I have made a simple api to test on apiary, I have created a struct for the response. But when the call is made and I try to make it conform to my struct for some reason I do not get the body and only get the header. I would like to get the little…
Ace
  • 603
  • 2
  • 15
  • 33
1
vote
1 answer

Dredd - How to modify test result based on http status code?

I am developing an API, using apiary.io and Swagger. I want to test the API using dredd, and for normal API responses (HTTP status code 200) this is fine. However, when the API returns different status code based on parameters (e.g. 403), dredd…
pkExec
  • 1,752
  • 1
  • 20
  • 39
1
vote
1 answer

Connect apiary.io REST API v1+ in Google Data Studio

I need to connect apiary.io REST API v1+ to Google Data Studio. As I checked, I need to develop a connector with JavaScript in Google Apps Script, as I checked in these tutorials Connect and visualize all your data in Data Studio and External APIs…
Rafael Lima
  • 420
  • 1
  • 5
  • 16
1
vote
0 answers

How to get application token to download attachments in an Apiary API?

Using an Apiary backed API (Everhour) to try and download reports, the docs say that I should be able to download attachments using the attachment token, but they dont state how I can figure out an application token itself. Tried using info like the…
A. Nigam
  • 129
  • 2
  • 6
1
vote
1 answer

Can "Introduction" and "Reference" headings in Apiary.io API documentation editor be suppressed or modified?

By default, https://apiary.io/ adds "Introduction" and "Reference" headings to API documentation. The headings are not visible in the built-in Editor and it does not seem to be possible to suppress them or to add more headings in the same style. I'm…
Fergal McGrath
  • 11
  • 1
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

Remove fork on github apiary

Is there a way to remove the fork on github from apiary? I've tried targeting the css classes with display none. It still shows on the page. .row.tocColumnTool.forkOnGitHub{ display: none; }
T.J.
  • 415
  • 3
  • 17
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

How do I add documentation / description to a Header parameter?

For the Headers section, I need to describe what each header parameter / field / entry is. How would I go about doing that? Currently, my Headers section looks like this: + Headers Access-Token: access_token # Server-generated Access Token…
Daksh
  • 1,177
  • 2
  • 18
  • 28
1
vote
0 answers

How to add file attribute in request body?

I'm trying to document API through apiary.io and I want to add the following request body where there is a file in the form of key-value pair: How can I add this file in request body in apiary?
S.Dan
  • 1,826
  • 5
  • 28
  • 55
1
vote
0 answers

Describing object's keys with MSON

I have API that looks like this. The products object contains Product IDs (keys) and their amount in basket (values). { "id": "0a4d44aa-2ace-11e7-93ae-92361f002671", "products": { 4 => 3, // product with ID 4 is 3x in basket …
Grez
  • 306
  • 3
  • 8
1
vote
3 answers

API Blueprint: Semantic Issue "no value(s) specified"

In my blueprint I'm defining a data structure and try to use it like so + Attributes + error: (Error Details, required) Data structure definition at the end of the document: # Data Structures ## Error Details + code : 1234 (number, required)…
Marcus Ilgner
  • 6,935
  • 2
  • 30
  • 44
1 2 3
…
10 11