Skip to content

Commit

Permalink
Finish v0.8.16
Browse files Browse the repository at this point in the history
  • Loading branch information
itayw committed Dec 1, 2015
2 parents ee35a01 + b2190be commit 2187b07
Show file tree
Hide file tree
Showing 31 changed files with 955 additions and 679 deletions.
14 changes: 7 additions & 7 deletions .travis.yml
@@ -1,9 +1,9 @@
language: node_js language: node_js
node_js: node_js:
- "0.10" #- "0.10"
- "0.12" - "0.12"
- "iojs" - "4.1"

services: services:
- redis-server - redis-server
- rabbitmq - rabbitmq
Expand All @@ -20,12 +20,12 @@ branches:
matrix: matrix:
fast_finish: true fast_finish: true
allow_failures: allow_failures:
- node_js: "iojs" - node_js: "4.1"
before_install: before_install:
- wget http://apache.claz.org/zookeeper/zookeeper-3.4.6/zookeeper-3.4.6.tar.gz - wget http://apache.claz.org/zookeeper/zookeeper-3.4.6/zookeeper-3.4.6.tar.gz
- tar -zxvf zookeeper*tar.gz - tar -zxvf zookeeper*tar.gz
- zookeeper-3.4.6/bin/zkServer.sh start zookeeper-3.4.6/conf/zoo_sample.cfg - zookeeper-3.4.6/bin/zkServer.sh start zookeeper-3.4.6/conf/zoo_sample.cfg

before_script: before_script:
- sudo rabbitmq-plugins enable rabbitmq_stomp - sudo rabbitmq-plugins enable rabbitmq_stomp
- sudo service rabbitmq-server restart - sudo service rabbitmq-server restart
Expand All @@ -47,7 +47,7 @@ deploy:
branch: master branch: master
api_key: api_key:
secure: u2sgcDddY6is6ZB1q1YsFQwlld0cvsSbfH6UtEVP7QvOeITriv2fauXnt+WTSzLqcLphzFPviUceMP9Qm4FcbKd1+qHHCAtpmZMTx7MXoFjJJXDVYwbL9iQURi5IS6lja8eLSJZk8yonDuWZ6f3babr/iW4o//CalslW5WDwHMs= secure: u2sgcDddY6is6ZB1q1YsFQwlld0cvsSbfH6UtEVP7QvOeITriv2fauXnt+WTSzLqcLphzFPviUceMP9Qm4FcbKd1+qHHCAtpmZMTx7MXoFjJJXDVYwbL9iQURi5IS6lja8eLSJZk8yonDuWZ6f3babr/iW4o//CalslW5WDwHMs=

- provider: npm - provider: npm
email: info@joo.la email: info@joo.la
api_key: api_key:
Expand All @@ -67,4 +67,4 @@ notifications:
on_success: change on_success: change
on_failure: always on_failure: always
slack: slack:
secure: t2zS47eGInF15sEnO8py3Mz+rkNmTs7RmGUkvJ73LYqURfJyxW2U703CT/RMVksksUzRiAB7VC5kq5ohYBcWXMRyaeL1Hw5IMexBoDaBYlmpw6o6UksoAUeOaphRIzBEePXUZfvsQoDEJIyvIOB6qe5E4mPC0cdqJhkJkFH1zPM= secure: t2zS47eGInF15sEnO8py3Mz+rkNmTs7RmGUkvJ73LYqURfJyxW2U703CT/RMVksksUzRiAB7VC5kq5ohYBcWXMRyaeL1Hw5IMexBoDaBYlmpw6o6UksoAUeOaphRIzBEePXUZfvsQoDEJIyvIOB6qe5E4mPC0cdqJhkJkFH1zPM=
30 changes: 15 additions & 15 deletions apiary.apib
Expand Up @@ -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. [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). 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). 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. 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. 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. 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.
Expand Down Expand Up @@ -72,7 +72,7 @@ joola API uses the following Verbs.
| `DELETE` | Used for deleting resources. | | `DELETE` | Used for deleting resources. |


## Authentication ## 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. 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 #### Basic Authentication
Expand Down Expand Up @@ -156,7 +156,7 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
"name": "joola Framework Tests" "name": "joola Framework Tests"
}, },
{ {
"key": "_stats", "key": ".joola-stats",
"description": "Stores internal statistics of joola", "description": "Stores internal statistics of joola",
"name": "Internal Stats" "name": "Internal Stats"
}, },
Expand All @@ -170,8 +170,8 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
### Create a Workspace [POST] ### Create a Workspace [POST]
+ Request (application/json; charset=utf-8) + Request (application/json; charset=utf-8)


{ {
"key": "workspace-name", "key": "workspace-name",
"name": "Workspace Name" "name": "Workspace Name"
} }


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


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


Expand All @@ -192,12 +192,12 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
+ Parameters + Parameters
+ key (required, string, `workspace-name`) ... String `key` of the Workspace to perform action with. Has example value. + 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. + APIToken (optional, string, `apitoken-demo`) ... The `APIToken` of the user performing the action.

### Retrieve a Workspace [GET] ### Retrieve a Workspace [GET]
+ Response 200 (application/json; charset=utf-8) + Response 200 (application/json; charset=utf-8)


+ Body + Body

{ {
"key": "workspace-name", "key": "workspace-name",
"name": "Workspace Name", "name": "Workspace Name",
Expand All @@ -220,8 +220,8 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
+ Request (application/json; charset=utf-8) + Request (application/json; charset=utf-8)


{ "description": "workspace description" } { "description": "workspace description" }

+ Response 200 + Response 200


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


{ "message": "forbidden.", "documentation_url": "http://github.com/joola/joola/wiki" } { "message": "forbidden.", "documentation_url": "http://github.com/joola/joola/wiki" }

+ Response 415 (application/json; charset=utf-8) + Response 415 (application/json; charset=utf-8)


{ "message": "unsupported media type.", "documentation_url": "http://github.com/joola/joola/wiki" } { "message": "unsupported media type.", "documentation_url": "http://github.com/joola/joola/wiki" }

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


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


{} {}

+ Response 401 (application/json; charset=utf-8) + Response 401 (application/json; charset=utf-8)


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

0 comments on commit 2187b07

Please sign in to comment.