Permalink
Browse files

Finish v0.8.16

  • Loading branch information...
itayw committed Dec 1, 2015
2 parents ee35a01 + b2190be commit 2187b073ce2ef65dcd5c08268060bb396b3f23f7
View
@@ -1,9 +1,9 @@
language: node_js
node_js:
- "0.10"
#- "0.10"
- "0.12"
- "iojs"
- "4.1"
services:
- redis-server
- rabbitmq
@@ -20,12 +20,12 @@ branches:
matrix:
fast_finish: true
allow_failures:
- node_js: "iojs"
- node_js: "4.1"
before_install:
- wget http://apache.claz.org/zookeeper/zookeeper-3.4.6/zookeeper-3.4.6.tar.gz
- tar -zxvf zookeeper*tar.gz
- zookeeper-3.4.6/bin/zkServer.sh start zookeeper-3.4.6/conf/zoo_sample.cfg
before_script:
- sudo rabbitmq-plugins enable rabbitmq_stomp
- sudo service rabbitmq-server restart
@@ -47,7 +47,7 @@ deploy:
branch: master
api_key:
secure: u2sgcDddY6is6ZB1q1YsFQwlld0cvsSbfH6UtEVP7QvOeITriv2fauXnt+WTSzLqcLphzFPviUceMP9Qm4FcbKd1+qHHCAtpmZMTx7MXoFjJJXDVYwbL9iQURi5IS6lja8eLSJZk8yonDuWZ6f3babr/iW4o//CalslW5WDwHMs=
- provider: npm
email: info@joo.la
api_key:
@@ -67,4 +67,4 @@ notifications:
on_success: change
on_failure: always
slack:
secure: t2zS47eGInF15sEnO8py3Mz+rkNmTs7RmGUkvJ73LYqURfJyxW2U703CT/RMVksksUzRiAB7VC5kq5ohYBcWXMRyaeL1Hw5IMexBoDaBYlmpw6o6UksoAUeOaphRIzBEePXUZfvsQoDEJIyvIOB6qe5E4mPC0cdqJhkJkFH1zPM=
secure: t2zS47eGInF15sEnO8py3Mz+rkNmTs7RmGUkvJ73LYqURfJyxW2U703CT/RMVksksUzRiAB7VC5kq5ohYBcWXMRyaeL1Hw5IMexBoDaBYlmpw6o6UksoAUeOaphRIzBEePXUZfvsQoDEJIyvIOB6qe5E4mPC0cdqJhkJkFH1zPM=
View
@@ -5,14 +5,14 @@ HOST: http://joola-develop.herokuapp.com
[joola](http://github.com/joola/joola) is an open-source data analytics and visualization framework.
To learn more about joola, installation, configuration and usage, please refer to our [wiki](http://github.com/joola/joola/wiki).
This guide describes the resources that make up the joola API.
This guide describes the resources that make up the joola API.
If you have any problems or requests please open an [issue](http://github.com/joola/joola/issues).
## Using This Guide
## Using This Guide
We will be using `http://localhost:8080` which is the default configuration for a fresh installation of joola.
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`.
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`.
Some actions will not be available in order to maintain system integrity.
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.
| `DELETE` | Used for deleting resources. |
## Authentication
There are three ways to authenticate through joola API.
There are three ways to authenticate through joola API.
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.
#### Basic Authentication
@@ -156,7 +156,7 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
"name": "joola Framework Tests"
},
{
"key": "_stats",
"key": ".joola-stats",
"description": "Stores internal statistics of joola",
"name": "Internal Stats"
},
@@ -170,8 +170,8 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
### Create a Workspace [POST]
+ Request (application/json; charset=utf-8)
{
"key": "workspace-name",
{
"key": "workspace-name",
"name": "Workspace Name"
}
@@ -181,7 +181,7 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
"key": "workspace-name",
"name": "Workspace Name",
"description": null
}
}
+ Response 500 (application/json; charset=utf-8)
@@ -192,12 +192,12 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
+ Parameters
+ key (required, string, `workspace-name`) ... String `key` of the Workspace to perform action with. Has example value.
+ APIToken (optional, string, `apitoken-demo`) ... The `APIToken` of the user performing the action.
### Retrieve a Workspace [GET]
+ Response 200 (application/json; charset=utf-8)
+ Body
{
"key": "workspace-name",
"name": "Workspace Name",
@@ -220,8 +220,8 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
+ Request (application/json; charset=utf-8)
{ "description": "workspace description" }
+ Response 200
+ Response 200
{
"key": "workspace-name",
@@ -236,11 +236,11 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
+ Response 403 (application/json; charset=utf-8)
{ "message": "forbidden.", "documentation_url": "http://github.com/joola/joola/wiki" }
+ Response 415 (application/json; charset=utf-8)
{ "message": "unsupported media type.", "documentation_url": "http://github.com/joola/joola/wiki" }
+ Response 500 (application/json; charset=utf-8)
{ "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.
+ Response 200
{}
+ Response 401 (application/json; charset=utf-8)
{ "message": "missing permission.", "documentation_url": "http://github.com/joola/joola/wiki" }
Oops, something went wrong.

0 comments on commit 2187b07

Please sign in to comment.