diff --git a/neurostore-openapi.yml b/neurostore-openapi.yml index 2e60b59..917db84 100644 --- a/neurostore-openapi.yml +++ b/neurostore-openapi.yml @@ -173,13 +173,34 @@ paths: parameters: - name: feature_filter in: query - description: Filter results by feature content using jsonpath syntax + description: > + Filter results by feature content. Format: "PipelineName[:version]:field_path=value". + Examples: + - "TestPipeline:1.0.0:groups.diagnosis=ADHD" (specific version) + - "TestPipeline:groups.diagnosis=ADHD" (latest version) + + Field path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. required: false schema: type: array items: type: string - example: 'groups.diagnosis=ADHD' + example: 'TestPipeline:1.0.0:groups.diagnosis=ADHD' + - name: pipeline_config + in: query + description: > + Filter results by pipeline config content. Format: "PipelineName[:version]:config_path=value". + Examples: + - "TestPipeline:1.0.0:preprocessing.smoothing=8" (specific version) + - "TestPipeline:model.type=linear" (latest version) + + Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. + required: false + schema: + type: array + items: + type: string + example: 'TestPipeline:1.0.0:preprocessing.smoothing=8' - name: study_id in: query description: Filter results by base study ID @@ -188,6 +209,12 @@ paths: type: array items: type: string + - name: version + in: query + description: Filter results by pipeline config version + required: false + schema: + type: string responses: '200': description: OK @@ -1065,10 +1092,34 @@ paths: parameters: - name: feature_filter in: query - description: Filter studies by features + description: > + Filter studies by feature content. Format: "PipelineName[:version]:field_path=value". + Examples: + - "TestPipeline:1.0.0:predictions.age_mean>20" (specific version) + - "TestPipeline:groups.diagnosis=ADHD" (latest version) + + Field path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. required: false schema: - type: string + type: array + items: + type: string + example: 'TestPipeline:1.0.0:predictions.age_mean>20' + - name: pipeline_config + in: query + description: > + Filter studies by pipeline config content. Format: "PipelineName[:version]:config_path=value". + Examples: + - "TestPipeline:1.0.0:settings.min_age=20" (specific version) + - "TestPipeline:model.type=linear" (latest version) + + Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. + required: false + schema: + type: array + items: + type: string + example: 'TestPipeline:1.0.0:settings.min_age=20' - name: feature_display in: query description: display features from pipelines