Skip to content

Commit

Permalink
026974e1ce33f327e2428d05bcb9f8a7f7d4de05
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Feb 17, 2024
1 parent 9cd168c commit 2877117
Show file tree
Hide file tree
Showing 8 changed files with 72 additions and 32 deletions.
6 changes: 4 additions & 2 deletions docs/DefaultApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Method | HTTP request | Description


# **base_studies_get**
> BaseStudyList base_studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
> BaseStudyList base_studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info, return_all=return_all)


Expand Down Expand Up @@ -61,10 +61,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
doi = 'doi_example' # str | search for study with specific doi (optional)
flat = True # bool | do not return any embedded relationships. When set, it is incompatible with nested. (optional)
info = True # bool | show additional for endpoint-object relationships without being fully nested. Incompatible with nested (optional)
return_all = True # bool | return all results at an endpoint (WARNING: could take a while) (optional)

try:
#
api_response = api_instance.base_studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
api_response = api_instance.base_studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info, return_all=return_all)
print("The response of DefaultApi->base_studies_get:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -91,6 +92,7 @@ Name | Type | Description | Notes
**doi** | **str**| search for study with specific doi | [optional]
**flat** | **bool**| do not return any embedded relationships. When set, it is incompatible with nested. | [optional]
**info** | **bool**| show additional for endpoint-object relationships without being fully nested. Incompatible with nested | [optional]
**return_all** | **bool**| return all results at an endpoint (WARNING: could take a while) | [optional]

### Return type

Expand Down
6 changes: 4 additions & 2 deletions docs/StoreApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -1900,7 +1900,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)

# **studies_get**
> StudyList studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat)
> StudyList studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat, return_all=return_all)
GET a list of studies

Expand Down Expand Up @@ -1956,10 +1956,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
pmid = 'pmid_example' # str | search for particular pmid (optional)
doi = 'doi_example' # str | search for study with specific doi (optional)
flat = True # bool | do not return any embedded relationships. When set, it is incompatible with nested. (optional)
return_all = True # bool | return all results at an endpoint (WARNING: could take a while) (optional)

try:
# GET a list of studies
api_response = api_instance.studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat)
api_response = api_instance.studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat, return_all=return_all)
print("The response of StoreApi->studies_get:\n")
pprint(api_response)
except Exception as e:
Expand Down Expand Up @@ -1990,6 +1991,7 @@ Name | Type | Description | Notes
**pmid** | **str**| search for particular pmid | [optional]
**doi** | **str**| search for study with specific doi | [optional]
**flat** | **bool**| do not return any embedded relationships. When set, it is incompatible with nested. | [optional]
**return_all** | **bool**| return all results at an endpoint (WARNING: could take a while) | [optional]

### Return type

Expand Down
6 changes: 4 additions & 2 deletions docs/StudiesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Method | HTTP request | Description


# **studies_get**
> StudyList studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat)
> StudyList studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat, return_all=return_all)
GET a list of studies

Expand Down Expand Up @@ -68,10 +68,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
pmid = 'pmid_example' # str | search for particular pmid (optional)
doi = 'doi_example' # str | search for study with specific doi (optional)
flat = True # bool | do not return any embedded relationships. When set, it is incompatible with nested. (optional)
return_all = True # bool | return all results at an endpoint (WARNING: could take a while) (optional)

try:
# GET a list of studies
api_response = api_instance.studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat)
api_response = api_instance.studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat, return_all=return_all)
print("The response of StudiesApi->studies_get:\n")
pprint(api_response)
except Exception as e:
Expand Down Expand Up @@ -102,6 +103,7 @@ Name | Type | Description | Notes
**pmid** | **str**| search for particular pmid | [optional]
**doi** | **str**| search for study with specific doi | [optional]
**flat** | **bool**| do not return any embedded relationships. When set, it is incompatible with nested. | [optional]
**return_all** | **bool**| return all results at an endpoint (WARNING: could take a while) | [optional]

### Return type

Expand Down
6 changes: 4 additions & 2 deletions docs/StudysetsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Method | HTTP request | Description


# **studysets_get**
> StudysetList studysets_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id)
> StudysetList studysets_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, return_all=return_all)
GET a list of studysets

Expand Down Expand Up @@ -62,10 +62,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
source = 'neurostore' # str | the source of the resource you would like to filter/copy from (optional) (default to 'neurostore')
authors = 'authors_example' # str | search authors (optional)
user_id = 'user_id_example' # str | user id you want to filter by (optional)
return_all = True # bool | return all results at an endpoint (WARNING: could take a while) (optional)

try:
# GET a list of studysets
api_response = api_instance.studysets_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id)
api_response = api_instance.studysets_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, return_all=return_all)
print("The response of StudysetsApi->studysets_get:\n")
pprint(api_response)
except Exception as e:
Expand All @@ -90,6 +91,7 @@ Name | Type | Description | Notes
**source** | **str**| the source of the resource you would like to filter/copy from | [optional] [default to 'neurostore']
**authors** | **str**| search authors | [optional]
**user_id** | **str**| user id you want to filter by | [optional]
**return_all** | **bool**| return all results at an endpoint (WARNING: could take a while) | [optional]

### Return type

Expand Down
Loading

0 comments on commit 2877117

Please sign in to comment.