Skip to content

Commit 7cad775

Browse files
cab1edeadc55f5eb58f433317c9fa0c50c8b2683
1 parent b9df330 commit 7cad775

File tree

6 files changed

+60
-60
lines changed

6 files changed

+60
-60
lines changed

docs/PipelineStudyResultsApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212

1313

1414
# **pipeline_study_results_get**
15-
> PipelineStudyResultList pipeline_study_results_get(feature_filter=feature_filter, feature_config=feature_config, study_id=study_id, version=version)
15+
> PipelineStudyResultList pipeline_study_results_get(feature_filter=feature_filter, pipeline_config=pipeline_config, study_id=study_id, version=version)
1616
1717
GET a list of pipeline run results
1818

@@ -37,13 +37,13 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
3737
# Create an instance of the API class
3838
api_instance = neurostore_sdk.PipelineStudyResultsApi(api_client)
3939
feature_filter = ['feature_filter_example'] # List[str] | 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\" (any version) Field path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. (optional)
40-
feature_config = ['feature_config_example'] # List[str] | 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\" (any version) Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. (optional)
40+
pipeline_config = ['pipeline_config_example'] # List[str] | 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\" (any version) Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. (optional)
4141
study_id = ['study_id_example'] # List[str] | Filter results by base study ID (optional)
4242
version = 'version_example' # str | Filter results by pipeline config version (optional)
4343

4444
try:
4545
# GET a list of pipeline run results
46-
api_response = api_instance.pipeline_study_results_get(feature_filter=feature_filter, feature_config=feature_config, study_id=study_id, version=version)
46+
api_response = api_instance.pipeline_study_results_get(feature_filter=feature_filter, pipeline_config=pipeline_config, study_id=study_id, version=version)
4747
print("The response of PipelineStudyResultsApi->pipeline_study_results_get:\n")
4848
pprint(api_response)
4949
except Exception as e:
@@ -58,7 +58,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
5858
Name | Type | Description | Notes
5959
------------- | ------------- | ------------- | -------------
6060
**feature_filter** | [**List[str]**](str.md)| Filter results by feature content. Format: \&quot;PipelineName[:version]:field_path&#x3D;value\&quot;. Examples: - \&quot;TestPipeline:1.0.0:groups.diagnosis&#x3D;ADHD\&quot; (specific version) - \&quot;TestPipeline:groups.diagnosis&#x3D;ADHD\&quot; (any version) Field path supports array notation with [], regex search with ~, and comparisons with &#x3D;, &gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;. | [optional]
61-
**feature_config** | [**List[str]**](str.md)| Filter results by pipeline config content. Format: \&quot;PipelineName[:version]:config_path&#x3D;value\&quot;. Examples: - \&quot;TestPipeline:1.0.0:preprocessing.smoothing&#x3D;8\&quot; (specific version) - \&quot;TestPipeline:model.type&#x3D;linear\&quot; (any version) Config path supports array notation with [], regex search with ~, and comparisons with &#x3D;, &gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;. | [optional]
61+
**pipeline_config** | [**List[str]**](str.md)| Filter results by pipeline config content. Format: \&quot;PipelineName[:version]:config_path&#x3D;value\&quot;. Examples: - \&quot;TestPipeline:1.0.0:preprocessing.smoothing&#x3D;8\&quot; (specific version) - \&quot;TestPipeline:model.type&#x3D;linear\&quot; (any version) Config path supports array notation with [], regex search with ~, and comparisons with &#x3D;, &gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;. | [optional]
6262
**study_id** | [**List[str]**](str.md)| Filter results by base study ID | [optional]
6363
**version** | **str**| Filter results by pipeline config version | [optional]
6464

docs/StoreApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1112,7 +1112,7 @@ Name | Type | Description | Notes
11121112
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
11131113

