Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
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
198
199
200
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
235
236
237
238
239
240
241
242
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'
/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:
type: array
items:
type: object
'400':
description: The given RQL was badly formatted
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
/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'
/transaction/begin:
x-pyramid-route-name: transaction/begin
post:
description: Starts a new transaction
responses:
'200':
description: The transaction's uuid
content:
application/json:
schema:
type: string
/transaction/execute:
x-pyramid-route-name: transaction/execute
post:
description: Executes the given rql query as part of a transaction
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionExecuteParams'
responses:
'200':
description: The RQL result set
content:
application/json:
schema:
type: array
items:
type: object
'400':
description: The given RQL was badly formatted
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorSchema'
/transaction/commit:
x-pyramid-route-name: transaction/commit
post:
description: Commits a transaction
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionParams'
responses:
'200':
description: The transaction was successful
/transaction/rollback:
x-pyramid-route-name: transaction/rollback
post:
description: Rollback a transaction
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionParams'
responses:
'200':
description: The transaction rollback was successful
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:
nullable: true
required:
- query
LoginParams:
type: object
properties:
password:
type: string
minLength: 1
login:
type: string
minLength: 1
required:
- login
- password
TransactionParams:
type: object
properties:
uuid:
type: string
minLength: 32
required:
- uuid
TransactionExecuteParams:
type: object
properties:
query:
type: string
minLength: 1
params:
type: object
default: {}
additionalProperties:
nullable: true
uuid:
type: string
minLength: 32
required:
- query
- uuid
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