Skip to content

Commit

Permalink
07eedcd48239f15365e73295cb63d1f3e510c95f
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Feb 29, 2024
1 parent 243ba8a commit f6120f8
Show file tree
Hide file tree
Showing 8 changed files with 418 additions and 52 deletions.
36 changes: 31 additions & 5 deletions docs/ComposeApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ Name | Type | Description | Notes
[[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)

# **meta_analyses_get**
> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids)
> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort)
GET a list of meta-analyses

Expand Down Expand Up @@ -363,10 +363,16 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
api_instance = neurosynth_compose_sdk.ComposeApi(api_client)
nested = True # bool | show nested component instead of id (optional)
ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional)
page = 56 # int | page of results (optional)
page_size = 56 # int | number of elements to return on a page (optional)
name = 'name_example' # str | search the name field for a term (optional)
search = 'imagin' # str | search for entries that contain the substring (optional)
description = 'description_example' # str | search description field for a term (optional)
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')

try:
# GET a list of meta-analyses
api_response = api_instance.meta_analyses_get(nested=nested, ids=ids)
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)
print("The response of ComposeApi->meta_analyses_get:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -380,6 +386,12 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**nested** | **bool**| show nested component instead of id | [optional]
**ids** | [**List[str]**](str.md)| choose the specific ids you wish to get | [optional]
**page** | **int**| page of results | [optional]
**page_size** | **int**| number of elements to return on a page | [optional]
**name** | **str**| search the name field for a term | [optional]
**search** | **str**| search for entries that contain the substring | [optional]
**description** | **str**| search description field for a term | [optional]
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']

### Return type

Expand Down Expand Up @@ -1486,7 +1498,7 @@ Name | Type | Description | Notes
[[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)

# **projects_get**
> ProjectList projects_get()
> ProjectList projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort)
Your GET endpoint

Expand Down Expand Up @@ -1521,10 +1533,16 @@ 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.ComposeApi(api_client)
page = 56 # int | page of results (optional)
page_size = 56 # int | number of elements to return on a page (optional)
name = 'name_example' # str | search the name field for a term (optional)
search = 'imagin' # str | search for entries that contain the substring (optional)
description = 'description_example' # str | search description field for a term (optional)
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')

try:
# Your GET endpoint
api_response = api_instance.projects_get()
api_response = api_instance.projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort)
print("The response of ComposeApi->projects_get:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -1533,7 +1551,15 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:


### Parameters
This endpoint does not need any parameter.

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page** | **int**| page of results | [optional]
**page_size** | **int**| number of elements to return on a page | [optional]
**name** | **str**| search the name field for a term | [optional]
**search** | **str**| search for entries that contain the substring | [optional]
**description** | **str**| search description field for a term | [optional]
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']

### Return type

Expand Down
36 changes: 31 additions & 5 deletions docs/GetApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,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)

# **meta_analyses_get**
> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids)
> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort)
GET a list of meta-analyses

Expand Down Expand Up @@ -183,10 +183,16 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
api_instance = neurosynth_compose_sdk.GetApi(api_client)
nested = True # bool | show nested component instead of id (optional)
ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional)
page = 56 # int | page of results (optional)
page_size = 56 # int | number of elements to return on a page (optional)
name = 'name_example' # str | search the name field for a term (optional)
search = 'imagin' # str | search for entries that contain the substring (optional)
description = 'description_example' # str | search description field for a term (optional)
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')

try:
# GET a list of meta-analyses
api_response = api_instance.meta_analyses_get(nested=nested, ids=ids)
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)
print("The response of GetApi->meta_analyses_get:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -200,6 +206,12 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**nested** | **bool**| show nested component instead of id | [optional]
**ids** | [**List[str]**](str.md)| choose the specific ids you wish to get | [optional]
**page** | **int**| page of results | [optional]
**page_size** | **int**| number of elements to return on a page | [optional]
**name** | **str**| search the name field for a term | [optional]
**search** | **str**| search for entries that contain the substring | [optional]
**description** | **str**| search description field for a term | [optional]
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']

### Return type

Expand Down Expand Up @@ -666,7 +678,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)

