Skip to content

Commit d7609a1

Browse files
8cf0c7a2a84b93cd7434ce4c96280a30778a29b0
1 parent 243ba8a commit d7609a1

File tree

8 files changed

+478
-52
lines changed

8 files changed

+478
-52
lines changed

docs/ComposeApi.md

Lines changed: 35 additions & 5 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, ids=ids)
337+
> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
338338
339339
GET a list of meta-analyses
340340

@@ -363,10 +363,17 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
363363
api_instance = neurosynth_compose_sdk.ComposeApi(api_client)
364364
nested = True # bool | show nested component instead of id (optional)
365365
ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional)
366+
page = 56 # int | page of results (optional)
367+
page_size = 56 # int | number of elements to return on a page (optional)
368+
name = 'name_example' # str | search the name field for a term (optional)
369+
search = 'imagin' # str | search for entries that contain the substring (optional)
370+
description = 'description_example' # str | search description field for a term (optional)
371+
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')
372+
desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
366373

367374
try:
368375
# GET a list of meta-analyses
369-
api_response = api_instance.meta_analyses_get(nested=nested, ids=ids)
376+
api_response = api_instance.meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
370377
print("The response of ComposeApi->meta_analyses_get:\n")
371378
pprint(api_response)
372379
except Exception as e:
@@ -380,6 +387,13 @@ Name | Type | Description | Notes
380387
------------- | ------------- | ------------- | -------------
381388
**nested** | **bool**| show nested component instead of id | [optional]
382389
**ids** | [**List[str]**](str.md)| choose the specific ids you wish to get | [optional]
390+
**page** | **int**| page of results | [optional]
391+
**page_size** | **int**| number of elements to return on a page | [optional]
392+
**name** | **str**| search the name field for a term | [optional]
393+
**search** | **str**| search for entries that contain the substring | [optional]
394+
**description** | **str**| search description field for a term | [optional]
395+
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']
396+
**desc** | **bool**| sort results by descending order (as opposed to ascending order) | [optional]
383397

384398
### Return type
385399

@@ -1486,7 +1500,7 @@ Name | Type | Description | Notes
14861500
[[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)
14871501

14881502
# **projects_get**
1489-
> ProjectList projects_get()
1503+
> ProjectList projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
14901504
14911505
Your GET endpoint
14921506

@@ -1521,10 +1535,17 @@ configuration = neurosynth_compose_sdk.Configuration(
15211535
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
15221536
# Create an instance of the API class
15231537
api_instance = neurosynth_compose_sdk.ComposeApi(api_client)
1538+
page = 56 # int | page of results (optional)
1539+
page_size = 56 # int | number of elements to return on a page (optional)
1540+
name = 'name_example' # str | search the name field for a term (optional)
1541+
search = 'imagin' # str | search for entries that contain the substring (optional)
1542+
description = 'description_example' # str | search description field for a term (optional)
1543+
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')
1544+
desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
15241545

15251546
try:
15261547
# Your GET endpoint
1527-
api_response = api_instance.projects_get()
1548+
api_response = api_instance.projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
15281549
print("The response of ComposeApi->projects_get:\n")
15291550
pprint(api_response)
15301551
except Exception as e:
@@ -1533,7 +1554,16 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
15331554

15341555

15351556
### Parameters
1536-
This endpoint does not need any parameter.
1557+
1558+
Name | Type | Description | Notes
1559+
------------- | ------------- | ------------- | -------------
1560+
**page** | **int**| page of results | [optional]
1561+
**page_size** | **int**| number of elements to return on a page | [optional]
1562+
**name** | **str**| search the name field for a term | [optional]
1563+
**search** | **str**| search for entries that contain the substring | [optional]
1564+
**description** | **str**| search description field for a term | [optional]
1565+
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']
1566+
**desc** | **bool**| sort results by descending order (as opposed to ascending order) | [optional]
15371567

15381568
### Return type
15391569

docs/GetApi.md

Lines changed: 35 additions & 5 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, ids=ids)
157+
> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
158158
159159
GET a list of meta-analyses
160160

@@ -183,10 +183,17 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
183183
api_instance = neurosynth_compose_sdk.GetApi(api_client)
184184
nested = True # bool | show nested component instead of id (optional)
185185
ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional)
186+
page = 56 # int | page of results (optional)
187+
page_size = 56 # int | number of elements to return on a page (optional)
188+
name = 'name_example' # str | search the name field for a term (optional)
189+
search = 'imagin' # str | search for entries that contain the substring (optional)
190+
description = 'description_example' # str | search description field for a term (optional)
191+
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')
192+
desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
186193

187194
try:
188195
# GET a list of meta-analyses
189-
api_response = api_instance.meta_analyses_get(nested=nested, ids=ids)
196+
api_response = api_instance.meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
190197
print("The response of GetApi->meta_analyses_get:\n")
191198
pprint(api_response)
192199
except Exception as e:
@@ -200,6 +207,13 @@ Name | Type | Description | Notes
200207
------------- | ------------- | ------------- | -------------
201208
**nested** | **bool**| show nested component instead of id | [optional]
202209
**ids** | [**List[str]**](str.md)| choose the specific ids you wish to get | [optional]
210+
**page** | **int**| page of results | [optional]
211+
**page_size** | **int**| number of elements to return on a page | [optional]
212+
**name** | **str**| search the name field for a term | [optional]
213+
**search** | **str**| search for entries that contain the substring | [optional]
214+
**description** | **str**| search description field for a term | [optional]
215+
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']
216+
**desc** | **bool**| sort results by descending order (as opposed to ascending order) | [optional]
203217