11141114
# **base_studies_get**
1115-
> BaseStudyList base_studies_get(feature_filter=feature_filter, feature_config=feature_config, feature_display=feature_display, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
1115+
> BaseStudyList base_studies_get(feature_filter=feature_filter, pipeline_config=pipeline_config, feature_display=feature_display, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
11161116
11171117

11181118

@@ -1147,7 +1147,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11471147
# Create an instance of the API class
11481148
api_instance = neurostore_sdk.StoreApi(api_client)
11491149
feature_filter = ['feature_filter_example'] # List[str] | 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\" (any version) Field path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. (optional)
1150-
feature_config = ['feature_config_example'] # List[str] | 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\" (any version) Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. (optional)
1150+
pipeline_config = ['pipeline_config_example'] # List[str] | 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\" (any version) Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. (optional)
11511151
feature_display = 'feature_display_example' # str | display features from pipelines (optional)
11521152
feature_flatten = True # bool | (optional)
11531153
search = 'imagin' # str | search for entries that contain the substring (optional)
@@ -1168,7 +1168,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11681168

11691169
try:
11701170
#
1171-
api_response = api_instance.base_studies_get(feature_filter=feature_filter, feature_config=feature_config, feature_display=feature_display, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
1171+
api_response = api_instance.base_studies_get(feature_filter=feature_filter, pipeline_config=pipeline_config, feature_display=feature_display, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
11721172
print("The response of StoreApi->base_studies_get:\n")
11731173
pprint(api_response)
11741174
except Exception as e:
@@ -1183,7 +1183,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11831183
Name | Type | Description | Notes
11841184
------------- | ------------- | ------------- | -------------
11851185
**feature_filter** | [**List[str]**](str.md)| Filter studies by feature content. Format: \&quot;PipelineName[:version]:field_path&#x3D;value\&quot;. Examples: - \&quot;TestPipeline:1.0.0:predictions.age_mean&gt;20\&quot; (specific version) - \&quot;TestPipeline:groups.diagnosis&#x3D;ADHD\&quot; (any version) Field path supports array notation with [], regex search with ~, and comparisons with &#x3D;, &gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;. | [optional]
1186-
**feature_config** | [**List[str]**](str.md)| Filter studies by pipeline config content. Format: \&quot;PipelineName[:version]:config_path&#x3D;value\&quot;. Examples: - \&quot;TestPipeline:1.0.0:settings.min_age&#x3D;20\&quot; (specific version) - \&quot;TestPipeline:model.type&#x3D;linear\&quot; (any version) Config path supports array notation with [], regex search with ~, and comparisons with &#x3D;, &gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;. | [optional]
1186+
**pipeline_config** | [**List[str]**](str.md)| Filter studies by pipeline config content. Format: \&quot;PipelineName[:version]:config_path&#x3D;value\&quot;. Examples: - \&quot;TestPipeline:1.0.0:settings.min_age&#x3D;20\&quot; (specific version) - \&quot;TestPipeline:model.type&#x3D;linear\&quot; (any version) Config path supports array notation with [], regex search with ~, and comparisons with &#x3D;, &gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;. | [optional]
11871187
**feature_display** | **str**| display features from pipelines | [optional]
11881188
**feature_flatten** | **bool**| | [optional]
11891189
**search** | **str**| search for entries that contain the substring | [optional]

docs/StudiesApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Method | HTTP request | Description
1616

1717

1818
# **base_studies_get**
19-
> BaseStudyList base_studies_get(feature_filter=feature_filter, feature_config=feature_config, feature_display=feature_display, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
19+
> BaseStudyList base_studies_get(feature_filter=feature_filter, pipeline_config=pipeline_config, feature_display=feature_display, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
2020
2121

2222

@@ -51,7 +51,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
5151
# Create an instance of the API class
5252
api_instance = neurostore_sdk.StudiesApi(api_client)
5353
feature_filter = ['feature_filter_example'] # List[str] | 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\" (any version) Field path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. (optional)
54-
feature_config = ['feature_config_example'] # List[str] | 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\" (any version) Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. (optional)
54+
pipeline_config = ['pipeline_config_example'] # List[str] | 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\" (any version) Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=. (optional)
5555
feature_display = 'feature_display_example' # str | display features from pipelines (optional)
5656
feature_flatten = True # bool | (optional)
5757
search = 'imagin' # str | search for entries that contain the substring (optional)
@@ -72,7 +72,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
7272

7373
try:
7474
#
75-
api_response = api_instance.base_studies_get(feature_filter=feature_filter, feature_config=feature_config, feature_display=feature_display, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
75+
api_response = api_instance.base_studies_get(feature_filter=feature_filter, pipeline_config=pipeline_config, feature_display=feature_display, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
7676
print("The response of StudiesApi->base_studies_get:\n")
7777
pprint(api_response)
7878
except Exception as e:
@@ -87,7 +87,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
8787
Name | Type | Description | Notes
8888
------------- | ------------- | ------------- | -------------
8989
**feature_filter** | [**List[str]**](str.md)| Filter studies by feature content. Format: \&quot;PipelineName[:version]:field_path&#x3D;value\&quot;. Examples: - \&quot;TestPipeline:1.0.0:predictions.age_mean&gt;20\&quot; (specific version) - \&quot;TestPipeline:groups.diagnosis&#x3D;ADHD\&quot; (any version) Field path supports array notation with [], regex search with ~, and comparisons with &#x3D;, &gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;. | [optional]
90-
**feature_config** | [**List[str]**](str.md)| Filter studies by pipeline config content. Format: \&quot;PipelineName[:version]:config_path&#x3D;value\&quot;. Examples: - \&quot;TestPipeline:1.0.0:settings.min_age&#x3D;20\&quot; (specific version) - \&quot;TestPipeline:model.type&#x3D;linear\&quot; (any version) Config path supports array notation with [], regex search with ~, and comparisons with &#x3D;, &gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;. | [optional]
90+
**pipeline_config** | [**List[str]**](str.md)| Filter studies by pipeline config content. Format: \&quot;PipelineName[:version]:config_path&#x3D;value\&quot;. Examples: - \&quot;TestPipeline:1.0.0:settings.min_age&#x3D;20\&quot; (specific version) - \&quot;TestPipeline:model.type&#x3D;linear\&quot; (any version) Config path supports array notation with [], regex search with ~, and comparisons with &#x3D;, &gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;. | [optional]
9191
**feature_display** | **str**| display features from pipelines | [optional]
9292
**feature_flatten** | **bool**| | [optional]
9393
**search** | **str**| search for entries that contain the substring | [optional]

0 commit comments

Comments
 (0)