Skip to content

Commit 243ba8a

Browse files
github-actions[bot]github-actions[bot]
committed
96ea8949aa6f737a692a4e5e87c1c105da27d383
1 parent f8f9af1 commit 243ba8a

File tree

6 files changed

+60
-27
lines changed

6 files changed

+60
-27
lines changed

‎docs/ComposeApi.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ Name | Type | Description | Notes
334334
[[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)
335335

336336
# **meta_analyses_get**
337-
> MetaAnalysisList meta_analyses_get(nested=nested)
337+
> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids)
338338
339339
GET a list of meta-analyses
340340

@@ -362,10 +362,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
362362
# Create an instance of the API class
363363
api_instance = neurosynth_compose_sdk.ComposeApi(api_client)
364364
nested = True # bool | show nested component instead of id (optional)
365+
ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional)
365366

366367
try:
367368
# GET a list of meta-analyses
368-
api_response = api_instance.meta_analyses_get(nested=nested)
369+
api_response = api_instance.meta_analyses_get(nested=nested, ids=ids)
369370
print("The response of ComposeApi->meta_analyses_get:\n")
370371
pprint(api_response)
371372
except Exception as e:
@@ -378,6 +379,7 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
378379
Name | Type | Description | Notes
379380
------------- | ------------- | ------------- | -------------
380381
**nested** | **bool**| show nested component instead of id | [optional]
382+
**ids** | [**List[str]**](str.md)| choose the specific ids you wish to get | [optional]
381383

382384
### Return type
383385

‎docs/GetApi.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ No authorization required
154154
[[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)
155155

156156
# **meta_analyses_get**
157-
> MetaAnalysisList meta_analyses_get(nested=nested)
157+
> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids)
158158
159159
GET a list of meta-analyses
160160

@@ -182,10 +182,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
182182
# Create an instance of the API class
183183
api_instance = neurosynth_compose_sdk.GetApi(api_client)
184184
nested = True # bool | show nested component instead of id (optional)
185+
ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional)
185186

186187
try:
187188
# GET a list of meta-analyses
188-
api_response = api_instance.meta_analyses_get(nested=nested)
189+
api_response = api_instance.meta_analyses_get(nested=nested, ids=ids)
189190
print("The response of GetApi->meta_analyses_get:\n")
190191
pprint(api_response)
191192
except Exception as e:
@@ -198,6 +199,7 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
198199
Name | Type | Description | Notes
199200
------------- | ------------- | ------------- | -------------
200201
**nested** | **bool**| show nested component instead of id | [optional]
202+
**ids** | [**List[str]**](str.md)| choose the specific ids you wish to get | [optional]
201203

202204
### Return type
203205

‎docs/MetaAnalysesApi.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Method | HTTP request | Description
1515

1616

1717
# **meta_analyses_get**
18-
> MetaAnalysisList meta_analyses_get(nested=nested)
18+
> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids)
1919
2020
GET a list of meta-analyses
2121

@@ -43,10 +43,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
4343
# Create an instance of the API class
4444
api_instance = neurosynth_compose_sdk.MetaAnalysesApi(api_client)
4545
nested = True # bool | show nested component instead of id (optional)
46+
ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional)
4647

4748
try:
4849
# GET a list of meta-analyses
49-
api_response = api_instance.meta_analyses_get(nested=nested)
50+
api_response = api_instance.meta_analyses_get(nested=nested, ids=ids)
5051
print("The response of MetaAnalysesApi->meta_analyses_get:\n")
5152
pprint(api_response)
5253
except Exception as e:
@@ -59,6 +60,7 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
5960
Name | Type | Description | Notes
6061
------------- | ------------- | ------------- | -------------
6162
**nested** | **bool**| show nested component instead of id | [optional]
63+
**ids** | [**List[str]**](str.md)| choose the specific ids you wish to get | [optional]
6264

6365
### Return type
6466

‎neurosynth_compose_sdk/api/compose_api.py‎

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
from pydantic import validate_arguments, ValidationError
2121
from typing_extensions import Annotated
2222

23-
from pydantic import Field, StrictBool, StrictStr
23+
from pydantic import Field, StrictBool, StrictStr, conlist
2424

2525
from typing import Optional
2626