204218
### Return type
205219

@@ -666,7 +680,7 @@ No authorization required
666680
[[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)
667681

668682
# **projects_get**
669-
> ProjectList projects_get()
683+
> ProjectList projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
670684
671685
Your GET endpoint
672686

@@ -701,10 +715,17 @@ configuration = neurosynth_compose_sdk.Configuration(
701715
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
702716
# Create an instance of the API class
703717
api_instance = neurosynth_compose_sdk.GetApi(api_client)
718+
page = 56 # int | page of results (optional)
719+
page_size = 56 # int | number of elements to return on a page (optional)
720+
name = 'name_example' # str | search the name field for a term (optional)
721+
search = 'imagin' # str | search for entries that contain the substring (optional)
722+
description = 'description_example' # str | search description field for a term (optional)
723+
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')
724+
desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
704725

705726
try:
706727
# Your GET endpoint
707-
api_response = api_instance.projects_get()
728+
api_response = api_instance.projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
708729
print("The response of GetApi->projects_get:\n")
709730
pprint(api_response)
710731
except Exception as e:
@@ -713,7 +734,16 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
713734

714735

715736
### Parameters
716-
This endpoint does not need any parameter.
737+
738+
Name | Type | Description | Notes
739+
------------- | ------------- | ------------- | -------------
740+
**page** | **int**| page of results | [optional]
741+
**page_size** | **int**| number of elements to return on a page | [optional]
742+
**name** | **str**| search the name field for a term | [optional]
743+
**search** | **str**| search for entries that contain the substring | [optional]
744+
**description** | **str**| search description field for a term | [optional]
745+
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']
746+
**desc** | **bool**| sort results by descending order (as opposed to ascending order) | [optional]
717747

718748
### Return type
719749

docs/MetaAnalysesApi.md

Lines changed: 16 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, ids=ids)
18+
> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
1919
2020
GET a list of meta-analyses
2121

@@ -44,10 +44,17 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
4444
api_instance = neurosynth_compose_sdk.MetaAnalysesApi(api_client)
4545
nested = True # bool | show nested component instead of id (optional)
4646
ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional)
47+
page = 56 # int | page of results (optional)
48+
page_size = 56 # int | number of elements to return on a page (optional)
49+
name = 'name_example' # str | search the name field for a term (optional)
50+
search = 'imagin' # str | search for entries that contain the substring (optional)
51+
description = 'description_example' # str | search description field for a term (optional)
52+
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')
53+
desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
4754

4855
try:
4956
# GET a list of meta-analyses
50-
api_response = api_instance.meta_analyses_get(nested=nested, ids=ids)
57+
api_response = api_instance.meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
5158
print("The response of MetaAnalysesApi->meta_analyses_get:\n")
5259
pprint(api_response)
5360
except Exception as e:
@@ -61,6 +68,13 @@ Name | Type | Description | Notes
6168
------------- | ------------- | ------------- | -------------
6269
**nested** | **bool**| show nested component instead of id | [optional]
6370
**ids** | [**List[str]**](str.md)| choose the specific ids you wish to get | [optional]
71+
**page** | **int**| page of results | [optional]
72+
**page_size** | **int**| number of elements to return on a page | [optional]
73+
**name** | **str**| search the name field for a term | [optional]
74+
**search** | **str**| search for entries that contain the substring | [optional]
75+
**description** | **str**| search description field for a term | [optional]
76+
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']
77+
**desc** | **bool**| sort results by descending order (as opposed to ascending order) | [optional]
6478

6579
### Return type
6680

docs/ProjectsApi.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212

1313

1414
# **projects_get**
15-
> ProjectList projects_get()
15+
> ProjectList projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
1616
1717
Your GET endpoint
1818

@@ -47,10 +47,17 @@ configuration = neurosynth_compose_sdk.Configuration(
4747
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
4848
# Create an instance of the API class
4949
api_instance = neurosynth_compose_sdk.ProjectsApi(api_client)
50+
page = 56 # int | page of results (optional)
51+
page_size = 56 # int | number of elements to return on a page (optional)
52+
name = 'name_example' # str | search the name field for a term (optional)
53+
search = 'imagin' # str | search for entries that contain the substring (optional)
54+
description = 'description_example' # str | search description field for a term (optional)
55+
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')
56+
desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
5057

5158
try:
5259
# Your GET endpoint
53-
api_response = api_instance.projects_get()
60+
api_response = api_instance.projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc)
5461
print("The response of ProjectsApi->projects_get:\n")
5562
pprint(api_response)
5663
except Exception as e:
@@ -59,7 +66,16 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
5966

6067

6168
### Parameters
62-
This endpoint does not need any parameter.
69+
70+
Name | Type | Description | Notes
71+
------------- | ------------- | ------------- | -------------
72+
**page** | **int**| page of results | [optional]
73+
**page_size** | **int**| number of elements to return on a page | [optional]
74+
**name** | **str**| search the name field for a term | [optional]
75+
**search** | **str**| search for entries that contain the substring | [optional]
76+
**description** | **str**| search description field for a term | [optional]
77+
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']
78+
**desc** | **bool**| sort results by descending order (as opposed to ascending order) | [optional]
6379

6480
### Return type
6581

0 commit comments

Comments
 (0)