Skip to content

Commit 2187b07

Browse files
committed
Finish v0.8.16
2 parents ee35a01 + b2190be commit 2187b07

31 files changed

+955
-679
lines changed

.travis.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
language: node_js
22
node_js:
3-
- "0.10"
3+
#- "0.10"
44
- "0.12"
5-
- "iojs"
6-
5+
- "4.1"
6+
77
services:
88
- redis-server
99
- rabbitmq
@@ -20,12 +20,12 @@ branches:
2020
matrix:
2121
fast_finish: true
2222
allow_failures:
23-
- node_js: "iojs"
23+
- node_js: "4.1"
2424
before_install:
2525
- wget http://apache.claz.org/zookeeper/zookeeper-3.4.6/zookeeper-3.4.6.tar.gz
2626
- tar -zxvf zookeeper*tar.gz
2727
- zookeeper-3.4.6/bin/zkServer.sh start zookeeper-3.4.6/conf/zoo_sample.cfg
28-
28+
2929
before_script:
3030
- sudo rabbitmq-plugins enable rabbitmq_stomp
3131
- sudo service rabbitmq-server restart
@@ -47,7 +47,7 @@ deploy:
4747
branch: master
4848
api_key:
4949
secure: u2sgcDddY6is6ZB1q1YsFQwlld0cvsSbfH6UtEVP7QvOeITriv2fauXnt+WTSzLqcLphzFPviUceMP9Qm4FcbKd1+qHHCAtpmZMTx7MXoFjJJXDVYwbL9iQURi5IS6lja8eLSJZk8yonDuWZ6f3babr/iW4o//CalslW5WDwHMs=
50-
50+
5151
- provider: npm
5252
email: info@joo.la
5353
api_key:
@@ -67,4 +67,4 @@ notifications:
6767
on_success: change
6868
on_failure: always
6969
slack:
70-
secure: t2zS47eGInF15sEnO8py3Mz+rkNmTs7RmGUkvJ73LYqURfJyxW2U703CT/RMVksksUzRiAB7VC5kq5ohYBcWXMRyaeL1Hw5IMexBoDaBYlmpw6o6UksoAUeOaphRIzBEePXUZfvsQoDEJIyvIOB6qe5E4mPC0cdqJhkJkFH1zPM=
70+
secure: t2zS47eGInF15sEnO8py3Mz+rkNmTs7RmGUkvJ73LYqURfJyxW2U703CT/RMVksksUzRiAB7VC5kq5ohYBcWXMRyaeL1Hw5IMexBoDaBYlmpw6o6UksoAUeOaphRIzBEePXUZfvsQoDEJIyvIOB6qe5E4mPC0cdqJhkJkFH1zPM=

apiary.apib

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ HOST: http://joola-develop.herokuapp.com
55
[joola](http://github.com/joola/joola) is an open-source data analytics and visualization framework.
66
To learn more about joola, installation, configuration and usage, please refer to our [wiki](http://github.com/joola/joola/wiki).
77

8-
This guide describes the resources that make up the joola API.
8+
This guide describes the resources that make up the joola API.
99
If you have any problems or requests please open an [issue](http://github.com/joola/joola/issues).
1010

11-
## Using This Guide
11+
## Using This Guide
1212

1313
We will be using `http://localhost:8080` which is the default configuration for a fresh installation of joola.
1414

15-
You can use the `Debugging Host` to execute requests against a valid, online joola instance we have put up for the purpose of this guide. A valid token for this purpose is `apitoken-demo`.
15+
You can use the `Debugging Host` to execute requests against a valid, online joola instance we have put up for the purpose of this guide. A valid token for this purpose is `apitoken-demo`.
1616
Some actions will not be available in order to maintain system integrity.
1717

1818
While we understand how naive we are with this request, please apply Fair Usage and avoid vandalism of the system as much as possible. The node serving this guide will recycle every hour.
@@ -72,7 +72,7 @@ joola API uses the following Verbs.
7272
| `DELETE` | Used for deleting resources. |
7373

7474
## Authentication
75-
There are three ways to authenticate through joola API.
75+
There are three ways to authenticate through joola API.
7676
Requests that require authentication will return 404 Not Found, instead of 403 Forbidden, in some places. This is to prevent the accidental leakage of private information to unauthorized users.
7777

7878
#### Basic Authentication
@@ -156,7 +156,7 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
156156
"name": "joola Framework Tests"
157157
},
158158
{
159-
"key": "_stats",
159+
"key": ".joola-stats",
160160
"description": "Stores internal statistics of joola",
161161
"name": "Internal Stats"
162162
},
@@ -170,8 +170,8 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
170170
### Create a Workspace [POST]
171171
+ Request (application/json; charset=utf-8)
172172

173-
{
174-
"key": "workspace-name",
173+
{
174+
"key": "workspace-name",
175175
"name": "Workspace Name"
176176
}
177177

@@ -181,7 +181,7 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
181181
"key": "workspace-name",
182182
"name": "Workspace Name",
183183
"description": null
184-
}
184+
}
185185

186186
+ Response 500 (application/json; charset=utf-8)
187187

@@ -192,12 +192,12 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
192192
+ Parameters
193193
+ key (required, string, `workspace-name`) ... String `key` of the Workspace to perform action with. Has example value.
194194
+ APIToken (optional, string, `apitoken-demo`) ... The `APIToken` of the user performing the action.
195-
195+
196196
### Retrieve a Workspace [GET]
197197
+ Response 200 (application/json; charset=utf-8)
198198

199199
+ Body
200-
200+
201201
{
202202
"key": "workspace-name",
203203
"name": "Workspace Name",
@@ -220,8 +220,8 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
220220
+ Request (application/json; charset=utf-8)
221221

222222
{ "description": "workspace description" }
223-
224-
+ Response 200
223+
224+
+ Response 200
225225

226226
{
227227
"key": "workspace-name",
@@ -236,11 +236,11 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
236236
+ Response 403 (application/json; charset=utf-8)
237237

238238
{ "message": "forbidden.", "documentation_url": "http://github.com/joola/joola/wiki" }
239-
239+
240240
+ Response 415 (application/json; charset=utf-8)
241241

242242
{ "message": "unsupported media type.", "documentation_url": "http://github.com/joola/joola/wiki" }
243-
243+
244244
+ Response 500 (application/json; charset=utf-8)
245245

246246
{ "message": "role [{key}] does not exist.", "documentation_url": "http://github.com/joola/joola/wiki" }
@@ -249,7 +249,7 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
249249
+ Response 200
250250

251251
{}
252-
252+
253253
+ Response 401 (application/json; charset=utf-8)
254254

255255
{ "message": "missing permission.", "documentation_url": "http://github.com/joola/joola/wiki" }

0 commit comments

Comments
 (0)