Skip to content

Commit 6f31493

Browse files
authored
Merge pull request #89 from neurostuff/enh/feature_config
add the parameter pipeline_config to return features based on a particular model, parameterization of the model.
2 parents 2cf374e + cfade05 commit 6f31493

File tree

1 file changed

+55
-4
lines changed

1 file changed

+55
-4
lines changed

neurostore-openapi.yml

Lines changed: 55 additions & 4 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" (latest 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: pipeline_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" (latest 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
@@ -1065,10 +1092,34 @@ paths:
10651092
parameters:
10661093
- name: feature_filter
10671094
in: query
1068-
description: Filter studies by features
1095+
description: >
1096+
Filter studies by feature content. Format: "PipelineName[:version]:field_path=value".
1097+
Examples:
1098+
- "TestPipeline:1.0.0:predictions.age_mean>20" (specific version)
1099+
- "TestPipeline:groups.diagnosis=ADHD" (latest version)
1100+
1101+
Field path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=.
10691102
required: false
10701103
schema:
1071-
type: string
1104+
type: array
1105+
items:
1106+
type: string
1107+
example: 'TestPipeline:1.0.0:predictions.age_mean>20'
1108+
- name: pipeline_config
1109+
in: query
1110+
description: >
1111+
Filter studies by pipeline config content. Format: "PipelineName[:version]:config_path=value".
1112+
Examples:
1113+
- "TestPipeline:1.0.0:settings.min_age=20" (specific version)
1114+
- "TestPipeline:model.type=linear" (latest version)
1115+
1116+
Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=.
1117+
required: false
1118+
schema:
1119+
type: array
1120+
items:
1121+
type: string
1122+
example: 'TestPipeline:1.0.0:settings.min_age=20'
10721123
- name: feature_display
10731124
in: query
10741125
description: display features from pipelines

0 commit comments

Comments
 (0)