Skip to content

Commit 1d09703

Browse files
committed
remove pipeline run and rename run to study
1 parent 77f1c94 commit 1d09703

File tree

1 file changed

+26
-208
lines changed

1 file changed

+26
-208
lines changed

neurostore-openapi.yml

Lines changed: 26 additions & 208 deletions
Original file line numberDiff line numberDiff line change
@@ -160,112 +160,38 @@ paths:
160160
responses:
161161
'204':
162162
description: No Content
163-
164-
/pipeline-runs/:
165-
get:
166-
summary: GET a list of pipeline runs
167-
tags:
168-
- pipeline-runs
169-
responses:
170-
'200':
171-
description: OK
172-
content:
173-
application/json:
174-
schema:
175-
$ref: '#/components/schemas/pipeline-run-list'
176-
post:
177-
summary: POST/create a pipeline run
178-
tags:
179-
- pipeline-runs
180-
requestBody:
181-
content:
182-
application/json:
183-
schema:
184-
$ref: '#/components/schemas/pipeline-run'
185-
responses:
186-
'201':
187-
description: Created
188-
/pipeline-runs/{pipeline_run_id}:
189-
get:
190-
summary: GET a pipeline run by ID
191-
tags:
192-
- pipeline-runs
193-
parameters:
194-
- name: pipeline_run_id
195-
in: path
196-
required: true
197-
schema:
198-
type: string
199-
responses:
200-
'200':
201-
description: OK
202-
content:
203-
application/json:
204-
schema:
205-
$ref: '#/components/schemas/pipeline-run'
206-
put:
207-
summary: PUT/update a pipeline run by ID
208-
tags:
209-
- pipeline-runs
210-
parameters:
211-
- name: pipeline_run_id
212-
in: path
213-
required: true
214-
schema:
215-
type: string
216-
requestBody:
217-
content:
218-
application/json:
219-
schema:
220-
$ref: '#/components/schemas/pipeline-run'
221-
responses:
222-
'200':
223-
description: OK
224-
delete:
225-
summary: DELETE a pipeline run by ID
226-
tags:
227-
- pipeline-runs
228-
parameters:
229-
- name: pipeline_run_id
230-
in: path
231-
required: true
232-
schema:
233-
type: string
234-
responses:
235-
'204':
236-
description: No Content
237-
238-
/pipeline-run-results/:
163+
164+
/pipeline-study-results/:
239165
get:
240166
summary: GET a list of pipeline run results
241167
tags:
242-
- pipeline-run-results
168+
- pipeline-study-results
243169
responses:
244170
'200':
245171
description: OK
246172
content:
247173
application/json:
248174
schema:
249-
$ref: '#/components/schemas/pipeline-run-result-list'
175+
$ref: '#/components/schemas/pipeline-study-result-list'
250176
post:
251177
summary: POST/create a pipeline run result
252178
tags:
253-
- pipeline-run-results
179+
- pipeline-study-results
254180
requestBody:
255181
content:
256182
application/json:
257183
schema:
258-
$ref: '#/components/schemas/pipeline-run-result'
184+
$ref: '#/components/schemas/pipeline-study-result'
259185
responses:
260186
'201':
261187
description: Created
262-
/pipeline-run-results/{pipeline_run_result_id}:
188+
/pipeline-study-results/{pipeline_study_result_id}:
263189
get:
264190
summary: GET a pipeline run result by ID
265191
tags:
266-
- pipeline-run-results
192+
- pipeline-study-results
267193
parameters:
268-
- name: pipeline_run_result_id
194+
- name: pipeline_study_result_id
269195
in: path
270196
required: true
271197
schema:
@@ -276,13 +202,13 @@ paths:
276202
content:
277203
application/json:
278204
schema:
279-
$ref: '#/components/schemas/pipeline-run-result'
205+
$ref: '#/components/schemas/pipeline-study-result'
280206
put:
281207
summary: PUT/update a pipeline run result by ID
282208
tags:
283-
- pipeline-run-results
209+
- pipeline-study-results
284210
parameters:
285-
- name: pipeline_run_result_id
211+
- name: pipeline_study_result_id
286212
in: path
287213
required: true
288214
schema:
@@ -291,90 +217,16 @@ paths:
291217
content:
292218
application/json:
293219
schema:
294-
$ref: '#/components/schemas/pipeline-run-result'
220+
$ref: '#/components/schemas/pipeline-study-result'
295221
responses:
296222
'200':
297223
description: OK
298224
delete:
299225
summary: DELETE a pipeline run result by ID
300226
tags:
301-
- pipeline-run-results
227+
- pipeline-study-results
302228
parameters:
303-
- name: pipeline_run_result_id
304-
in: path
305-
required: true
306-
schema:
307-
type: string
308-
responses:
309-
'204':
310-
description: No Content
311-
312-
/pipeline-run-result-votes/:
313-
get:
314-
summary: GET a list of pipeline run result votes
315-
tags:
316-
- pipeline-run-result-votes
317-
responses:
318-
'200':
319-
description: OK
320-
content:
321-
application/json:
322-
schema:
323-
$ref: '#/components/schemas/pipeline-run-result-vote-list'
324-
post:
325-
summary: POST/create a pipeline run result vote
326-
tags:
327-
- pipeline-run-result-votes
328-
requestBody:
329-
content:
330-
application/json:
331-
schema:
332-
$ref: '#/components/schemas/pipeline-run-result-vote'
333-
responses:
334-
'201':
335-
description: Created
336-
/pipeline-run-result-votes/{pipeline_run_result_vote_id}:
337-
get:
338-
summary: GET a pipeline run result vote by ID
339-
tags:
340-
- pipeline-run-result-votes
341-
parameters:
342-
- name: pipeline_run_result_vote_id
343-
in: path
344-
required: true
345-
schema:
346-
type: string
347-
responses:
348-
'200':
349-
description: OK
350-
content:
351-
application/json:
352-
schema:
353-
$ref: '#/components/schemas/pipeline-run-result-vote'
354-
put:
355-
summary: PUT/update a pipeline run result vote by ID
356-
tags:
357-
- pipeline-run-result-votes
358-
parameters:
359-
- name: pipeline_run_result_vote_id
360-
in: path
361-
required: true
362-
schema:
363-
type: string
364-
requestBody:
365-
content:
366-
application/json:
367-
schema:
368-
$ref: '#/components/schemas/pipeline-run-result-vote'
369-
responses:
370-
'200':
371-
description: OK
372-
delete:
373-
summary: DELETE a pipeline run result vote by ID
374-
tags:
375-
- pipeline-run-result-votes
376-
parameters:
377-
- name: pipeline_run_result_vote_id
229+
- name: pipeline_study_result_id
378230
in: path
379231
required: true
380232
schema:
@@ -1189,12 +1041,18 @@ paths:
11891041
schema:
11901042
$ref: '#/components/schemas/base-study-list'
11911043
parameters:
1192-
- name: features
1044+
- name: feature_filter
11931045
in: query
11941046
description: Filter studies by features
11951047
required: false
11961048
schema:
11971049
type: string
1050+
- name: feature_display
1051+
in: query
1052+
description: display features from pipelines
1053+
required: false
1054+
schema:
1055+
type: string
11981056
- $ref: '#/components/parameters/search'
11991057
- $ref: '#/components/parameters/sort'
12001058
- $ref: '#/components/parameters/page'
@@ -1429,62 +1287,22 @@ components:
14291287
$ref: '#/components/schemas/pipeline-config'
14301288
metadata:
14311289
$ref: '#/components/schemas/metadata'
1432-
pipeline-run:
1290+
pipeline-study-result:
14331291
type: object
14341292
properties:
14351293
id:
14361294
type: string
1437-
status:
1438-
type: string
1439-
started_at:
1440-
type: string
1441-
finished_at:
1442-
type: string
1443-
pipeline-run-list:
1444-
type: object
1445-
properties:
1446-
results:
1447-
type: array
1448-
items:
1449-
$ref: '#/components/schemas/pipeline-run'
1450-
metadata:
1451-
$ref: '#/components/schemas/metadata'
1452-
pipeline-run-result:
1453-
type: object
1454-
properties:
1455-
id:
1456-
type: string
1457-
pipeline_run_id:
1295+
pipeline_config_id:
14581296
type: string
14591297
data:
14601298
type: object
1461-
pipeline-run-result-list:
1462-
type: object
1463-
properties:
1464-
results:
1465-
type: array
1466-
items:
1467-
$ref: '#/components/schemas/pipeline-run-result'
1468-
metadata:
1469-
$ref: '#/components/schemas/metadata'
1470-
pipeline-run-result-vote:
1471-
type: object
1472-
properties:
1473-
id:
1474-
type: string
1475-
pipeline_run_result_id:
1476-
type: string
1477-
user_id:
1478-
type: string
1479-
vote:
1480-
type: integer
1481-
pipeline-run-result-vote-list:
1299+
pipeline-study-result-list:
14821300
type: object
14831301
properties:
14841302
results:
14851303
type: array
14861304
items:
1487-
$ref: '#/components/schemas/pipeline-run-result-vote'
1305+
$ref: '#/components/schemas/pipeline-study-result'
14881306
metadata:
14891307
$ref: '#/components/schemas/metadata'
14901308
studyset-return:

0 commit comments

Comments
 (0)