810ad962aba8444a84bd7b6a083efc5d6ef4735d

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, feature_flatten=feature_flatten, 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, feature_display=feature_display, study_id=study_id, version=version)
 
 GET a list of pipeline run results
 
@@ -39,12 +39,13 @@ with neurostore_sdk.ApiClient(configuration) as 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)
+    feature_display = ['feature_display_example'] # List[str] | Filter results by pipeline name and optionally version. Format: \"pipeline_name[:version]\". Examples:   - \"TestPipeline\" (all results from pipeline)   - \"TestPipeline:1.0.0\" (results from specific version) Multiple values can be provided to get results from multiple pipelines/versions.  (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, feature_flatten=feature_flatten, 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, feature_display=feature_display, study_id=study_id, version=version)
         print("The response of PipelineStudyResultsApi->pipeline_study_results_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -61,6 +62,7 @@ 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] 
+ **feature_display** | [**List[str]**](str.md)| Filter results by pipeline name and optionally version. Format: \&quot;pipeline_name[:version]\&quot;. Examples:   - \&quot;TestPipeline\&quot; (all results from pipeline)   - \&quot;TestPipeline:1.0.0\&quot; (results from specific version) Multiple values can be provided to get results from multiple pipelines/versions.  | [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

@@ -47,6 +47,7 @@ def pipeline_study_results_get(
         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,
+        feature_display: Annotated[Optional[List[StrictStr]], Field(description="Filter results by pipeline name and optionally version. Format: \"pipeline_name[:version]\". Examples:   - \"TestPipeline\" (all results from pipeline)   - \"TestPipeline:1.0.0\" (results from specific version) Multiple values can be provided to get results from multiple pipelines/versions. ")] = 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,
         _request_timeout: Union[
@@ -71,6 +72,8 @@ def pipeline_study_results_get(
         :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 feature_display: Filter results by pipeline name and optionally version. Format: \"pipeline_name[:version]\". Examples:   - \"TestPipeline\" (all results from pipeline)   - \"TestPipeline:1.0.0\" (results from specific version) Multiple values can be provided to get results from multiple pipelines/versions. 
+        :type feature_display: List[str]
         :param study_id: Filter results by base study ID
         :type study_id: List[str]
         :param version: Filter results by pipeline config version
@@ -101,6 +104,7 @@ def pipeline_study_results_get(
             feature_filter=feature_filter,
             feature_flatten=feature_flatten,
             pipeline_config=pipeline_config,
+            feature_display=feature_display,
             study_id=study_id,
             version=version,
             _request_auth=_request_auth,
@@ -129,6 +133,7 @@ def pipeline_study_results_get_with_http_info(
         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,
+        feature_display: Annotated[Optional[List[StrictStr]], Field(description="Filter results by pipeline name and optionally version. Format: \"pipeline_name[:version]\". Examples:   - \"TestPipeline\" (all results from pipeline)   - \"TestPipeline:1.0.0\" (results from specific version) Multiple values can be provided to get results from multiple pipelines/versions. ")] = 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,
         _request_timeout: Union[
@@ -153,6 +158,8 @@ def pipeline_study_results_get_with_http_info(
         :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 feature_display: Filter results by pipeline name and optionally version. Format: \"pipeline_name[:version]\". Examples:   - \"TestPipeline\" (all results from pipeline)   - \"TestPipeline:1.0.0\" (results from specific version) Multiple values can be provided to get results from multiple pipelines/versions. 
+        :type feature_display: List[str]
         :param study_id: Filter results by base study ID
         :type study_id: List[str]
         :param version: Filter results by pipeline config version
@@ -183,6 +190,7 @@ def pipeline_study_results_get_with_http_info(
             feature_filter=feature_filter,
             feature_flatten=feature_flatten,
             pipeline_config=pipeline_config,
+            feature_display=feature_display,
             study_id=study_id,
             version=version,
             _request_auth=_request_auth,
@@ -211,6 +219,7 @@ def pipeline_study_results_get_without_preload_content(
         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,
+        feature_display: Annotated[Optional[List[StrictStr]], Field(description="Filter results by pipeline name and optionally version. Format: \"pipeline_name[:version]\". Examples:   - \"TestPipeline\" (all results from pipeline)   - \"TestPipeline:1.0.0\" (results from specific version) Multiple values can be provided to get results from multiple pipelines/versions. ")] = 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,
         _request_timeout: Union[
@@ -235,6 +244,8 @@ def pipeline_study_results_get_without_preload_content(
         :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 feature_display: Filter results by pipeline name and optionally version. Format: \"pipeline_name[:version]\". Examples:   - \"TestPipeline\" (all results from pipeline)   - \"TestPipeline:1.0.0\" (results from specific version) Multiple values can be provided to get results from multiple pipelines/versions. 
+        :type feature_display: List[str]
         :param study_id: Filter results by base study ID
         :type study_id: List[str]
         :param version: Filter results by pipeline config version
@@ -265,6 +276,7 @@ def pipeline_study_results_get_without_preload_content(
             feature_filter=feature_filter,
             feature_flatten=feature_flatten,
             pipeline_config=pipeline_config,
+            feature_display=feature_display,
             study_id=study_id,
             version=version,
             _request_auth=_request_auth,
@@ -288,6 +300,7 @@ def _pipeline_study_results_get_serialize(
         feature_filter,
         feature_flatten,
         pipeline_config,
+        feature_display,
         study_id,
         version,
         _request_auth,
@@ -301,6 +314,7 @@ def _pipeline_study_results_get_serialize(
         _collection_formats: Dict[str, str] = {
             'feature_filter': 'multi',
             'pipeline_config': 'multi',
+            'feature_display': 'multi',
             'study_id': 'multi',
         }
 
@@ -327,6 +341,10 @@ def _pipeline_study_results_get_serialize(
 
             _query_params.append(('pipeline_config', pipeline_config))
 
+        if feature_display is not None:
+            
+            _query_params.append(('feature_display', feature_display))
+            
         if study_id is not None:
 
             _query_params.append(('study_id', study_id))