Skip to content

Commit dbdfac8

Browse files
committed
add feature_config
1 parent 2cf374e commit dbdfac8

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

neurostore-openapi.yml

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,13 +173,34 @@ paths:
173173
parameters:
174174
- name: feature_filter
175175
in: query
176-
description: Filter results by feature content using jsonpath syntax
176+
description: >
177+
Filter results by feature content. Format: "PipelineName[:version]:field_path=value".
178+
Examples:
179+
- "TestPipeline:1.0.0:groups.diagnosis=ADHD" (specific version)
180+
- "TestPipeline:groups.diagnosis=ADHD" (any version)
181+
182+
Field path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=.
177183
required: false
178184
schema:
179185
type: array
180186
items:
181187
type: string
182-
example: 'groups.diagnosis=ADHD'
188+
example: 'TestPipeline:1.0.0:groups.diagnosis=ADHD'
189+
- name: feature_config
190+
in: query
191+
description: >
192+
Filter results by pipeline config content. Format: "PipelineName[:version]:config_path=value".
193+
Examples:
194+
- "TestPipeline:1.0.0:preprocessing.smoothing=8" (specific version)
195+
- "TestPipeline:model.type=linear" (any version)
196+
197+
Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=.
198+
required: false
199+
schema:
200+
type: array
201+
items:
202+
type: string
203+
example: 'TestPipeline:1.0.0:preprocessing.smoothing=8'
183204
- name: study_id
184205
in: query
185206
description: Filter results by base study ID
@@ -188,6 +209,12 @@ paths:
188209
type: array
189210
items:
190211
type: string
212+
- name: version
213+
in: query
214+
description: Filter results by pipeline config version
215+
required: false
216+
schema:
217+
type: string
191218
responses:
192219
'200':
193220
description: OK

0 commit comments

Comments
 (0)