Skip to content

Commit f8f9af1

Browse files
743c21042f4e85e9583b203ae6b6616bb0fa9a87
1 parent 7779c2a commit f8f9af1

File tree

6 files changed

+55
-25
lines changed

6 files changed

+55
-25
lines changed

docs/ComposeApi.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1625,7 +1625,7 @@ void (empty response body)
16251625
[[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)
16261626

16271627
# **projects_id_get**
1628-
> ProjectReturn projects_id_get(id)
1628+
> ProjectReturn projects_id_get(id, info=info)
16291629
16301630
Your GET endpoint
16311631

@@ -1651,10 +1651,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
16511651
# Create an instance of the API class
16521652
api_instance = neurosynth_compose_sdk.ComposeApi(api_client)
16531653
id = 'id_example' # str |
1654+
info = True # bool | display additional information about a nested relationship without displaying fully nested object (optional)
16541655

16551656
try:
16561657
# Your GET endpoint
1657-
api_response = api_instance.projects_id_get(id)
1658+
api_response = api_instance.projects_id_get(id, info=info)
16581659
print("The response of ComposeApi->projects_id_get:\n")
16591660
pprint(api_response)
16601661
except Exception as e:
@@ -1667,6 +1668,7 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
16671668
Name | Type | Description | Notes
16681669
------------- | ------------- | ------------- | -------------
16691670
**id** | **str**| |
1671+
**info** | **bool**| display additional information about a nested relationship without displaying fully nested object | [optional]
16701672

16711673
### Return type
16721674

docs/GetApi.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -734,7 +734,7 @@ This endpoint does not need any parameter.
734734
[[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)
735735

736736
# **projects_id_get**
737-
> ProjectReturn projects_id_get(id)
737+
> ProjectReturn projects_id_get(id, info=info)
738738
739739
Your GET endpoint
740740

@@ -760,10 +760,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
760760
# Create an instance of the API class
761761
api_instance = neurosynth_compose_sdk.GetApi(api_client)
762762
id = 'id_example' # str |
763+
info = True # bool | display additional information about a nested relationship without displaying fully nested object (optional)
763764

764765
try:
765766
# Your GET endpoint
766-
api_response = api_instance.projects_id_get(id)
767+
api_response = api_instance.projects_id_get(id, info=info)
767768
print("The response of GetApi->projects_id_get:\n")
768769
pprint(api_response)
769770
except Exception as e:
@@ -776,6 +777,7 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
776777
Name | Type | Description | Notes
777778
------------- | ------------- | ------------- | -------------
778779
**id** | **str**| |
780+
**info** | **bool**| display additional information about a nested relationship without displaying fully nested object | [optional]
779781

780782
### Return type
781783

docs/ProjectsApi.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ void (empty response body)
153153
[[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)
154154

155155
# **projects_id_get**
156-
> ProjectReturn projects_id_get(id)
156+
> ProjectReturn projects_id_get(id, info=info)
157157
158158
Your GET endpoint
159159

@@ -179,10 +179,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
179179
# Create an instance of the API class
180180
api_instance = neurosynth_compose_sdk.ProjectsApi(api_client)
181181
id = 'id_example' # str |
182+
info = True # bool | display additional information about a nested relationship without displaying fully nested object (optional)
182183

183184
try:
184185
# Your GET endpoint
185-
api_response = api_instance.projects_id_get(id)
186+
api_response = api_instance.projects_id_get(id, info=info)
186187
print("The response of ProjectsApi->projects_id_get:\n")
187188
pprint(api_response)
188189
except Exception as e:
@@ -195,6 +196,7 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
195196
Name | Type | Description | Notes
196197
------------- | ------------- | ------------- | -------------
197198
**id** | **str**| |
199+
**info** | **bool**| display additional information about a nested relationship without displaying fully nested object | [optional]
198200

199201
### Return type
200202

neurosynth_compose_sdk/api/compose_api.py

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3227,17 +3227,19 @@ def projects_id_delete_with_http_info(self, id : StrictStr, **kwargs) -> ApiResp
32273227
_request_auth=_params.get('_request_auth'))
32283228

32293229
@validate_arguments
3230-
def projects_id_get(self, id : StrictStr, **kwargs) -> ProjectReturn: # noqa: E501
3230+
def projects_id_get(self, id : StrictStr, info : Annotated[Optional[StrictBool], Field(description="display additional information about a nested relationship without displaying fully nested object")] = None, **kwargs) -> ProjectReturn: # noqa: E501
32313231
"""Your GET endpoint # noqa: E501
32323232
32333233
This method makes a synchronous HTTP request by default. To make an
32343234
asynchronous HTTP request, please pass async_req=True
32353235
3236-
>>> thread = api.projects_id_get(id, async_req=True)
3236+
>>> thread = api.projects_id_get(id, info, async_req=True)
32373237
>>> result = thread.get()
32383238
32393239
:param id: (required)
32403240
:type id: str
3241+
:param info: display additional information about a nested relationship without displaying fully nested object
3242+
:type info: bool
32413243
:param async_req: Whether to execute the request asynchronously.
32423244
:type async_req: bool, optional
32433245
:param _request_timeout: timeout setting for this request. If one
@@ -3252,20 +3254,22 @@ def projects_id_get(self, id : StrictStr, **kwargs) -> ProjectReturn: # noqa: E
32523254
kwargs['_return_http_data_only'] = True
32533255
if '_preload_content' in kwargs:
32543256
raise ValueError("Error! Please call the projects_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
3255-
return self.projects_id_get_with_http_info(id, **kwargs) # noqa: E501
3257+
return self.projects_id_get_with_http_info(id, info, **kwargs) # noqa: E501
32563258

32573259
@validate_arguments
3258-
def projects_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501
3260+
def projects_id_get_with_http_info(self, id : StrictStr, info : Annotated[Optional[StrictBool], Field(description="display additional information about a nested relationship without displaying fully nested object")] = None, **kwargs) -> ApiResponse: # noqa: E501
32593261
"""Your GET endpoint # noqa: E501
32603262
32613263
This method makes a synchronous HTTP request by default. To make an
32623264
asynchronous HTTP request, please pass async_req=True
32633265
3264-
>>> thread = api.projects_id_get_with_http_info(id, async_req=True)
3266+
>>> thread = api.projects_id_get_with_http_info(id, info, async_req=True)
32653267
>>> result = thread.get()
32663268
32673269
:param id: (required)
32683270
:type id: str
3271+
:param info: display additional information about a nested relationship without displaying fully nested object
3272+
:type info: bool
32693273
:param async_req: Whether to execute the request asynchronously.
32703274
:type async_req: bool, optional
32713275
:param _preload_content: if False, the ApiResponse.data will
@@ -3294,7 +3298,8 @@ def projects_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiRespons
32943298
_params = locals()
32953299

32963300
_all_params = [
3297-
'id'
3301+
'id',
3302+
'info'
32983303
]
32993304
_all_params.extend(
33003305
[
@@ -3328,6 +3333,9 @@ def projects_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiRespons
33283333

33293334
# process the query parameters
33303335
_query_params = []
3336+
if _params.get('info') is not None: # noqa: E501
3337+
_query_params.append(('info', _params['info']))
3338+
33313339
# process the header parameters
33323340
_header_params = dict(_params.get('_headers', {}))
33333341
# process the form parameters

neurosynth_compose_sdk/api/get_api.py

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1552,17 +1552,19 @@ def projects_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501
15521552
_request_auth=_params.get('_request_auth'))
15531553

15541554
@validate_arguments
1555-
def projects_id_get(self, id : StrictStr, **kwargs) -> ProjectReturn: # noqa: E501
1555+
def projects_id_get(self, id : StrictStr, info : Annotated[Optional[StrictBool], Field(description="display additional information about a nested relationship without displaying fully nested object")] = None, **kwargs) -> ProjectReturn: # noqa: E501
15561556
"""Your GET endpoint # noqa: E501
15571557
15581558
This method makes a synchronous HTTP request by default. To make an
15591559
asynchronous HTTP request, please pass async_req=True
15601560
1561-
>>> thread = api.projects_id_get(id, async_req=True)
1561+
>>> thread = api.projects_id_get(id, info, async_req=True)
15621562
>>> result = thread.get()
15631563
15641564
:param id: (required)
15651565
:type id: str
1566+
:param info: display additional information about a nested relationship without displaying fully nested object
1567+
:type info: bool
15661568
:param async_req: Whether to execute the request asynchronously.
15671569
:type async_req: bool, optional
15681570
:param _request_timeout: timeout setting for this request. If one
@@ -1577,20 +1579,22 @@ def projects_id_get(self, id : StrictStr, **kwargs) -> ProjectReturn: # noqa: E
15771579
kwargs['_return_http_data_only'] = True
15781580
if '_preload_content' in kwargs:
15791581
raise ValueError("Error! Please call the projects_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
1580-
return self.projects_id_get_with_http_info(id, **kwargs) # noqa: E501
1582+
return self.projects_id_get_with_http_info(id, info, **kwargs) # noqa: E501
15811583

15821584
@validate_arguments
1583-
def projects_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501
1585+
def projects_id_get_with_http_info(self, id : StrictStr, info : Annotated[Optional[StrictBool], Field(description="display additional information about a nested relationship without displaying fully nested object")] = None, **kwargs) -> ApiResponse: # noqa: E501
15841586
"""Your GET endpoint # noqa: E501
15851587
15861588
This method makes a synchronous HTTP request by default. To make an
15871589
asynchronous HTTP request, please pass async_req=True
15881590
1589-
>>> thread = api.projects_id_get_with_http_info(id, async_req=True)
1591+
>>> thread = api.projects_id_get_with_http_info(id, info, async_req=True)
15901592
>>> result = thread.get()
15911593
15921594
:param id: (required)
15931595
:type id: str
1596+
:param info: display additional information about a nested relationship without displaying fully nested object
1597+
:type info: bool
15941598
:param async_req: Whether to execute the request asynchronously.
15951599
:type async_req: bool, optional
15961600
:param _preload_content: if False, the ApiResponse.data will
@@ -1619,7 +1623,8 @@ def projects_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiRespons
16191623
_params = locals()
16201624

16211625
_all_params = [
1622-
'id'
1626+
'id',
1627+
'info'
16231628
]
16241629
_all_params.extend(
16251630
[
@@ -1653,6 +1658,9 @@ def projects_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiRespons
16531658

16541659
# process the query parameters
16551660
_query_params = []
1661+
if _params.get('info') is not None: # noqa: E501
1662+
_query_params.append(('info', _params['info']))
1663+
16561664
# process the header parameters
16571665
_header_params = dict(_params.get('_headers', {}))
16581666
# process the form parameters

neurosynth_compose_sdk/api/projects_api.py

Lines changed: 15 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 StrictStr
23+
from pydantic import Field, StrictBool, StrictStr
2424

2525
from typing import Optional
2626

@@ -309,17 +309,19 @@ def projects_id_delete_with_http_info(self, id : StrictStr, **kwargs) -> ApiResp
309309
_request_auth=_params.get('_request_auth'))
310310

311311
@validate_arguments
312-
def projects_id_get(self, id : StrictStr, **kwargs) -> ProjectReturn: # noqa: E501
312+
def projects_id_get(self, id : StrictStr, info : Annotated[Optional[StrictBool], Field(description="display additional information about a nested relationship without displaying fully nested object")] = None, **kwargs) -> ProjectReturn: # noqa: E501
313313
"""Your GET endpoint # noqa: E501
314314
315315
This method makes a synchronous HTTP request by default. To make an
316316
asynchronous HTTP request, please pass async_req=True
317317
318-
>>> thread = api.projects_id_get(id, async_req=True)
318+
>>> thread = api.projects_id_get(id, info, async_req=True)
319319
>>> result = thread.get()
320320
321321
:param id: (required)
322322
:type id: str
323+
:param info: display additional information about a nested relationship without displaying fully nested object
324+
:type info: bool
323325
:param async_req: Whether to execute the request asynchronously.
324326
:type async_req: bool, optional
325327
:param _request_timeout: timeout setting for this request. If one
@@ -334,20 +336,22 @@ def projects_id_get(self, id : StrictStr, **kwargs) -> ProjectReturn: # noqa: E
334336
kwargs['_return_http_data_only'] = True
335337
if '_preload_content' in kwargs:
336338
raise ValueError("Error! Please call the projects_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
337-
return self.projects_id_get_with_http_info(id, **kwargs) # noqa: E501
339+
return self.projects_id_get_with_http_info(id, info, **kwargs) # noqa: E501
338340

339341
@validate_arguments
340-
def projects_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiResponse: # noqa: E501
342+
def projects_id_get_with_http_info(self, id : StrictStr, info : Annotated[Optional[StrictBool], Field(description="display additional information about a nested relationship without displaying fully nested object")] = None, **kwargs) -> ApiResponse: # noqa: E501
341343
"""Your GET endpoint # noqa: E501
342344
343345
This method makes a synchronous HTTP request by default. To make an
344346
asynchronous HTTP request, please pass async_req=True
345347
346-
>>> thread = api.projects_id_get_with_http_info(id, async_req=True)
348+
>>> thread = api.projects_id_get_with_http_info(id, info, async_req=True)
347349
>>> result = thread.get()
348350
349351
:param id: (required)
350352
:type id: str
353+
:param info: display additional information about a nested relationship without displaying fully nested object
354+
:type info: bool
351355
:param async_req: Whether to execute the request asynchronously.
352356
:type async_req: bool, optional
353357
:param _preload_content: if False, the ApiResponse.data will
@@ -376,7 +380,8 @@ def projects_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiRespons
376380
_params = locals()
377381

378382
_all_params = [
379-
'id'
383+
'id',
384+
'info'
380385
]
381386
_all_params.extend(
382387
[
@@ -410,6 +415,9 @@ def projects_id_get_with_http_info(self, id : StrictStr, **kwargs) -> ApiRespons
410415

411416
# process the query parameters
412417
_query_params = []
418+
if _params.get('info') is not None: # noqa: E501
419+
_query_params.append(('info', _params['info']))
420+
413421
# process the header parameters
414422
_header_params = dict(_params.get('_headers', {}))
415423
# process the form parameters

0 commit comments

Comments
 (0)