# **projects_get**
> ProjectList projects_get()
> ProjectList projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort)
Your GET endpoint

Expand Down Expand Up @@ -701,10 +713,16 @@ 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.GetApi(api_client)
page = 56 # int | page of results (optional)
page_size = 56 # int | number of elements to return on a page (optional)
name = 'name_example' # str | search the name field for a term (optional)
search = 'imagin' # str | search for entries that contain the substring (optional)
description = 'description_example' # str | search description field for a term (optional)
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')

try:
# Your GET endpoint
api_response = api_instance.projects_get()
api_response = api_instance.projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort)
print("The response of GetApi->projects_get:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -713,7 +731,15 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:


### Parameters
This endpoint does not need any parameter.

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page** | **int**| page of results | [optional]
**page_size** | **int**| number of elements to return on a page | [optional]
**name** | **str**| search the name field for a term | [optional]
**search** | **str**| search for entries that contain the substring | [optional]
**description** | **str**| search description field for a term | [optional]
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']

### Return type

Expand Down
16 changes: 14 additions & 2 deletions docs/MetaAnalysesApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Method | HTTP request | Description


# **meta_analyses_get**
> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids)
> MetaAnalysisList meta_analyses_get(nested=nested, ids=ids, page=page, page_size=page_size, name=name, search=search, description=description, sort=sort)
GET a list of meta-analyses

Expand Down Expand Up @@ -44,10 +44,16 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
api_instance = neurosynth_compose_sdk.MetaAnalysesApi(api_client)
nested = True # bool | show nested component instead of id (optional)
ids = ['ids_example'] # List[str] | choose the specific ids you wish to get (optional)
page = 56 # int | page of results (optional)
page_size = 56 # int | number of elements to return on a page (optional)
name = 'name_example' # str | search the name field for a term (optional)
search = 'imagin' # str | search for entries that contain the substring (optional)
description = 'description_example' # str | search description field for a term (optional)
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')

try:
# GET a list of meta-analyses
api_response = api_instance.meta_analyses_get(nested=nested, ids=ids)
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)
print("The response of MetaAnalysesApi->meta_analyses_get:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -61,6 +67,12 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**nested** | **bool**| show nested component instead of id | [optional]
**ids** | [**List[str]**](str.md)| choose the specific ids you wish to get | [optional]
**page** | **int**| page of results | [optional]
**page_size** | **int**| number of elements to return on a page | [optional]
**name** | **str**| search the name field for a term | [optional]
**search** | **str**| search for entries that contain the substring | [optional]
**description** | **str**| search description field for a term | [optional]
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']

### Return type

Expand Down
20 changes: 17 additions & 3 deletions docs/ProjectsApi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Method | HTTP request | Description


# **projects_get**
> ProjectList projects_get()
> ProjectList projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort)
Your GET endpoint

Expand Down Expand Up @@ -47,10 +47,16 @@ 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.ProjectsApi(api_client)
page = 56 # int | page of results (optional)
page_size = 56 # int | number of elements to return on a page (optional)
name = 'name_example' # str | search the name field for a term (optional)
search = 'imagin' # str | search for entries that contain the substring (optional)
description = 'description_example' # str | search description field for a term (optional)
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')

try:
# Your GET endpoint
api_response = api_instance.projects_get()
api_response = api_instance.projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort)
print("The response of ProjectsApi->projects_get:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -59,7 +65,15 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:


### Parameters
This endpoint does not need any parameter.

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**page** | **int**| page of results | [optional]
**page_size** | **int**| number of elements to return on a page | [optional]
**name** | **str**| search the name field for a term | [optional]
**search** | **str**| search for entries that contain the substring | [optional]
**description** | **str**| search description field for a term | [optional]
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']

### Return type

Expand Down
Loading

0 comments on commit f6120f8

Please sign in to comment.