658a54b3deca4091e92be9eaff055ec686172e95

neurostuff · Oct 24, 2023 · fcb5ca7 · fcb5ca7
1 parent 35f6532
commit fcb5ca7
Show file tree

Hide file tree

Showing 28 changed files with 64 additions and 44 deletions.
diff --git a/docs/AnalysisReturn.md b/docs/AnalysisReturn.md
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **description** | **str** | A long form description of how the contrast was performed | [optional] 
 **weights** | **List[float]** | Weight applied to each condition, must be the same length as the conditions attribute. | [optional] 
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
-**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly] 
 **id** | **str** | short UUID specifying the location of this resource | [optional] 
 **public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
 **user** | **str** | who owns the resource | [optional] [readonly] 

diff --git a/docs/AnnotationReturn.md b/docs/AnnotationReturn.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **description** | **str** | Long form description of the annotation. | [optional] 
 **note_keys** | **object** | The keys (columns) in the annotation and the key&#39;s respective data type (such as an integer or string). | [optional] 
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
-**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly] 
 **id** | **str** | short UUID specifying the location of this resource | [optional] 
 **public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
 **user** | **str** | who owns the resource | [optional] [readonly] 

diff --git a/docs/AnnotationReturnOneOf1.md b/docs/AnnotationReturnOneOf1.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **metadata** | **object** | object describing metadata about the annotation, such as software used or descriptions of the keys used in the annotation. | [optional] 
 **note_keys** | **object** | The keys (columns) in the annotation and the key&#39;s respective data type (such as an integer or string). | [optional] 
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
-**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly] 
 **id** | **str** | short UUID specifying the location of this resource | [optional] 
 **public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
 **user** | **str** | who owns the resource | [optional] [readonly] 

diff --git a/docs/BaseStudiesPost200Response.md b/docs/BaseStudiesPost200Response.md
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 **year** | **int** |  | [optional] 
 **level** | **str** |  | [optional] 
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
-**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly] 
 **id** | **str** | short UUID specifying the location of this resource | [optional] 
 **public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
 **user** | **str** | who owns the resource | [optional] [readonly] 

diff --git a/docs/BaseStudyReturn.md b/docs/BaseStudyReturn.md
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 **year** | **int** |  | [optional] 
 **level** | **str** |  | [optional] 
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
-**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly] 
 **id** | **str** | short UUID specifying the location of this resource | [optional] 
 **public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
 **user** | **str** | who owns the resource | [optional] [readonly] 

diff --git a/docs/ConditionReturn.md b/docs/ConditionReturn.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **name** | **str** | Name of the condition being applied in the contrast, either psychological, pharmacological, or group based. | [optional] 
 **description** | **str** | Long form description of how the condition is operationalized and/or specific meaning. | [optional] 
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
-**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly] 
 **id** | **str** | short UUID specifying the location of this resource | [optional] 
 **public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
 **user** | **str** | who owns the resource | [optional] [readonly] 

diff --git a/docs/ImageReturn.md b/docs/ImageReturn.md
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **entities** | [**List[Entity]**](Entity.md) |  | [optional] 
 **analysis_name** | **str** |  | [optional] 
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
-**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly] 
 **id** | **str** | short UUID specifying the location of this resource | [optional] 
 **public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
 **user** | **str** | who owns the resource | [optional] [readonly] 

diff --git a/docs/PointReturn.md b/docs/PointReturn.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **kind** | **str** | Method of how point was derived (e.g., center of mass) | [optional] 
 **label_id** | **str** | If the point is associated with an image, this is the value the point takes in that image. | [optional] 
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
-**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly] 
 **id** | **str** | short UUID specifying the location of this resource | [optional] 
 **public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
 **user** | **str** | who owns the resource | [optional] [readonly] 

diff --git a/docs/ReadableResourceAttributes.md b/docs/ReadableResourceAttributes.md
@@ -6,7 +6,7 @@ common readable resource attributes
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
-**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly] 
 
 ## Example
 

