1a501fe52829c7d0c8fd9d568bcd7c69a86eb316

Author: github-actions[bot]

.openapi-generator/FILES

@@ -51,6 +51,7 @@ docs/ResultList.md
 docs/ResultListResults.md
 docs/ResultReturn.md
 docs/Specification.md
+docs/SpecificationConditions.md
 docs/SpecificationList.md
 docs/SpecificationPostBody.md
 docs/SpecificationReturn.md
@@ -127,6 +128,7 @@ neurosynth_compose_sdk/models/result_list.py
 neurosynth_compose_sdk/models/result_list_results.py
 neurosynth_compose_sdk/models/result_return.py
 neurosynth_compose_sdk/models/specification.py
+neurosynth_compose_sdk/models/specification_conditions.py
 neurosynth_compose_sdk/models/specification_list.py
 neurosynth_compose_sdk/models/specification_post_body.py
 neurosynth_compose_sdk/models/specification_return.py
@@ -148,8 +150,5 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
-test/test_studyset_reference.py
-test/test_studyset_reference_list.py
-test/test_studyset_reference_return.py
-test/test_studyset_reference_snapshots_inner.py
+test/test_specification_conditions.py
 tox.ini

README.md

@@ -236,6 +236,7 @@ Class | Method | HTTP request | Description
  - [ResultListResults](docs/ResultListResults.md)
  - [ResultReturn](docs/ResultReturn.md)
  - [Specification](docs/Specification.md)
+ - [SpecificationConditions](docs/SpecificationConditions.md)
  - [SpecificationList](docs/SpecificationList.md)
  - [SpecificationPostBody](docs/SpecificationPostBody.md)
  - [SpecificationReturn](docs/SpecificationReturn.md)

docs/DefaultApi.md

@@ -425,7 +425,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)
 
 # **studyset_references_get**
-> StudysetReferenceList studyset_references_get()
+> StudysetReferenceList studyset_references_get(nested=nested)
 
 Your GET endpoint
 
