You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[joola](http://github.com/joola/joola) is an open-source data analytics and visualization framework.
6
6
To learn more about joola, installation, configuration and usage, please refer to our [wiki](http://github.com/joola/joola/wiki).
7
7
8
-
This guide describes the resources that make up the joola API.
8
+
This guide describes the resources that make up the joola API.
9
9
If you have any problems or requests please open an [issue](http://github.com/joola/joola/issues).
10
10
11
-
##Using This Guide
11
+
##Using This Guide
12
12
13
13
We will be using `http://localhost:8080` which is the default configuration for a fresh installation of joola.
14
14
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`.
16
16
Some actions will not be available in order to maintain system integrity.
17
17
18
18
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.
72
72
| `DELETE` | Used for deleting resources. |
73
73
74
74
##Authentication
75
-
There are three ways to authenticate through joola API.
75
+
There are three ways to authenticate through joola API.
76
76
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.
77
77
78
78
####Basic Authentication
@@ -156,7 +156,7 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
156
156
"name":"joola Framework Tests"
157
157
},
158
158
{
159
-
"key":"_stats",
159
+
"key":".joola-stats",
160
160
"description":"Stores internal statistics of joola",
161
161
"name":"Internal Stats"
162
162
},
@@ -170,8 +170,8 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
170
170
### Create a Workspace [POST]
171
171
+ Request (application/json; charset=utf-8)
172
172
173
-
{
174
-
"key": "workspace-name",
173
+
{
174
+
"key": "workspace-name",
175
175
"name": "Workspace Name"
176
176
}
177
177
@@ -181,7 +181,7 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
181
181
"key":"workspace-name",
182
182
"name":"Workspace Name",
183
183
"description":null
184
-
}
184
+
}
185
185
186
186
+Response500(application/json; charset=utf-8)
187
187
@@ -192,12 +192,12 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
192
192
+ Parameters
193
193
+ key (required, string, `workspace-name`) ... String `key` of the Workspace to perform action with. Has example value.
194
194
+ APIToken (optional, string, `apitoken-demo`) ... The `APIToken` of the user performing the action.
195
-
195
+
196
196
### Retrieve a Workspace [GET]
197
197
+Response200(application/json; charset=utf-8)
198
198
199
199
+ Body
200
-
200
+
201
201
{
202
202
"key":"workspace-name",
203
203
"name":"Workspace Name",
@@ -220,8 +220,8 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
220
220
+ Request (application/json; charset=utf-8)
221
221
222
222
{ "description": "workspace description" }
223
-
224
-
+ Response 200
223
+
224
+
+ Response 200
225
225
226
226
{
227
227
"key": "workspace-name",
@@ -236,11 +236,11 @@ Having multiple workspaces is the corner-stone for joola's multi-tenancy.
0 commit comments