diff --git a/docs/ResourceAttributes.md b/docs/ResourceAttributes.md
@@ -6,7 +6,7 @@ common attributes for user owned resources
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
-**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly] 
 **id** | **str** | short UUID specifying the location of this resource | [optional] 
 **public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
 **user** | **str** | who owns the resource | [optional] [readonly] 

diff --git a/docs/StoreApi.md b/docs/StoreApi.md
@@ -2392,7 +2392,7 @@ void (empty response body)
 [[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)
 
 # **studysets_id_get**
-> StudysetReturn studysets_id_get(id, nested=nested)
+> StudysetReturn studysets_id_get(id, nested=nested, gzip=gzip)
 
 GET a studyset
 
@@ -2421,10 +2421,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     api_instance = neurostore_sdk.StoreApi(api_client)
     id = 'id_example' # str | 
     nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)
+    gzip = True # bool | return the content as gzipped content (optional)
 
     try:
         # GET a studyset
-        api_response = api_instance.studysets_id_get(id, nested=nested)
+        api_response = api_instance.studysets_id_get(id, nested=nested, gzip=gzip)
         print("The response of StoreApi->studysets_id_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -2438,6 +2439,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **str**|  | 
  **nested** | **bool**| whether to show the URI to a resource (false) or to embed the object in the response (true) | [optional] 
+ **gzip** | **bool**| return the content as gzipped content | [optional] 
 
 ### Return type
 
@@ -2450,7 +2452,7 @@ No authorization required
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Accept**: application/json, application/gzip
 
 ### HTTP response details
 | Status code | Description | Response headers |

diff --git a/docs/StudyReturn.md b/docs/StudyReturn.md
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **authors** | **str** | The authors on the publication of this study. | [optional] 
 **year** | **int** | The year this study was published. | [optional] 
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
-**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly] 
 **id** | **str** | short UUID specifying the location of this resource | [optional] 
 **public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
 **user** | **str** | who owns the resource | [optional] [readonly] 

diff --git a/docs/StudysetReturn.md b/docs/StudysetReturn.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **doi** | **str** | A DOI connected to the published studyset (may change to being automatically created so each studyset connected to a successful meta-analysis gets a DOI). | [optional] 
 **pmid** | **str** | If the article connected to the studyset was published on PubMed, then link the ID here. | [optional] 
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
-**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly] 
 **id** | **str** | short UUID specifying the location of this resource | [optional] 
 **public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
 **user** | **str** | who owns the resource | [optional] [readonly] 

diff --git a/docs/StudysetsApi.md b/docs/StudysetsApi.md
@@ -185,7 +185,7 @@ void (empty response body)
 [[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)
 
 # **studysets_id_get**
-> StudysetReturn studysets_id_get(id, nested=nested)
+> StudysetReturn studysets_id_get(id, nested=nested, gzip=gzip)
 
 GET a studyset
 
@@ -214,10 +214,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     api_instance = neurostore_sdk.StudysetsApi(api_client)
     id = 'id_example' # str | 
     nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)
+    gzip = True # bool | return the content as gzipped content (optional)
 
     try:
         # GET a studyset
-        api_response = api_instance.studysets_id_get(id, nested=nested)
+        api_response = api_instance.studysets_id_get(id, nested=nested, gzip=gzip)
         print("The response of StudysetsApi->studysets_id_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -231,6 +232,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **str**|  | 
  **nested** | **bool**| whether to show the URI to a resource (false) or to embed the object in the response (true) | [optional] 
+ **gzip** | **bool**| return the content as gzipped content | [optional] 
 
 ### Return type
 
@@ -243,7 +245,7 @@ No authorization required
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json
+ - **Accept**: application/json, application/gzip
 
 ### HTTP response details
 | Status code | Description | Response headers |

diff --git a/docs/UserlessResourceAttributes.md b/docs/UserlessResourceAttributes.md
@@ -6,7 +6,7 @@ common resource attributes not tied to a specific user
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **created_at** | **datetime** | time the resource was created on the database | [optional] [readonly] 
-**updated_at** | **str** | when was the resource last modified/updated. | [optional] [readonly] 
+**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly] 
 **id** | **str** | short UUID specifying the location of this resource | [optional] 
 **public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
 

