6f514baa2593b8385156aece8946ec65378691a0

Author: github-actions[bot]

docs/PipelineStudyResultsApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 
 # **pipeline_study_results_get**
-> PipelineStudyResultList pipeline_study_results_get(feature_filter=feature_filter, pipeline_config=pipeline_config, study_id=study_id, version=version)
+> PipelineStudyResultList pipeline_study_results_get(feature_filter=feature_filter, feature_flatten=feature_flatten, pipeline_config=pipeline_config, study_id=study_id, version=version)
 
 GET a list of pipeline run results
 
@@ -37,13 +37,14 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = neurostore_sdk.PipelineStudyResultsApi(api_client)
     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\" (latest version)  Field path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=.  (optional)
+    feature_flatten = True # bool |  (optional)
     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\" (latest version)  Config path supports array notation with [], regex search with ~, and comparisons with =, >, <, >=, <=.  (optional)
     study_id = ['study_id_example'] # List[str] | Filter results by base study ID (optional)
     version = 'version_example' # str | Filter results by pipeline config version (optional)
 
     try:
         # GET a list of pipeline run results
-        api_response = api_instance.pipeline_study_results_get(feature_filter=feature_filter, pipeline_config=pipeline_config, study_id=study_id, version=version)
+        api_response = api_instance.pipeline_study_results_get(feature_filter=feature_filter, feature_flatten=feature_flatten, pipeline_config=pipeline_config, study_id=study_id, version=version)
         print("The response of PipelineStudyResultsApi->pipeline_study_results_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -58,6 +59,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **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; (latest version)  Field path supports array notation with [], regex search with ~, and comparisons with &#x3D;, &gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;.  | [optional] 
+ **feature_flatten** | **bool**|  | [optional] 
  **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; (latest version)  Config path supports array notation with [], regex search with ~, and comparisons with &#x3D;, &gt;, &lt;, &gt;&#x3D;, &lt;&#x3D;.  | [optional] 
  **study_id** | [**List[str]**](str.md)| Filter results by base study ID | [optional] 
  **version** | **str**| Filter results by pipeline config version | [optional] 

neurostore_sdk/api/pipeline_study_results_api.py

@@ -17,7 +17,7 @@
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
-from pydantic import Field, StrictStr
+from pydantic import Field, StrictBool, StrictStr
 from typing import List, Optional
 from typing_extensions import Annotated
 from neurostore_sdk.models.pipeline_study_result import PipelineStudyResult
@@ -45,6 +45,7 @@ def __init__(self, api_client=None) -> None:
     def pipeline_study_results_get(
         self,
         feature_filter: Annotated[Optional[List[StrictStr]], Field(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 =, >, <, >=, <=. ")] = None,
+        feature_flatten: Optional[StrictBool] = None,
         pipeline_config: Annotated[Optional[List[StrictStr]], Field(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 =, >, <, >=, <=. ")] = None,
         study_id: Annotated[Optional[List[StrictStr]], Field(description="Filter results by base study ID")] = None,
         version: Annotated[Optional[StrictStr], Field(description="Filter results by pipeline config version")] = None,
@@ -66,6 +67,8 @@ def pipeline_study_results_get(
 
         :param feature_filter: 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 =, >, <, >=, <=. 
         :type feature_filter: List[str]
+        :param feature_flatten:
+        :type feature_flatten: bool
         :param pipeline_config: 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 =, >, <, >=, <=. 
         :type pipeline_config: List[str]
         :param study_id: Filter results by base study ID
@@ -96,6 +99,7 @@ def pipeline_study_results_get(
 
         _param = self._pipeline_study_results_get_serialize(
             feature_filter=feature_filter,
+            feature_flatten=feature_flatten,
             pipeline_config=pipeline_config,
             study_id=study_id,
             version=version,
@@ -123,6 +127,7 @@ def pipeline_study_results_get(
     def pipeline_study_results_get_with_http_info(
         self,
         feature_filter: Annotated[Optional[List[StrictStr]], Field(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 =, >, <, >=, <=. ")] = None,
+        feature_flatten: Optional[StrictBool] = None,
         pipeline_config: Annotated[Optional[List[StrictStr]], Field(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 =, >, <, >=, <=. ")] = None,
         study_id: Annotated[Optional[List[StrictStr]], Field(description="Filter results by base study ID")] = None,
         version: Annotated[Optional[StrictStr], Field(description="Filter results by pipeline config version")] = None,
@@ -144,6 +149,8 @@ def pipeline_study_results_get_with_http_info(
 
         :param feature_filter: 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 =, >, <, >=, <=. 
         :type feature_filter: List[str]
+        :param feature_flatten:
+        :type feature_flatten: bool
         :param pipeline_config: 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 =, >, <, >=, <=. 
         :type pipeline_config: List[str]
         :param study_id: Filter results by base study ID
@@ -174,6 +181,7 @@ def pipeline_study_results_get_with_http_info(
 
         _param = self._pipeline_study_results_get_serialize(
             feature_filter=feature_filter,
+            feature_flatten=feature_flatten,
             pipeline_config=pipeline_config,
             study_id=study_id,
             version=version,
@@ -201,6 +209,7 @@ def pipeline_study_results_get_with_http_info(
     def pipeline_study_results_get_without_preload_content(
         self,
         feature_filter: Annotated[Optional[List[StrictStr]], Field(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 =, >, <, >=, <=. ")] = None,
+        feature_flatten: Optional[StrictBool] = None,
         pipeline_config: Annotated[Optional[List[StrictStr]], Field(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 =, >, <, >=, <=. ")] = None,
         study_id: Annotated[Optional[List[StrictStr]], Field(description="Filter results by base study ID")] = None,
         version: Annotated[Optional[StrictStr], Field(description="Filter results by pipeline config version")] = None,
@@ -222,6 +231,8 @@ def pipeline_study_results_get_without_preload_content(
 
         :param feature_filter: 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 =, >, <, >=, <=. 
         :type feature_filter: List[str]
+        :param feature_flatten:
+        :type feature_flatten: bool
         :param pipeline_config: 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 =, >, <, >=, <=. 
         :type pipeline_config: List[str]
         :param study_id: Filter results by base study ID
@@ -252,6 +263,7 @@ def pipeline_study_results_get_without_preload_content(
 
         _param = self._pipeline_study_results_get_serialize(
             feature_filter=feature_filter,
+            feature_flatten=feature_flatten,
             pipeline_config=pipeline_config,
             study_id=study_id,
             version=version,
@@ -274,6 +286,7 @@ def pipeline_study_results_get_without_preload_content(
     def _pipeline_study_results_get_serialize(
         self,
         feature_filter,
+        feature_flatten,
         pipeline_config,
         study_id,
         version,
@@ -306,6 +319,10 @@ def _pipeline_study_results_get_serialize(
 
             _query_params.append(('feature_filter', feature_filter))
 
+        if feature_flatten is not None:
+            
+            _query_params.append(('feature_flatten', feature_flatten))
+            
         if pipeline_config is not None:
 
             _query_params.append(('pipeline_config', pipeline_config))