Newer
Older
info:
description: This cube is the new api which will be integrated in CubicWeb 4.
license:
name: LGPL
url: https://www.gnu.org/licenses/lgpl-3.0.en.html
contact:
name: LOGILAB S.A. (Paris, FRANCE)
url: https://forge.extranet.logilab.fr/cubicweb/cubes/api
email: contact@logilab.fr
title: CubicWeb API
version: 0.1.0
paths:
/schema:
x-pyramid-route-name: schema
get:
description: Returns this instance's Schema
responses:
'200':
description: This instance's Schema
content:
application/json:
schema:
$ref: '#/components/schemas/CWSchema'
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/binary:
x-pyramid-route-name: binary
get:
description: Downloads the given binary
parameters:
- in: query
name: eid
schema:
type: integer
required: true
description: ID of the entity with the Binary data as attribute
- in: query
name: attribute
schema:
type: string
pattern: '^[a-z_][a-z0-9_]+$'
required: true
description: Name of the attribute containing the binary
responses:
'200':
description: The binary data
content:
application/octet-stream:
schema:
type: string
format: binary
'400':
description: The parameters are not valid
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
'204':
description: No file associated with the relation
/rql:
x-pyramid-route-name: rql
post:
description: Executes the given RQL query
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RqlParams'
responses:
'200':
description: The RQL result set
content:
application/json:
schema:
'400':
description: The given RQL was badly formatted
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
/transaction:
x-pyramid-route-name: transaction
post:
description: Execute several queries in a single transaction
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/RqlTransactionParams'
responses:
'200':
description: This instance's Schema
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ResultSet'
/login:
x-pyramid-route-name: login
post:
description: Tries to log in the user
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoginParams'
responses:
'204':
description: Token has been created and returned in set-cookie header
headers:
Set-Cookie:
description: The created JWT
schema:
type: string
'401':
description: THe given login/password combo was not recognized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
/current-user:
x-pyramid-route-name: current_user
get:
description: Get information about the user making the request
responses:
'200':
description: This instance's Schema
content:
application/json:
schema:
$ref: '#/components/schemas/CurrentUser'
/siteinfo:
x-pyramid-route-name: siteinfo
get:
description: Get debug information for the current website
responses:
'200':
description: This instance's Schema
content:
application/json:
schema:
$ref: '#/components/schemas/SiteInfo'
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
openapi: 3.0.3
components:
schemas:
CWSchema:
type: object
properties:
entities:
type: array
items:
type: object
properties:
type:
type: string
description:
type: string
final:
type: boolean
relations_definitions:
type: array
items:
type: object
properties:
type:
type: string
description:
type: string
final:
type: boolean
subject:
type: string
object:
type: string
cardinality:
type: string
constraints:
type: array
nullable: true
default:
type: string
nullable: true
RqlParams:
type: object
properties:
query:
type: string
minLength: 1
params:
type: object
default: {}
additionalProperties:
$ref: '#/components/schemas/RqlParamsValue'
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
RqlParamsValue:
oneOf:
- type: string
nullable: true
- type: number
- type: boolean
RqlTransactionParams:
type: object
properties:
query:
type: string
minLength: 1
params:
type: object
default: {}
additionalProperties:
$ref: '#/components/schemas/RqlTransactionParamsValue'
required:
- query
RqlTransactionParamsValue:
oneOf:
- type: string
nullable: true
- type: number
- type: boolean
- type: object
properties:
queryIndex:
type: number
row:
type: number
column:
type: number
additionalProperties: false
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
LoginParams:
type: object
properties:
password:
type: string
minLength: 1
login:
type: string
minLength: 1
required:
- login
- password
ErrorSchema:
type: object
properties:
code:
type: integer
title:
type: string
error:
type: object
properties:
data:
type: object
message:
type: string
title:
type: string
required:
- message
- title
required:
- code
- title
- error
ResultSet:
type: array
items:
type: array
items:
oneOf:
- type: 'string'
nullable: true
- type: 'number'
- type: 'boolean'
CurrentUser:
type: object
nullable: true
properties:
eid:
type: integer
login:
type: string
dcTitle:
type: string
required:
- eid
- login
- dcTitle
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
SiteInfo:
type: object
properties:
info:
type: object
properties:
pyvalue:
properties:
base_url:
type: string
config_mode:
type: string
config_type:
type: string
cubes:
type: object
cubicweb:
type: array
items:
type: integer
datadir_url:
type: string
nullable: true
instance_home:
type: string
type: object
stats:
type: object
properties:
available_cnxsets:
type: integer
nb_active_threads:
type: integer
rqlt_st_cache_hit:
type: integer
rqlt_st_cache_miss:
type: integer
rqlt_st_cache_size:
type: object
properties:
maxsize:
type: integer
size:
type: integer
sql_cache_hit:
type: integer
sql_cache_miss:
type: integer
sql_cache_size:
properties:
maxsize:
type: integer
size:
type: integer
type: object
sql_no_cache:
type: integer
threads:
type: array
items:
type: string
type_cache_size:
type: integer
registry:
type: object
gc:
type: object
properties:
lookupclasses:
type: array
items:
type: array
items:
type: string
referenced:
type: array
items:
type: array
items:
type: string
unreachable:
type: array