Skip to content

Commit 67dfbd5

Browse files
27ff3c6b037c7f6e91539f146258fcdbba72aa44
1 parent aa43d88 commit 67dfbd5

17 files changed

Lines changed: 307 additions & 7 deletions

.openapi-generator/FILES

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ docs/BaseStudiesPost200Response.md
3636
docs/BaseStudiesPostRequest.md
3737
docs/BaseStudy.md
3838
docs/BaseStudyList.md
39+
docs/BaseStudyNeurovaultId.md
3940
docs/BaseStudyReturn.md
4041
docs/BaseStudyVersionsInner.md
4142
docs/Clone.md
@@ -172,6 +173,7 @@ neurostore_sdk/models/base_studies_post200_response.py
172173
neurostore_sdk/models/base_studies_post_request.py
173174
neurostore_sdk/models/base_study.py
174175
neurostore_sdk/models/base_study_list.py
176+
neurostore_sdk/models/base_study_neurovault_id.py
175177
neurostore_sdk/models/base_study_return.py
176178
neurostore_sdk/models/base_study_versions_inner.py
177179
neurostore_sdk/models/clone.py
@@ -251,4 +253,5 @@ setup.cfg
251253
setup.py
252254
test-requirements.txt
253255
test/__init__.py
256+
test/test_base_study_neurovault_id.py
254257
tox.ini

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,7 @@ Class | Method | HTTP request | Description
249249
- [BaseStudiesPostRequest](docs/BaseStudiesPostRequest.md)
250250
- [BaseStudy](docs/BaseStudy.md)
251251
- [BaseStudyList](docs/BaseStudyList.md)
252+
- [BaseStudyNeurovaultId](docs/BaseStudyNeurovaultId.md)
252253
- [BaseStudyReturn](docs/BaseStudyReturn.md)
253254
- [BaseStudyVersionsInner](docs/BaseStudyVersionsInner.md)
254255
- [Clone](docs/Clone.md)

docs/BaseStudiesPost200Response.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
1717
**level** | **str** | | [optional]
1818
**is_oa** | **bool** | | [optional]
1919
**pmcid** | **str** | | [optional]
20+
**neurovault_id** | [**BaseStudyNeurovaultId**](BaseStudyNeurovaultId.md) | | [optional]
2021
**created_at** | **datetime** | time the resource was created on the database | [optional] [readonly]
2122
**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly]
2223
**id** | **str** | short UUID specifying the location of this resource | [optional]

docs/BaseStudiesPostRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
1717
**level** | **str** | | [optional]
1818
**is_oa** | **bool** | | [optional]
1919
**pmcid** | **str** | | [optional]
20+
**neurovault_id** | [**BaseStudyNeurovaultId**](BaseStudyNeurovaultId.md) | | [optional]
2021

2122
## Example
2223

docs/BaseStudy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
1717
**level** | **str** | | [optional]
1818
**is_oa** | **bool** | | [optional]
1919
**pmcid** | **str** | | [optional]
20+
**neurovault_id** | [**BaseStudyNeurovaultId**](BaseStudyNeurovaultId.md) | | [optional]
2021

2122
## Example
2223

docs/BaseStudyNeurovaultId.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# BaseStudyNeurovaultId
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
9+
## Example
10+
11+
```python
12+
from neurostore_sdk.models.base_study_neurovault_id import BaseStudyNeurovaultId
13+
14+
# TODO update the JSON string below
15+
json = "{}"
16+
# create an instance of BaseStudyNeurovaultId from a JSON string
17+
base_study_neurovault_id_instance = BaseStudyNeurovaultId.from_json(json)
18+
# print the JSON string representation of the object
19+
print(BaseStudyNeurovaultId.to_json())
20+
21+
# convert the object into a dict
22+
base_study_neurovault_id_dict = base_study_neurovault_id_instance.to_dict()
23+
# create an instance of BaseStudyNeurovaultId from a dict
24+
base_study_neurovault_id_from_dict = BaseStudyNeurovaultId.from_dict(base_study_neurovault_id_dict)
25+
```
26+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
27+
28+