@@ -654,18 +654,20 @@ def annotations_post_with_http_info(self, annotation_post_body : Optional[Annota
654654
_request_auth=_params.get('_request_auth'))
655655

656656
@validate_arguments
657-
def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> MetaAnalysisList: # noqa: E501
657+
def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, **kwargs) -> MetaAnalysisList: # noqa: E501
658658
"""GET a list of meta-analyses # noqa: E501
659659
660660
list all runnable specification, studyset, annotation bundles # noqa: E501
661661
This method makes a synchronous HTTP request by default. To make an
662662
asynchronous HTTP request, please pass async_req=True
663663
664-
>>> thread = api.meta_analyses_get(nested, async_req=True)
664+
>>> thread = api.meta_analyses_get(nested, ids, async_req=True)
665665
>>> result = thread.get()
666666
667667
:param nested: show nested component instead of id
668668
:type nested: bool
669+
:param ids: choose the specific ids you wish to get
670+
:type ids: List[str]
669671
:param async_req: Whether to execute the request asynchronously.
670672
:type async_req: bool, optional
671673
:param _request_timeout: timeout setting for this request. If one
@@ -680,21 +682,23 @@ def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(descr
680682
kwargs['_return_http_data_only'] = True
681683
if '_preload_content' in kwargs:
682684
raise ValueError("Error! Please call the meta_analyses_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
683-
return self.meta_analyses_get_with_http_info(nested, **kwargs) # noqa: E501
685+
return self.meta_analyses_get_with_http_info(nested, ids, **kwargs) # noqa: E501
684686

685687
@validate_arguments
686-
def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> ApiResponse: # noqa: E501
688+
def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, **kwargs) -> ApiResponse: # noqa: E501
687689
"""GET a list of meta-analyses # noqa: E501
688690
689691
list all runnable specification, studyset, annotation bundles # noqa: E501
690692
This method makes a synchronous HTTP request by default. To make an
691693
asynchronous HTTP request, please pass async_req=True
692694
693-
>>> thread = api.meta_analyses_get_with_http_info(nested, async_req=True)
695+
>>> thread = api.meta_analyses_get_with_http_info(nested, ids, async_req=True)
694696
>>> result = thread.get()
695697
696698
:param nested: show nested component instead of id
697699
:type nested: bool
700+
:param ids: choose the specific ids you wish to get
701+
:type ids: List[str]
698702
:param async_req: Whether to execute the request asynchronously.
699703
:type async_req: bool, optional
700704
:param _preload_content: if False, the ApiResponse.data will
@@ -723,7 +727,8 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo
723727
_params = locals()
724728

725729
_all_params = [
726-
'nested'
730+
'nested',
731+
'ids'
727732
]
728733
_all_params.extend(
729734
[
@@ -757,6 +762,10 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo
757762
if _params.get('nested') is not None: # noqa: E501
758763
_query_params.append(('nested', _params['nested']))
759764

765+
if _params.get('ids') is not None: # noqa: E501
766+
_query_params.append(('ids', _params['ids']))
767+
_collection_formats['ids'] = 'multi'
768+
760769
# process the header parameters
761770
_header_params = dict(_params.get('_headers', {}))
762771
# process the form parameters

‎neurosynth_compose_sdk/api/get_api.py‎

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
from pydantic import validate_arguments, ValidationError
2121
from typing_extensions import Annotated
2222

23-
from pydantic import Field, StrictBool, StrictStr
23+
from pydantic import Field, StrictBool, StrictStr, conlist
2424

2525
from typing import Optional
2626

@@ -334,18 +334,20 @@ def annotations_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiResp
334334
_request_auth=_params.get('_request_auth'))
335335

336336
@validate_arguments
337-
def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> MetaAnalysisList: # noqa: E501
337+
def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, **kwargs) -> MetaAnalysisList: # noqa: E501
338338
"""GET a list of meta-analyses # noqa: E501
339339
340340
list all runnable specification, studyset, annotation bundles # noqa: E501
341341
This method makes a synchronous HTTP request by default. To make an
342342
asynchronous HTTP request, please pass async_req=True
343343
344-
>>> thread = api.meta_analyses_get(nested, async_req=True)
344+
>>> thread = api.meta_analyses_get(nested, ids, async_req=True)
345345
>>> result = thread.get()
346346
347347
:param nested: show nested component instead of id
348348
:type nested: bool
349+
:param ids: choose the specific ids you wish to get
350+
:type ids: List[str]
349351
:param async_req: Whether to execute the request asynchronously.
350352
:type async_req: bool, optional
351353
:param _request_timeout: timeout setting for this request. If one
@@ -360,21 +362,23 @@ def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(descr
360362
kwargs['_return_http_data_only'] = True
361363
if '_preload_content' in kwargs:
362364
raise ValueError("Error! Please call the meta_analyses_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
363-
return self.meta_analyses_get_with_http_info(nested, **kwargs) # noqa: E501
365+
return self.meta_analyses_get_with_http_info(nested, ids, **kwargs) # noqa: E501
364366

365367
@validate_arguments
366-
def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> ApiResponse: # noqa: E501
368+
def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, **kwargs) -> ApiResponse: # noqa: E501
367369
"""GET a list of meta-analyses # noqa: E501
368370
369371
list all runnable specification, studyset, annotation bundles # noqa: E501
370372
This method makes a synchronous HTTP request by default. To make an
371373
asynchronous HTTP request, please pass async_req=True
372374
373-
>>> thread = api.meta_analyses_get_with_http_info(nested, async_req=True)
375+
>>> thread = api.meta_analyses_get_with_http_info(nested, ids, async_req=True)
374376
>>> result = thread.get()
375377
376378
:param nested: show nested component instead of id
377379
:type nested: bool
380+
:param ids: choose the specific ids you wish to get
381+
:type ids: List[str]
378382
:param async_req: Whether to execute the request asynchronously.
379383
:type async_req: bool, optional
380384
:param _preload_content: if False, the ApiResponse.data will
@@ -403,7 +407,8 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo
403407
_params = locals()
404408