diff --git a/neurostore_sdk/api/store_api.py b/neurostore_sdk/api/store_api.py
@@ -4851,20 +4851,22 @@ def studysets_id_delete_with_http_info(self, id : StrictStr, **kwargs) -> ApiRes
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def studysets_id_get(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="whether to show the URI to a resource (false) or to embed the object in the response (true)")] = None, **kwargs) -> StudysetReturn:  # noqa: E501
+    def studysets_id_get(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="whether to show the URI to a resource (false) or to embed the object in the response (true)")] = None, gzip : Annotated[Optional[StrictBool], Field(description="return the content as gzipped content")] = None, **kwargs) -> StudysetReturn:  # noqa: E501
         """GET a studyset  # noqa: E501
 
         Retrieve the information of a studyset with the matching studyset ID.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.studysets_id_get(id, nested, async_req=True)
+        >>> thread = api.studysets_id_get(id, nested, gzip, async_req=True)
         >>> result = thread.get()
 
         :param id: (required)
         :type id: str
         :param nested: whether to show the URI to a resource (false) or to embed the object in the response (true)
         :type nested: bool
+        :param gzip: return the content as gzipped content
+        :type gzip: bool
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _request_timeout: timeout setting for this request. If one
@@ -4879,23 +4881,25 @@ def studysets_id_get(self, id : StrictStr, nested : Annotated[Optional[StrictBoo
         kwargs['_return_http_data_only'] = True
         if '_preload_content' in kwargs:
             raise ValueError("Error! Please call the studysets_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
-        return self.studysets_id_get_with_http_info(id, nested, **kwargs)  # noqa: E501
+        return self.studysets_id_get_with_http_info(id, nested, gzip, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def studysets_id_get_with_http_info(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="whether to show the URI to a resource (false) or to embed the object in the response (true)")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+    def studysets_id_get_with_http_info(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="whether to show the URI to a resource (false) or to embed the object in the response (true)")] = None, gzip : Annotated[Optional[StrictBool], Field(description="return the content as gzipped content")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """GET a studyset  # noqa: E501
 
         Retrieve the information of a studyset with the matching studyset ID.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.studysets_id_get_with_http_info(id, nested, async_req=True)
+        >>> thread = api.studysets_id_get_with_http_info(id, nested, gzip, async_req=True)
         >>> result = thread.get()
 
         :param id: (required)
         :type id: str
         :param nested: whether to show the URI to a resource (false) or to embed the object in the response (true)
         :type nested: bool
+        :param gzip: return the content as gzipped content
+        :type gzip: bool
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -4925,7 +4929,8 @@ def studysets_id_get_with_http_info(self, id : StrictStr, nested : Annotated[Opt
 
         _all_params = [
             'id',
-            'nested'
+            'nested',
+            'gzip'
         ]
         _all_params.extend(
             [
@@ -4962,6 +4967,9 @@ def studysets_id_get_with_http_info(self, id : StrictStr, nested : Annotated[Opt
         if _params.get('nested') is not None:  # noqa: E501
             _query_params.append(('nested', _params['nested']))
 
+        if _params.get('gzip') is not None:  # noqa: E501
+            _query_params.append(('gzip', _params['gzip']))
+
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
         # process the form parameters
@@ -4971,7 +4979,7 @@ def studysets_id_get_with_http_info(self, id : StrictStr, nested : Annotated[Opt
         _body_params = None
         # set the HTTP header `Accept`
         _header_params['Accept'] = self.api_client.select_header_accept(
-            ['application/json'])  # noqa: E501
+            ['application/json', 'application/gzip'])  # noqa: E501
 
         # authentication setting
         _auth_settings = []  # noqa: E501