-
Notifications
You must be signed in to change notification settings - Fork 2
/
openapi.yaml
453 lines (453 loc) · 15.1 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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
openapi: 3.0.2
info:
title: forest-service
description: This is the API Specification of the forest-service (https://github.com/UST-QuAntiL/forest-service).
version: "0.1"
servers:
- url: /
tags:
- name: Transpile
description: "Send implementation, input, QPU information, and your access token\
\ to the API to get analyzed properties of the transpiled circuit itself."
- name: Execute
description: "Send implementation, input, QPU information, and your access token\
\ to the API to execute your circuit and get the result."
- name: Analysis of Original Circuit
description: Request an analysis of the original circuit.
- name: Results
description: Get execution results of an executed circuit.
- name: Generated Circuits
description: Request a generated circuit and its properties.
- name: Generate Circuit
description: Send implementation and input parameters to the API to generate your
circuit and get its properties.
paths:
/forest-service/api/v1.0/transpile:
post:
tags:
- Transpile
description: "*Note*: \"token\" should either be in \"input-params\" or extra.\
\ *Note*: \"url\", \"hub\", \"group\", \"project\" are optional such that\
\ otherwise the standard values are used."
requestBody:
description: " Transpile via URL:\n \"impl-url\"\
: \"URL-OF-IMPLEMENTATION\" \n Transpile via data:\n \
\ \"impl-data\": \"BASE64-ENCODED-IMPLEMENTATION\"\n \
\ the \"input-params\"are of the form:\n \"\
input-params\": {\n \"PARAM-NAME-1\": {\n \
\ \"rawValue\": \"YOUR-VALUE-1\",\n \
\ \"type\": \"Integer\"\n },\n \
\ \"PARAM-NAME-2\": {\n \"rawValue\"\
: \"YOUR-VALUE-2\",\n \"type\": \"String\"\n\
\ },\n ...\n \
\ \"token\": {\n \"rawValue\": \"YOUR-IBMQ-TOKEN\"\
,\n \"type\": \"Unknown\"\n \
\ }\n }"
content:
application/json:
schema:
$ref: '#/components/schemas/TranspileRequest'
example:
impl-url: https://raw.githubusercontent.com/UST-QuAntiL/nisq-analyzer-content/master/example-implementations/Grover-SAT/grover-fix-sat-pyquil.py
qpu-name: qvm
impl-language: pyquil
token: YOUR-TOKEN
input-params: {}
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TranspileResponse'
"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'
/forest-service/api/v1.0/execute:
post:
tags:
- Execute
description: "*Note*: \"token\" should either be in \"input-params\" or extra.\
\ Both variants are combined here for illustration purposes. *Note*: \"url\"\
, \"hub\", \"group\", \"project\" are optional such that otherwise the standard\
\ values are used."
requestBody:
description: " Execution via URL:\n \"impl-url\"\
: \"URL-OF-IMPLEMENTATION\" \n Execution via data:\n \
\ \"impl-data\": \"BASE64-ENCODED-IMPLEMENTATION\"\n \
\ Execution via transpiled Quil String:\n \
\ \"transpiled-quil\":\"TRANSPILED-QUIL-STRING\" \n for Batch\
\ Execution of multiple circuits use:\n \"impl-url\"\
: [\"URL-OF-IMPLEMENTATION-1\", \"URL-OF-IMPLEMENTATION-2\"]\n \
\ the \"input-params\"are of the form:\n \"input-params\"\
: {\n \"PARAM-NAME-1\": {\n \
\ \"rawValue\": \"YOUR-VALUE-1\",\n \"\
type\": \"Integer\"\n },\n \
\ \"PARAM-NAME-2\": {\n \"rawValue\": \"YOUR-VALUE-2\"\
,\n \"type\": \"String\"\n \
\ },\n ...\n \"token\"\
: {\n \"rawValue\": \"YOUR-IBMQ-TOKEN\",\n \
\ \"type\": \"Unknown\"\n \
\ }\n }"
content:
application/json:
schema:
$ref: '#/components/schemas/ExecuteRequest'
example:
impl-url: https://raw.githubusercontent.com/UST-QuAntiL/nisq-analyzer-content/master/example-implementations/Grover-SAT/grover-fix-sat-pyquil.py
qpu-name: qvm
impl-language: pyquil
token: YOUR-TOKEN
input-params: {}
required: true
responses:
"200":
description: Returns a content location for the result. Access it via GET
content:
application/json:
schema:
$ref: '#/components/schemas/ExecuteResponse'
"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'
/forest-service/api/v1.0/analyze-original-circuit:
post:
tags:
- Analysis of Original Circuit
requestBody:
description: |2-
"input-params" should be of the form:
"input-params":{
"PARAM-NAME-1": {
"rawValue": "YOUR-VALUE-1",
"type": "Integer"
},
"PARAM-NAME-2": {
"rawValue": "YOUR-VALUE-2",
"type": "String"
}
content:
application/json:
schema:
$ref: '#/components/schemas/AnalysisOriginalCircuitRequest'
example:
impl-url: https://raw.githubusercontent.com/UST-QuAntiL/nisq-analyzer-content/master/example-implementations/Grover-SAT/grover-fix-sat-pyquil.py
impl-language: pyquil
input-params: {}
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AnalysisOriginalCircuitResponse'
"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'
/forest-service/api/v1.0/results/{id}:
get:
tags:
- Results
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
minLength: 1
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResultsResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/forest-service/api/v1.0/generated-circuits/{id}:
get:
tags:
- Generated Circuits
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
minLength: 1
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GeneratedCircuitsResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/forest-service/api/v1.0/generate-circuit:
post:
tags:
- Generate Circuit
requestBody:
description: " Generation via URL:\n \"\
impl-url\": \"URL-OF-IMPLEMENTATION\" \n Generation via data:\n\
\ \"impl-data\": \"BASE64-ENCODED-IMPLEMENTATION\"\n\
\ the \"input-params\"are of the form:\n \
\ \"input-params\": {\n \"PARAM-NAME-1\": {\n\
\ \"rawValue\": \"YOUR-VALUE-1\",\n \
\ \"type\": \"Integer\"\n },\n\
\ \"PARAM-NAME-2\": {\n \
\ \"rawValue\": \"YOUR-VALUE-2\",\n \"type\"\
: \"String\"\n },\n ...\n\
\ "
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateCircuitRequest'
example:
impl-url: https://raw.githubusercontent.com/UST-QuAntiL/nisq-analyzer-content/master/example-implementations/Grover-SAT/grover-fix-sat-pyquil.py
impl-language: pyquil
input-params: {}
required: true
responses:
"200":
description: Returns a content location for the generated circuit and its
properties. Access it via GET
content:
application/json:
schema:
$ref: '#/components/schemas/GenerateCircuitResponse'
"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:
code:
type: integer
description: Error code
status:
type: string
description: Error name
message:
type: string
description: Error message
errors:
type: object
description: Errors
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
TranspileRequest:
type: object
properties:
impl_url:
type: string
impl_language:
type: string
qpu_name:
type: string
input_params:
type: array
items:
type: string
token:
type: string
TranspileResponse:
type: object
properties:
depth:
type: integer
multi_qubit_gate_depth:
type: integer
number_of_measurement_operations:
type: integer
number_of_multi_qubit_gates:
type: integer
number_of_single_qubit_gates:
type: integer
total_number_of_operations:
type: integer
transpiled_quil:
type: string
width:
type: integer
ExecuteRequest:
type: object
properties:
impl_url:
type: string
impl_language:
type: string
qpu_name:
type: string
input_params:
type: array
items:
type: string
token:
type: string
noise_model:
type: string
only_measurement_errors:
type: boolean
correlation_id:
type: string
ExecuteResponse:
type: object
properties:
location:
type: string
AnalysisOriginalCircuitRequest:
type: object
properties:
impl_url:
type: string
impl_language:
type: string
input_params:
type: array
items:
type: string
AnalysisOriginalCircuitResponse:
type: object
properties:
original_depth:
type: integer
original_multi_qubit_gate_depth:
type: integer
original_number_of_measurement_operations:
type: integer
original_number_of_multi_qubit_gates:
type: integer
original_number_of_single_qubit_gates:
type: integer
original_total_number_of_operations:
type: integer
original_width:
type: integer
ResultsResponse:
type: object
properties:
result:
type: array
items:
type: string
post_processing_result:
type: array
items:
type: string
GeneratedCircuitsResponse:
type: object
properties:
original_depth:
type: integer
original_multi_qubit_gate_depth:
type: integer
original_number_of_measurement_operations:
type: integer
original_number_of_multi_qubit_gates:
type: integer
original_number_of_single_qubit_gates:
type: integer
original_total_number_of_operations:
type: integer
generated_circuit:
type: string
original_width:
type: integer
GenerateCircuitRequest:
type: object
properties:
impl_url:
type: string
impl_language:
type: string
input_params:
type: array
items:
type: string
GenerateCircuitResponse:
type: object
properties:
location:
type: string
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'