405409
_all_params = [
406-
'nested'
410+
'nested',
411+
'ids'
407412
]
408413
_all_params.extend(
409414
[
@@ -437,6 +442,10 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo
437442
if _params.get('nested') is not None: # noqa: E501
438443
_query_params.append(('nested', _params['nested']))
439444

445+
if _params.get('ids') is not None: # noqa: E501
446+
_query_params.append(('ids', _params['ids']))
447+
_collection_formats['ids'] = 'multi'
448+
440449
# process the header parameters
441450
_header_params = dict(_params.get('_headers', {}))
442451
# process the form parameters

‎neurosynth_compose_sdk/api/meta_analyses_api.py‎

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
from pydantic import validate_arguments, ValidationError
2121
from typing_extensions import Annotated
2222

23-
from pydantic import Field, StrictBool, StrictStr
23+
from pydantic import Field, StrictBool, StrictStr, conlist
2424

2525
from typing import Optional
2626

@@ -54,18 +54,20 @@ def __init__(self, api_client=None):
5454
self.api_client = api_client
5555

5656
@validate_arguments
57-
def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> MetaAnalysisList: # noqa: E501
57+
def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, **kwargs) -> MetaAnalysisList: # noqa: E501
5858
"""GET a list of meta-analyses # noqa: E501
5959
6060
list all runnable specification, studyset, annotation bundles # noqa: E501
6161
This method makes a synchronous HTTP request by default. To make an
6262
asynchronous HTTP request, please pass async_req=True
6363
64-
>>> thread = api.meta_analyses_get(nested, async_req=True)
64+
>>> thread = api.meta_analyses_get(nested, ids, async_req=True)
6565
>>> result = thread.get()
6666
6767
:param nested: show nested component instead of id
6868
:type nested: bool
69+
:param ids: choose the specific ids you wish to get
70+
:type ids: List[str]
6971
:param async_req: Whether to execute the request asynchronously.
7072
:type async_req: bool, optional
7173
:param _request_timeout: timeout setting for this request. If one
@@ -80,21 +82,23 @@ def meta_analyses_get(self, nested : Annotated[Optional[StrictBool], Field(descr
8082
kwargs['_return_http_data_only'] = True
8183
if '_preload_content' in kwargs:
8284
raise ValueError("Error! Please call the meta_analyses_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
83-
return self.meta_analyses_get_with_http_info(nested, **kwargs) # noqa: E501
85+
return self.meta_analyses_get_with_http_info(nested, ids, **kwargs) # noqa: E501
8486

8587
@validate_arguments
86-
def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, **kwargs) -> ApiResponse: # noqa: E501
88+
def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBool], Field(description="show nested component instead of id")] = None, ids : Annotated[Optional[conlist(StrictStr)], Field(description="choose the specific ids you wish to get")] = None, **kwargs) -> ApiResponse: # noqa: E501
8789
"""GET a list of meta-analyses # noqa: E501
8890
8991
list all runnable specification, studyset, annotation bundles # noqa: E501
9092
This method makes a synchronous HTTP request by default. To make an
9193
asynchronous HTTP request, please pass async_req=True
9294
93-
>>> thread = api.meta_analyses_get_with_http_info(nested, async_req=True)
95+
>>> thread = api.meta_analyses_get_with_http_info(nested, ids, async_req=True)
9496
>>> result = thread.get()
9597
9698
:param nested: show nested component instead of id
9799
:type nested: bool
100+
:param ids: choose the specific ids you wish to get
101+
:type ids: List[str]
98102
:param async_req: Whether to execute the request asynchronously.
99103
:type async_req: bool, optional
100104
:param _preload_content: if False, the ApiResponse.data will
@@ -123,7 +127,8 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo
123127
_params = locals()
124128

125129
_all_params = [
126-
'nested'
130+
'nested',
131+
'ids'
127132
]
128133
_all_params.extend(
129134
[
@@ -157,6 +162,10 @@ def meta_analyses_get_with_http_info(self, nested : Annotated[Optional[StrictBoo
157162
if _params.get('nested') is not None: # noqa: E501
158163
_query_params.append(('nested', _params['nested']))
159164

165+
if _params.get('ids') is not None: # noqa: E501
166+
_query_params.append(('ids', _params['ids']))
167+
_collection_formats['ids'] = 'multi'
168+
160169
# process the header parameters
161170
_header_params = dict(_params.get('_headers', {}))
162171
# process the form parameters

0 commit comments

Comments
 (0)