docs/BaseStudyReturn.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
1717
**level** | **str** | | [optional]
1818
**is_oa** | **bool** | | [optional]
1919
**pmcid** | **str** | | [optional]
20+
**neurovault_id** | [**BaseStudyNeurovaultId**](BaseStudyNeurovaultId.md) | | [optional]
2021
**created_at** | **datetime** | time the resource was created on the database | [optional] [readonly]
2122
**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly]
2223
**id** | **str** | short UUID specifying the location of this resource | [optional]

docs/StoreApi.md

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

11291129
# **base_studies_get**
1130-
> BaseStudyList base_studies_get(nested=nested, year_min=year_min, x=x, y=y, z=z, radius=radius, year_max=year_max, feature_filter=feature_filter, pipeline_config=pipeline_config, feature_display=feature_display, semantic_search=semantic_search, pipeline_config_id=pipeline_config_id, distance_threshold=distance_threshold, overall_cap=overall_cap, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, is_oa=is_oa, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info, paginate=paginate)
1130+
> BaseStudyList base_studies_get(nested=nested, year_min=year_min, x=x, y=y, z=z, radius=radius, year_max=year_max, feature_filter=feature_filter, pipeline_config=pipeline_config, feature_display=feature_display, semantic_search=semantic_search, pipeline_config_id=pipeline_config_id, distance_threshold=distance_threshold, overall_cap=overall_cap, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, is_oa=is_oa, publication=publication, pmid=pmid, doi=doi, neurovault_id=neurovault_id, flat=flat, info=info, paginate=paginate)
11311131
11321132

11331133

@@ -1190,13 +1190,14 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11901190
publication = 'publication_example' # str | search for papers from a particular journal (optional)
11911191
pmid = 'pmid_example' # str | search for particular pmid (optional)
11921192
doi = 'doi_example' # str | search for study with specific doi (optional)
1193+
neurovault_id = 'neurovault_id_example' # str | search for study with specific neurovault id (optional)
11931194
flat = True # bool | do not return any embedded relationships. When set, it is incompatible with nested. (optional)
11941195
info = True # bool | show additional for endpoint-object relationships without being fully nested. Incompatible with nested (optional)
11951196
paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
11961197

11971198
try:
11981199
#
1199-
api_response = api_instance.base_studies_get(nested=nested, year_min=year_min, x=x, y=y, z=z, radius=radius, year_max=year_max, feature_filter=feature_filter, pipeline_config=pipeline_config, feature_display=feature_display, semantic_search=semantic_search, pipeline_config_id=pipeline_config_id, distance_threshold=distance_threshold, overall_cap=overall_cap, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, is_oa=is_oa, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info, paginate=paginate)
1200+
api_response = api_instance.base_studies_get(nested=nested, year_min=year_min, x=x, y=y, z=z, radius=radius, year_max=year_max, feature_filter=feature_filter, pipeline_config=pipeline_config, feature_display=feature_display, semantic_search=semantic_search, pipeline_config_id=pipeline_config_id, distance_threshold=distance_threshold, overall_cap=overall_cap, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, is_oa=is_oa, publication=publication, pmid=pmid, doi=doi, neurovault_id=neurovault_id, flat=flat, info=info, paginate=paginate)
12001201
print("The response of StoreApi->base_studies_get:\n")
12011202
pprint(api_response)
12021203
except Exception as e:
@@ -1239,6 +1240,7 @@ Name | Type | Description | Notes
12391240
**publication** | **str**| search for papers from a particular journal | [optional]
12401241
**pmid** | **str**| search for particular pmid | [optional]
12411242
**doi** | **str**| search for study with specific doi | [optional]
1243+
**neurovault_id** | **str**| search for study with specific neurovault id | [optional]
12421244
**flat** | **bool**| do not return any embedded relationships. When set, it is incompatible with nested. | [optional]
12431245
**info** | **bool**| show additional for endpoint-object relationships without being fully nested. Incompatible with nested | [optional]
12441246
**paginate** | **bool**| whether to paginate results (true) or return all results at once (false) | [optional] [default to True]

docs/StudiesApi.md

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

1717