@@ -452,10 +452,11 @@ configuration = neurosynth_compose_sdk.Configuration(
 with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = neurosynth_compose_sdk.DefaultApi(api_client)
+    nested = True # bool | show nested component instead of id (optional)
 
     try:
         # Your GET endpoint
-        api_response = api_instance.studyset_references_get()
+        api_response = api_instance.studyset_references_get(nested=nested)
         print("The response of DefaultApi->studyset_references_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -464,7 +465,10 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
 
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **nested** | **bool**| show nested component instead of id | [optional] 
 
 ### Return type
 
@@ -487,7 +491,7 @@ No authorization required
 [[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)
 
 # **studyset_references_id_get**
-> StudysetReferenceReturn studyset_references_id_get(id)
+> StudysetReferenceReturn studyset_references_id_get(id, nested=nested)
 
 Your GET endpoint
 
@@ -513,10 +517,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = neurosynth_compose_sdk.DefaultApi(api_client)
     id = 'id_example' # str | 
+    nested = True # bool | show nested component instead of id (optional)
 
     try:
         # Your GET endpoint
-        api_response = api_instance.studyset_references_id_get(id)
+        api_response = api_instance.studyset_references_id_get(id, nested=nested)
         print("The response of DefaultApi->studyset_references_id_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -529,6 +534,7 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **str**|  | 
+ **nested** | **bool**| show nested component instead of id | [optional] 
 
 ### Return type
 

docs/MetaAnalysisSpecification.md

@@ -7,10 +7,12 @@ Name | Type | Description | Notes
 **type** | **str** | the type of meta-analysis being run, typically either cbma or ibma, but others may become available in the future. | [optional] 
 **estimator** | [**Estimator**](Estimator.md) |  | [optional] 
 **mask** | **str** | a string representing a binary nifti file to select which voxels a user wants to include in the analysis. | [optional] 
-**contrast** | **str** | selection of categories in the filter column to differentiate groups, or \"neurosynth\", \"neuroquery\", or \"neurostore\" to compare to a database reference group | [optional] 
+**conditions** | [**SpecificationConditions**](SpecificationConditions.md) |  | [optional] 
+**weights** | **List[float]** |  | [optional] 
 **transformer** | **str** | A transformation applied to column(s) (e.g., binarize based on a threshold). This is likely to become deprecated. | [optional] 
 **corrector** | [**Corrector**](Corrector.md) |  | [optional] 
 **filter** | **str** | a column from annotations selecting which analyses to include in the meta-analysis | [optional] 
+**database_studyset** | **str** |  | [optional] 
 
 ## Example
 

docs/Specification.md

@@ -8,10 +8,12 @@ Name | Type | Description | Notes
 **type** | **str** | the type of meta-analysis being run, typically either cbma or ibma, but others may become available in the future. | [optional] 
 **estimator** | [**Estimator**](Estimator.md) |  | [optional] 
 **mask** | **str** | a string representing a binary nifti file to select which voxels a user wants to include in the analysis. | [optional] 
-**contrast** | **str** | selection of categories in the filter column to differentiate groups, or \"neurosynth\", \"neuroquery\", or \"neurostore\" to compare to a database reference group | [optional] 
+**conditions** | [**SpecificationConditions**](SpecificationConditions.md) |  | [optional] 
+**weights** | **List[float]** |  | [optional] 
 **transformer** | **str** | A transformation applied to column(s) (e.g., binarize based on a threshold). This is likely to become deprecated. | [optional] 
 **corrector** | [**Corrector**](Corrector.md) |  | [optional] 
 **filter** | **str** | a column from annotations selecting which analyses to include in the meta-analysis | [optional] 
+**database_studyset** | **str** |  | [optional] 
 
 ## Example
 

docs/SpecificationConditions.md

@@ -0,0 +1,28 @@
+# SpecificationConditions
+
+selection of categories in the filter column to differentiate groups, or \"neurosynth\", \"neuroquery\", or \"neurostore\" to compare to a database reference group
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```python
+from neurosynth_compose_sdk.models.specification_conditions import SpecificationConditions
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of SpecificationConditions from a JSON string
+specification_conditions_instance = SpecificationConditions.from_json(json)
+# print the JSON string representation of the object
+print SpecificationConditions.to_json()
+
+# convert the object into a dict
+specification_conditions_dict = specification_conditions_instance.to_dict()
+# create an instance of SpecificationConditions from a dict
+specification_conditions_form_dict = specification_conditions.from_dict(specification_conditions_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/SpecificationPostBody.md

@@ -7,10 +7,12 @@ Name | Type | Description | Notes
 **type** | **str** | the type of meta-analysis being run, typically either cbma or ibma, but others may become available in the future. | [optional] 
 **estimator** | [**Estimator**](Estimator.md) |  | [optional] 
 **mask** | **str** | a string representing a binary nifti file to select which voxels a user wants to include in the analysis. | [optional] 
-**contrast** | **str** | selection of categories in the filter column to differentiate groups, or \"neurosynth\", \"neuroquery\", or \"neurostore\" to compare to a database reference group | [optional] 
+**conditions** | [**SpecificationConditions**](SpecificationConditions.md) |  | [optional] 
+**weights** | **List[float]** |  | [optional] 
 **transformer** | **str** | A transformation applied to column(s) (e.g., binarize based on a threshold). This is likely to become deprecated. | [optional] 
 **corrector** | [**Corrector**](Corrector.md) |  | [optional] 
 **filter** | **str** | a column from annotations selecting which analyses to include in the meta-analysis | [optional] 
+**database_studyset** | **str** |  | [optional] 
 
 ## Example
 

docs/SpecificationReturn.md

@@ -8,10 +8,12 @@ Name | Type | Description | Notes
 **type** | **str** | the type of meta-analysis being run, typically either cbma or ibma, but others may become available in the future. | [optional] 
 **estimator** | [**Estimator**](Estimator.md) |  | [optional] 
 **mask** | **str** | a string representing a binary nifti file to select which voxels a user wants to include in the analysis. | [optional] 
-**contrast** | **str** | selection of categories in the filter column to differentiate groups, or \"neurosynth\", \"neuroquery\", or \"neurostore\" to compare to a database reference group | [optional] 
+**conditions** | [**SpecificationConditions**](SpecificationConditions.md) |  | [optional] 
+**weights** | **List[float]** |  | [optional] 
 **transformer** | **str** | A transformation applied to column(s) (e.g., binarize based on a threshold). This is likely to become deprecated. | [optional] 
 **corrector** | [**Corrector**](Corrector.md) |  | [optional] 
 **filter** | **str** | a column from annotations selecting which analyses to include in the meta-analysis | [optional] 
+**database_studyset** | **str** |  | [optional] 
 **id** | **str** | the identifier for the resource. | [optional] 
 **updated_at** | **datetime** | when the resource was last modified. | [optional] [readonly] 
 **created_at** | **datetime** | When the resource was created. | [optional] [readonly] 

neurosynth_compose_sdk/__init__.py

@@ -82,6 +82,7 @@
 from neurosynth_compose_sdk.models.result_list_results import ResultListResults
 from neurosynth_compose_sdk.models.result_return import ResultReturn
 from neurosynth_compose_sdk.models.specification import Specification
+from neurosynth_compose_sdk.models.specification_conditions import SpecificationConditions
 from neurosynth_compose_sdk.models.specification_list import SpecificationList
 from neurosynth_compose_sdk.models.specification_post_body import SpecificationPostBody
 from neurosynth_compose_sdk.models.specification_return import SpecificationReturn

neurosynth_compose_sdk/api/default_api.py

@@ -20,7 +20,9 @@
 from pydantic import validate_arguments, ValidationError
 from typing_extensions import Annotated
 
-from pydantic import StrictStr
+from pydantic import Field, StrictBool, StrictStr
+
+from typing import Optional
 
 from neurosynth_compose_sdk.models.neurostore_study_list import NeurostoreStudyList
 from neurosynth_compose_sdk.models.neurostore_study_return import NeurostoreStudyReturn
@@ -856,16 +858,18 @@ def projects_id_delete_with_http_info(self, id : StrictStr, **kwargs) -> ApiResp
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def studyset_references_get(self, **kwargs) -> StudysetReferenceList:  # noqa: E501
+    def studyset_references_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> StudysetReferenceList:  # noqa: E501
         """Your GET endpoint  # noqa: E501
 
           # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.studyset_references_get(async_req=True)
+        >>> thread = api.studyset_references_get(nested, async_req=True)
         >>> result = thread.get()
 
+        :param nested: show nested component instead of id
+        :type nested: 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
@@ -880,19 +884,21 @@ def studyset_references_get(self, **kwargs) -> StudysetReferenceList:  # noqa: E
         kwargs['_return_http_data_only'] = True
         if '_preload_content' in kwargs:
             raise ValueError("Error! Please call the studyset_references_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
-        return self.studyset_references_get_with_http_info(**kwargs)  # noqa: E501
+        return self.studyset_references_get_with_http_info(nested, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def studyset_references_get_with_http_info(self, **kwargs) -> ApiResponse:  # noqa: E501
+    def studyset_references_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """Your GET endpoint  # noqa: E501
 
           # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.studyset_references_get_with_http_info(async_req=True)
+        >>> thread = api.studyset_references_get_with_http_info(nested, async_req=True)
         >>> result = thread.get()
 
+        :param nested: show nested component instead of id
+        :type nested: bool
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -921,6 +927,7 @@ def studyset_references_get_with_http_info(self, **kwargs) -> ApiResponse:  # no
         _params = locals()
 
         _all_params = [
+            'nested'
         ]
         _all_params.extend(
             [
@@ -951,6 +958,9 @@ def studyset_references_get_with_http_info(self, **kwargs) -> ApiResponse:  # no
 
         # process the query parameters
         _query_params = []
+        if _params.get('nested') is not None:  # noqa: E501
+            _query_params.append(('nested', _params['nested']))
+
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
         # process the form parameters
@@ -987,17 +997,19 @@ def studyset_references_get_with_http_info(self, **kwargs) -> ApiResponse:  # no
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def studyset_references_id_get(self, id : StrictStr, **kwargs) -> StudysetReferenceReturn:  # noqa: E501
+    def studyset_references_id_get(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> StudysetReferenceReturn:  # noqa: E501
         """Your GET endpoint  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.studyset_references_id_get(id, async_req=True)
+        >>> thread = api.studyset_references_id_get(id, nested, async_req=True)
         >>> result = thread.get()
 
         :param id: (required)
         :type id: str
+        :param nested: show nested component instead of id
+        :type nested: 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
@@ -1012,20 +1024,22 @@ def studyset_references_id_get(self, id : StrictStr, **kwargs) -> StudysetRefere
         kwargs['_return_http_data_only'] = True
         if '_preload_content' in kwargs:
             raise ValueError("Error! Please call the studyset_references_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
-        return self.studyset_references_id_get_with_http_info(id, **kwargs)  # noqa: E501
+        return self.studyset_references_id_get_with_http_info(id, nested, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def studyset_references_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse:  # noqa: E501
+    def studyset_references_id_get_with_http_info(self, id : StrictStr, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> ApiResponse:  # noqa: E501
         """Your GET endpoint  # noqa: E501
 
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.studyset_references_id_get_with_http_info(id, async_req=True)
+        >>> thread = api.studyset_references_id_get_with_http_info(id, nested, async_req=True)
         >>> result = thread.get()
 
         :param id: (required)
         :type id: str
+        :param nested: show nested component instead of id
+        :type nested: bool
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the ApiResponse.data will
@@ -1054,7 +1068,8 @@ def studyset_references_id_get_with_http_info(self, id : StrictStr, **kwargs) ->
         _params = locals()
 
         _all_params = [
-            'id'
+            'id',
+            'nested'
         ]
         _all_params.extend(
             [
@@ -1088,6 +1103,9 @@ def studyset_references_id_get_with_http_info(self, id : StrictStr, **kwargs) ->
 
         # process the query parameters
         _query_params = []
+        if _params.get('nested') is not None:  # noqa: E501
+            _query_params.append(('nested', _params['nested']))
+
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
         # process the form parameters