Skip to content

Commit 8e4c988

Browse files
committed
add same query parameters to post endpoint
1 parent 31ccd1c commit 8e4c988

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

neurostore-openapi.yml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -259,6 +259,71 @@ paths:
259259
summary: POST/create a pipeline run result
260260
tags:
261261
- pipeline-study-results
262+
parameters:
263+
- $ref: '#/components/parameters/paginate'
264+
- name: feature_filter
265+
in: query
266+
description: >
267+
Filter results by feature content. Format: "PipelineName[:version]:field_path=value".
268+
Examples:
269+
- "TestPipeline:1.0.0:groups.diagnosis=ADHD" (specific version)
270+
- "TestPipeline:groups.diagnosis=ADHD" (latest version)
271+
272+
Field path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=.
273+
required: false
274+
schema:
275+
type: array
276+
items:
277+
type: string
278+
example: 'TestPipeline:1.0.0:groups.diagnosis=ADHD'
279+
- name: feature_flatten
280+
in: query
281+
required: false
282+
schema:
283+
type: boolean
284+
- name: pipeline_config
285+
in: query
286+
description: >
287+
Filter results by pipeline config content. Format: "PipelineName[:version]:config_path=value".
288+
Examples:
289+
- "TestPipeline:1.0.0:preprocessing.smoothing=8" (specific version)
290+
- "TestPipeline:model.type=linear" (latest version)
291+
292+
Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=.
293+
required: false
294+
schema:
295+
type: array
296+
items:
297+
type: string
298+
example: 'TestPipeline:1.0.0:preprocessing.smoothing=8'
299+
- name: feature_display
300+
in: query
301+
description: >
302+
Filter results by pipeline name and optionally version. Format: "pipeline_name[:version]".
303+
Examples:
304+
- "TestPipeline" (all results from pipeline)
305+
- "TestPipeline:1.0.0" (results from specific version)
306+
Multiple values can be provided to get results from multiple pipelines/versions.
307+
required: false
308+
schema:
309+
type: array
310+
items:
311+
type: string
312+
example: 'TestPipeline:1.0.0'
313+
- name: study_id
314+
in: query
315+
description: Filter results by base study ID
316+
required: false
317+
schema:
318+
type: array
319+
items:
320+
type: string
321+
- name: version
322+
in: query
323+
description: Filter results by pipeline config version
324+
required: false
325+
schema:
326+
type: string
262327
requestBody:
263328
content:
264329
application/json:

0 commit comments

Comments
 (0)