Next generation platform for building and using REST APIs.
Questions tagged [apiary]
138 questions
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
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
2 answers
Need to send request to API every 2 seconds after promise is resolved, runs in finite loop
I will try my best to explain my problem.
I have javascript Promise, 2 API and setTimeout in action.
$.each(result[1], function(i, coin) {
var coincalcClass = new coincalculationClass();
// this method returns a promise.
…
sungazerr
- 45
- 5
1
vote
0 answers
How can I pass an object as parameter to apiary?
I tried to pass an object as parameter to apiary, but it doesn't work correctly. I am a new user to apiary editor and I need your help!
The request body is:
{
callbackUrl = "http://test.com",
dlr = true,
option1 = "option 1",
option2…
Olivia K.
- 11
- 1
1
vote
1 answer
How to specify a JSON object with string values in MSON / API Blueprint?
I have been looking through the examples a lot but I didn't find a way to specify a property whose value is a JSON object with strings as values. I have an object like this:
{
id: 123,
title: "I am a title",
dynamic_attributes: {
"key1":…
user1915201
- 103
- 1
- 9
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
0 answers
Apiary multipart/form-data
I have tried creating an Apiary request with multipart/form-data, which seems alright, except when I try actually sending it via the console on Apiary to an existing (and functional) endpoint written in Node.js using async-busboy I'm getting back…
Petr Vnenk
- 131
- 1
- 6
1
vote
1 answer
Is there a best practice in apiary blueprint to specify field length (size) / format?
If using MSON, the only way I see to currently include field length would be to include as part of the description. Are there any plans to add support for this or are there any best practices (workarounds) being used for this purpose?
as an…
Greg Roll
- 36
- 3
1
vote
1 answer
How to provide mock data for Apiary Mock Server?
apiary service provides Mock Server, that is generated based on API description written either in API Blueprint or Swagger syntax.
In my API description I have an action returning collection of data. This collection is large, so there is filtering…
EvAlex
- 2,888
- 1
- 20
- 24
1
vote
1 answer
Unable to fetch apiary.apib using the apiary CLI fetch command (even though i am using my apiary access token)
I am trying to fetch my apiary documentation (on the apiary server) to my local drive. I am the owner of the API and have access to the Settings button (I thought maybe this is important since i get a 403 forbidden response in the end, see below).…
Shachar R
- 311
- 1
- 2
- 8