f49f82321a5cc878ad6082454e8a77a689e74257

Author: github-actions[bot]

.openapi-generator/FILES

@@ -64,6 +64,8 @@ docs/PipelineConfigsApi.md
 docs/PipelineList.md
 docs/PipelineStudyResult.md
 docs/PipelineStudyResultList.md
+docs/PipelineStudyResultPost.md
+docs/PipelineStudyResultSearch.md
 docs/PipelineStudyResultsApi.md
 docs/PipelinesApi.md
 docs/PointBase.md
@@ -179,6 +181,8 @@ neurostore_sdk/models/pipeline_config_list.py
 neurostore_sdk/models/pipeline_list.py
 neurostore_sdk/models/pipeline_study_result.py
 neurostore_sdk/models/pipeline_study_result_list.py
+neurostore_sdk/models/pipeline_study_result_post.py
+neurostore_sdk/models/pipeline_study_result_search.py
 neurostore_sdk/models/point_base.py
 neurostore_sdk/models/point_common.py
 neurostore_sdk/models/point_list.py
@@ -219,4 +223,6 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
+test/test_pipeline_study_result_post.py
+test/test_pipeline_study_result_search.py
 tox.ini

README.md

@@ -73,13 +73,14 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     page = 56 # int | page of results (optional)
     desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
     page_size = 56 # int | number of results to show on a page (optional)
+    paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
     name = 'name_example' # str | search the name field for a term (optional)
     description = 'description_example' # str | search description field for a term (optional)
     nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)
 
     try:
         # GET list of analyses
-        api_response = api_instance.analyses_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, nested=nested)
+        api_response = api_instance.analyses_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, name=name, description=description, nested=nested)
         print("The response of AnalysesApi->analyses_get:\n")
         pprint(api_response)
     except ApiException as e:
@@ -261,6 +262,8 @@ Class | Method | HTTP request | Description
  - [PipelineList](docs/PipelineList.md)
  - [PipelineStudyResult](docs/PipelineStudyResult.md)
  - [PipelineStudyResultList](docs/PipelineStudyResultList.md)
+ - [PipelineStudyResultPost](docs/PipelineStudyResultPost.md)
+ - [PipelineStudyResultSearch](docs/PipelineStudyResultSearch.md)
  - [PointBase](docs/PointBase.md)
  - [PointCommon](docs/PointCommon.md)
  - [PointList](docs/PointList.md)

docs/AnalysesApi.md

@@ -16,7 +16,7 @@ Method | HTTP request | Description
 
 
 # **analyses_get**
-> AnalysisList analyses_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, nested=nested)
+> AnalysisList analyses_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, name=name, description=description, nested=nested)
 
 GET list of analyses
 
@@ -47,13 +47,14 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     page = 56 # int | page of results (optional)
     desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
     page_size = 56 # int | number of results to show on a page (optional)
+    paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
     name = 'name_example' # str | search the name field for a term (optional)
     description = 'description_example' # str | search description field for a term (optional)
     nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)
 
     try:
         # GET list of analyses