1818
# **base_studies_get**
19-
> BaseStudyList base_studies_get(nested=nested, year_min=year_min, x=x, y=y, z=z, radius=radius, year_max=year_max, feature_filter=feature_filter, pipeline_config=pipeline_config, feature_display=feature_display, semantic_search=semantic_search, pipeline_config_id=pipeline_config_id, distance_threshold=distance_threshold, overall_cap=overall_cap, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, is_oa=is_oa, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info, paginate=paginate)
19+
> BaseStudyList base_studies_get(nested=nested, year_min=year_min, x=x, y=y, z=z, radius=radius, year_max=year_max, feature_filter=feature_filter, pipeline_config=pipeline_config, feature_display=feature_display, semantic_search=semantic_search, pipeline_config_id=pipeline_config_id, distance_threshold=distance_threshold, overall_cap=overall_cap, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, is_oa=is_oa, publication=publication, pmid=pmid, doi=doi, neurovault_id=neurovault_id, flat=flat, info=info, paginate=paginate)
2020
2121

2222

@@ -79,13 +79,14 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
7979
publication = 'publication_example' # str | search for papers from a particular journal (optional)
8080
pmid = 'pmid_example' # str | search for particular pmid (optional)
8181
doi = 'doi_example' # str | search for study with specific doi (optional)
82+
neurovault_id = 'neurovault_id_example' # str | search for study with specific neurovault id (optional)
8283
flat = True # bool | do not return any embedded relationships. When set, it is incompatible with nested. (optional)
8384
info = True # bool | show additional for endpoint-object relationships without being fully nested. Incompatible with nested (optional)
8485
paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
8586

8687
try:
8788
#
88-
api_response = api_instance.base_studies_get(nested=nested, year_min=year_min, x=x, y=y, z=z, radius=radius, year_max=year_max, feature_filter=feature_filter, pipeline_config=pipeline_config, feature_display=feature_display, semantic_search=semantic_search, pipeline_config_id=pipeline_config_id, distance_threshold=distance_threshold, overall_cap=overall_cap, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, is_oa=is_oa, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info, paginate=paginate)
89+
api_response = api_instance.base_studies_get(nested=nested, year_min=year_min, x=x, y=y, z=z, radius=radius, year_max=year_max, feature_filter=feature_filter, pipeline_config=pipeline_config, feature_display=feature_display, semantic_search=semantic_search, pipeline_config_id=pipeline_config_id, distance_threshold=distance_threshold, overall_cap=overall_cap, feature_flatten=feature_flatten, search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, is_oa=is_oa, publication=publication, pmid=pmid, doi=doi, neurovault_id=neurovault_id, flat=flat, info=info, paginate=paginate)
8990
print("The response of StudiesApi->base_studies_get:\n")
9091
pprint(api_response)
9192
except Exception as e:
@@ -128,6 +129,7 @@ Name | Type | Description | Notes
128129
**publication** | **str**| search for papers from a particular journal | [optional]
129130
**pmid** | **str**| search for particular pmid | [optional]
130131
**doi** | **str**| search for study with specific doi | [optional]
132+
**neurovault_id** | **str**| search for study with specific neurovault id | [optional]
131133
**flat** | **bool**| do not return any embedded relationships. When set, it is incompatible with nested. | [optional]
132134
**info** | **bool**| show additional for endpoint-object relationships without being fully nested. Incompatible with nested | [optional]
133135
**paginate** | **bool**| whether to paginate results (true) or return all results at once (false) | [optional] [default to True]

neurostore_sdk/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@
7373
"BaseStudiesPostRequest",
7474
"BaseStudy",
7575
"BaseStudyList",
76+
"BaseStudyNeurovaultId",
7677
"BaseStudyReturn",
7778
"BaseStudyVersionsInner",
7879
"Clone",
@@ -205,6 +206,7 @@
205206
from neurostore_sdk.models.base_studies_post_request import BaseStudiesPostRequest as BaseStudiesPostRequest
206207
from neurostore_sdk.models.base_study import BaseStudy as BaseStudy
207208
from neurostore_sdk.models.base_study_list import BaseStudyList as BaseStudyList
209+
from neurostore_sdk.models.base_study_neurovault_id import BaseStudyNeurovaultId as BaseStudyNeurovaultId
208210
from neurostore_sdk.models.base_study_return import BaseStudyReturn as BaseStudyReturn
209211
from neurostore_sdk.models.base_study_versions_inner import BaseStudyVersionsInner as BaseStudyVersionsInner
210212
from neurostore_sdk.models.clone import Clone as Clone

0 commit comments

Comments
 (0)