-
Notifications
You must be signed in to change notification settings - Fork 3
/
openapi.yaml
380 lines (380 loc) · 9.46 KB
/
openapi.yaml
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
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
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
376
377
378
379
380
openapi: 3.0.2
info:
title: QuantumTranspiler API
description: This is the API Specification of the QuantumTranspiler
version: "1.0"
servers:
- url: /
tags:
- name: api
description: All QuantumTranspiler operations
paths:
/circuit_to_internal:
post:
tags:
- api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ImportRequest'
example:
option: OpenQASM
circuit: |-
OPENQASM 2.0;
include "qelib1.inc";
qreg q[2];
creg c[2];
h q[0];
h q[1];
cx q[0],q[1];
measure q[0] -> c[0];
measure q[1] -> c[1];
required: true
responses:
"200":
description: OK
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/export_circuit:
post:
tags:
- api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExportRequest'
example:
option: Cirq-JSON
circuit: |-
qc = QuantumCircuit(2,2)
qc.h(0)
qc.h(1)
qc.cx(0, 1)
qc.measure(0, 0)
qc.measure(1, 1)
required: true
responses:
"200":
description: OK
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/convert:
post:
tags:
- api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConversionRequest'
example:
option: OpenQASM
optionOutput: Cirq-JSON
circuit: |-
OPENQASM 2.0;
include "qelib1.inc";
qreg q[2];
creg c[2];
h q[0];
h q[1];
cx q[0],q[1];
measure q[0] -> c[0];
measure q[1] -> c[1];
required: true
responses:
"200":
description: OK
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/unroll:
post:
tags:
- api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UnrollRequest'
example:
option: IBMQ
circuit: |-
qc = QuantumCircuit(2,2)
qc.h(0)
qc.h(1)
qc.cx(0, 1)
qc.measure(0, 0)
qc.measure(1, 1)
isExpert: true
format: Qiskit
required: true
responses:
"200":
description: OK
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/simulate:
post:
tags:
- api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SimulationRequest'
example:
circuit: |-
qc = QuantumCircuit(2,2)
qc.h(0)
qc.h(1)
qc.cx(0, 1)
qc.measure(0, 0)
qc.measure(1, 1)
required: true
responses:
"200":
description: OK
content:
application/json:
example:
"10": 750
"01": 250
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/depth:
post:
tags:
- api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DepthRequest'
example:
circuit: |-
qc = QuantumCircuit(2,2)
qc.h(0)
qc.h(1)
qc.cx(0, 1)
qc.measure(0, 0)
qc.measure(1, 1)
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DepthResponse'
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/depth_comparison_qpu:
post:
tags:
- api
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DepthRequest'
example:
circuit: |-
qc = QuantumCircuit(2,2)
qc.h(0)
qc.h(1)
qc.cx(0, 1)
qc.measure(0, 0)
qc.measure(1, 1)
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DepthResponse'
"422":
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Error:
type: object
properties:
status:
type: string
description: Error name
code:
type: integer
description: Error code
errors:
type: object
description: Errors
message:
type: string
description: Error message
PaginationMetadata:
type: object
properties:
total:
type: integer
total_pages:
type: integer
first_page:
type: integer
last_page:
type: integer
page:
type: integer
previous_page:
type: integer
next_page:
type: integer
ImportRequest:
type: object
properties:
circuit:
type: string
option:
type: string
ExportRequest:
type: object
properties:
circuit:
type: string
option:
type: string
ConversionRequest:
type: object
properties:
circuit:
type: string
option:
type: string
optionOutput:
type: string
UnrollRequest:
type: object
properties:
circuit:
type: string
option:
type: string
format:
type: string
isExpert:
type: boolean
SimulationRequest:
type: object
properties:
circuit:
type: string
DepthRequest:
type: object
properties:
circuit:
type: string
DepthResponse:
type: object
properties:
r_gate_times:
type: integer
s_two_qubit:
type: integer
q_two_qubit:
type: integer
r_depth:
type: integer
q_gate_times:
type: integer
r_two_qubit:
type: integer
q_depth:
type: integer
s_depth:
type: integer
s_gate_times:
type: integer
responses:
UNPROCESSABLE_ENTITY:
description: Unprocessable Entity
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
DEFAULT_ERROR:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'