-        api_response = api_instance.analyses_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, nested=nested)
+        api_response = api_instance.analyses_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, name=name, description=description, nested=nested)
         print("The response of AnalysesApi->analyses_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -72,6 +73,7 @@ Name | Type | Description  | Notes
  **page** | **int**| page of results | [optional] 
  **desc** | **bool**| sort results by descending order (as opposed to ascending order) | [optional] 
  **page_size** | **int**| number of results to show on a page | [optional] 
+ **paginate** | **bool**| whether to paginate results (true) or return all results at once (false) | [optional] [default to True]
  **name** | **str**| search the name field for a term | [optional] 
  **description** | **str**| search description field for a term | [optional] 
  **nested** | **bool**| whether to show the URI to a resource (false) or to embed the object in the response (true) | [optional] 
@@ -405,7 +407,7 @@ Name | Type | Description  | Notes
 [[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)
 
 # **annotation_analyses_get**
-> NoteCollectionList annotation_analyses_get()
+> NoteCollectionList annotation_analyses_get(paginate=paginate)
 
 Get annotation analyses
 
@@ -429,10 +431,11 @@ configuration = neurostore_sdk.Configuration(
 with neurostore_sdk.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = neurostore_sdk.AnalysesApi(api_client)
+    paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
 
     try:
         # Get annotation analyses
-        api_response = api_instance.annotation_analyses_get()
+        api_response = api_instance.annotation_analyses_get(paginate=paginate)
         print("The response of AnalysesApi->annotation_analyses_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -443,7 +446,10 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
 
 ### Parameters
 
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **paginate** | **bool**| whether to paginate results (true) or return all results at once (false) | [optional] [default to True]
 
 ### Return type
 

docs/AnnotationsApi.md

@@ -16,7 +16,7 @@ Method | HTTP request | Description
 
 
 # **annotation_analyses_get**
-> NoteCollectionList annotation_analyses_get()
+> NoteCollectionList annotation_analyses_get(paginate=paginate)
 
 Get annotation analyses
 
@@ -40,10 +40,11 @@ configuration = neurostore_sdk.Configuration(
 with neurostore_sdk.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = neurostore_sdk.AnnotationsApi(api_client)
+    paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
 
     try:
         # Get annotation analyses
-        api_response = api_instance.annotation_analyses_get()
+        api_response = api_instance.annotation_analyses_get(paginate=paginate)
         print("The response of AnnotationsApi->annotation_analyses_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -54,7 +55,10 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
 
 ### Parameters
 
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **paginate** | **bool**| whether to paginate results (true) or return all results at once (false) | [optional] [default to True]
 
 ### Return type
 
@@ -313,7 +317,7 @@ Name | Type | Description  | Notes
 [[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)
 
 # **annotations_get**
-> AnnotationList annotations_get(studyset_id=studyset_id)
+> AnnotationList annotations_get(studyset_id=studyset_id, paginate=paginate)
 
 Your GET endpoint
 
@@ -340,10 +344,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = neurostore_sdk.AnnotationsApi(api_client)
     studyset_id = 'studyset_id_example' # str | see all annotations connected to this studyset (optional)
+    paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
 
     try:
         # Your GET endpoint
-        api_response = api_instance.annotations_get(studyset_id=studyset_id)
+        api_response = api_instance.annotations_get(studyset_id=studyset_id, paginate=paginate)
         print("The response of AnnotationsApi->annotations_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -358,6 +363,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **studyset_id** | **str**| see all annotations connected to this studyset | [optional] 
+ **paginate** | **bool**| whether to paginate results (true) or return all results at once (false) | [optional] [default to True]
 
 ### Return type
 

docs/ConditionsApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 
 # **conditions_get**
-> ConditionList conditions_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description)
+> ConditionList conditions_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, name=name, description=description)
 
 GET Conditions
 
@@ -43,12 +43,13 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     page = 56 # int | page of results (optional)
     desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
     page_size = 56 # int | number of results to show on a page (optional)
+    paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
     name = 'name_example' # str | search the name field for a term (optional)
     description = 'description_example' # str | search description field for a term (optional)
 
     try:
         # GET Conditions
-        api_response = api_instance.conditions_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description)
+        api_response = api_instance.conditions_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, name=name, description=description)
         print("The response of ConditionsApi->conditions_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -67,6 +68,7 @@ Name | Type | Description  | Notes
  **page** | **int**| page of results | [optional] 
  **desc** | **bool**| sort results by descending order (as opposed to ascending order) | [optional] 
  **page_size** | **int**| number of results to show on a page | [optional] 
+ **paginate** | **bool**| whether to paginate results (true) or return all results at once (false) | [optional] [default to True]
  **name** | **str**| search the name field for a term | [optional] 
  **description** | **str**| search description field for a term | [optional] 
 

docs/ImagesApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 
 # **images_get**
-> ImageList images_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, filename=filename, analysis_name=analysis_name, value_type=value_type, space=space)
+> ImageList images_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, filename=filename, analysis_name=analysis_name, value_type=value_type, space=space)
 
 GET a list of images
 
@@ -43,14 +43,15 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     page = 56 # int | page of results (optional)
     desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
     page_size = 56 # int | number of results to show on a page (optional)
+    paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
     filename = 'filename_example' # str | search filename field (optional)
     analysis_name = 'analysis_name_example' # str | search analysis_name field (optional)
     value_type = 'value_type_example' # str | search value_type field (optional)
     space = 'space_example' # str | search space field (optional)
 
     try:
         # GET a list of images
-        api_response = api_instance.images_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, filename=filename, analysis_name=analysis_name, value_type=value_type, space=space)
+        api_response = api_instance.images_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, filename=filename, analysis_name=analysis_name, value_type=value_type, space=space)
         print("The response of ImagesApi->images_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -69,6 +70,7 @@ Name | Type | Description  | Notes
  **page** | **int**| page of results | [optional] 
  **desc** | **bool**| sort results by descending order (as opposed to ascending order) | [optional] 
  **page_size** | **int**| number of results to show on a page | [optional] 
+ **paginate** | **bool**| whether to paginate results (true) or return all results at once (false) | [optional] [default to True]
  **filename** | **str**| search filename field | [optional] 
  **analysis_name** | **str**| search analysis_name field | [optional] 
  **value_type** | **str**| search value_type field | [optional] 

docs/PipelineConfigsApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 
 # **pipeline_configs_get**
-> PipelineConfigList pipeline_configs_get(pipeline=pipeline)
+> PipelineConfigList pipeline_configs_get(pipeline=pipeline, paginate=paginate)
 
 GET a list of pipeline configs
 
@@ -37,10 +37,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = neurostore_sdk.PipelineConfigsApi(api_client)
     pipeline = ['pipeline_example'] # List[str] | Filter configs by pipeline name (optional)
+    paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
 
     try:
         # GET a list of pipeline configs
-        api_response = api_instance.pipeline_configs_get(pipeline=pipeline)
+        api_response = api_instance.pipeline_configs_get(pipeline=pipeline, paginate=paginate)
         print("The response of PipelineConfigsApi->pipeline_configs_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -55,6 +56,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **pipeline** | [**List[str]**](str.md)| Filter configs by pipeline name | [optional] 
+ **paginate** | **bool**| whether to paginate results (true) or return all results at once (false) | [optional] [default to True]
 
 ### Return type
 

docs/PipelineStudyResult.md

@@ -5,9 +5,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **str** |  | [optional] 
+**id** | **str** |  | 
 **pipeline_config_id** | **str** |  | [optional] 
-**data** | **object** |  | [optional] 
+**base_study_id** | **str** |  | [optional] 
+**config_id** | **str** |  | [optional] 
+**date_executed** | **datetime** |  | [optional] 
+**file_inputs** | **object** |  | [optional] 
+**result_data** | **object** |  | [optional] 
+**status** | **str** |  | [optional] 
 
 ## Example
 

docs/PipelineStudyResultPost.md

@@ -0,0 +1,37 @@
+# PipelineStudyResultPost
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**study_ids** | **List[str]** |  | 
+**id** | **str** |  | 
+**pipeline_config_id** | **str** |  | [optional] 
+**base_study_id** | **str** |  | [optional] 
+**config_id** | **str** |  | [optional] 
+**date_executed** | **datetime** |  | [optional] 
+**file_inputs** | **object** |  | [optional] 
+**result_data** | **object** |  | [optional] 
+**status** | **str** |  | [optional] 
+
+## Example
+
+```python
+from neurostore_sdk.models.pipeline_study_result_post import PipelineStudyResultPost
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PipelineStudyResultPost from a JSON string
+pipeline_study_result_post_instance = PipelineStudyResultPost.from_json(json)
+# print the JSON string representation of the object
+print(PipelineStudyResultPost.to_json())
+
+# convert the object into a dict
+pipeline_study_result_post_dict = pipeline_study_result_post_instance.to_dict()
+# create an instance of PipelineStudyResultPost from a dict
+pipeline_study_result_post_from_dict = PipelineStudyResultPost.from_dict(pipeline_study_result_post_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/PipelineStudyResultSearch.md

@@ -0,0 +1,29 @@
+# PipelineStudyResultSearch
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**study_ids** | **List[str]** |  | 
+
+## Example
+
+```python
+from neurostore_sdk.models.pipeline_study_result_search import PipelineStudyResultSearch
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PipelineStudyResultSearch from a JSON string
+pipeline_study_result_search_instance = PipelineStudyResultSearch.from_json(json)
+# print the JSON string representation of the object
+print(PipelineStudyResultSearch.to_json())
+
+# convert the object into a dict
+pipeline_study_result_search_dict = pipeline_study_result_search_instance.to_dict()
+# create an instance of PipelineStudyResultSearch from a dict
+pipeline_study_result_search_from_dict = PipelineStudyResultSearch.from_dict(pipeline_study_result_search_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+