Skip to content

Commit cca7140

Browse files
2e875b95a0e935992a46a7e6c68fe2baecfb7aca
1 parent d5ad375 commit cca7140

17 files changed

+359
-26
lines changed

.openapi-generator/FILES

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ docs/BaseStudiesPostRequest.md
3838
docs/BaseStudy.md
3939
docs/BaseStudyList.md
4040
docs/BaseStudyReturn.md
41-
docs/BaseStudyVersions.md
41+
docs/BaseStudyVersionsInner.md
4242
docs/Clone.md
4343
docs/ConditionBase.md
4444
docs/ConditionList.md
@@ -164,7 +164,7 @@ neurostore_sdk/models/base_studies_post_request.py
164164
neurostore_sdk/models/base_study.py
165165
neurostore_sdk/models/base_study_list.py
166166
neurostore_sdk/models/base_study_return.py
167-
neurostore_sdk/models/base_study_versions.py
167+
neurostore_sdk/models/base_study_versions_inner.py
168168
neurostore_sdk/models/clone.py
169169
neurostore_sdk/models/condition_base.py
170170
neurostore_sdk/models/condition_list.py
@@ -233,4 +233,5 @@ setup.cfg
233233
setup.py
234234
test-requirements.txt
235235
test/__init__.py
236+
test/test_base_study_versions_inner.py
236237
tox.ini

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ Class | Method | HTTP request | Description
241241
- [BaseStudy](docs/BaseStudy.md)
242242
- [BaseStudyList](docs/BaseStudyList.md)
243243
- [BaseStudyReturn](docs/BaseStudyReturn.md)
244-
- [BaseStudyVersions](docs/BaseStudyVersions.md)
244+
- [BaseStudyVersionsInner](docs/BaseStudyVersionsInner.md)
245245
- [Clone](docs/Clone.md)
246246
- [ConditionBase](docs/ConditionBase.md)
247247
- [ConditionList](docs/ConditionList.md)

docs/BaseStudiesPost200Response.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**features** | **object** | | [optional]
99
**metadata** | **object** | | [optional]
10-
**versions** | [**BaseStudyVersions**](BaseStudyVersions.md) | | [optional]
10+
**versions** | [**List[BaseStudyVersionsInner]**](BaseStudyVersionsInner.md) | | [optional]
1111
**name** | **str** | | [optional]
1212
**description** | **str** | | [optional]
1313
**publication** | **str** | | [optional]
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
1616
**authors** | **str** | | [optional]
1717
**year** | **int** | | [optional]
1818
**level** | **str** | | [optional]
19+
**is_oa** | **bool** | | [optional]
1920
**pmcid** | **str** | | [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]

docs/BaseStudiesPostRequest.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**metadata** | **object** | | [optional]
9-
**versions** | [**BaseStudyVersions**](BaseStudyVersions.md) | | [optional]
9+
**versions** | [**List[BaseStudyVersionsInner]**](BaseStudyVersionsInner.md) | | [optional]
1010
**name** | **str** | | [optional]
1111
**description** | **str** | | [optional]
1212
**publication** | **str** | | [optional]
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
1515
**authors** | **str** | | [optional]
1616
**year** | **int** | | [optional]
1717
**level** | **str** | | [optional]
18+
**is_oa** | **bool** | | [optional]
1819
**pmcid** | **str** | | [optional]
1920

2021
## Example

docs/BaseStudy.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**metadata** | **object** | | [optional]
9-
**versions** | [**BaseStudyVersions**](BaseStudyVersions.md) | | [optional]
9+
**versions** | [**List[BaseStudyVersionsInner]**](BaseStudyVersionsInner.md) | | [optional]
1010
**name** | **str** | | [optional]
1111
**description** | **str** | | [optional]
1212
**publication** | **str** | | [optional]
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
1515
**authors** | **str** | | [optional]
1616
**year** | **int** | | [optional]
1717
**level** | **str** | | [optional]
18+
**is_oa** | **bool** | | [optional]
1819
**pmcid** | **str** | | [optional]
1920

2021
## Example

docs/BaseStudyReturn.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**features** | **object** | | [optional]
99
**metadata** | **object** | | [optional]
10-
**versions** | [**BaseStudyVersions**](BaseStudyVersions.md) | | [optional]
10+
**versions** | [**List[BaseStudyVersionsInner]**](BaseStudyVersionsInner.md) | | [optional]
1111
**name** | **str** | | [optional]
1212
**description** | **str** | | [optional]
1313
**publication** | **str** | | [optional]
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
1616
**authors** | **str** | | [optional]
1717
**year** | **int** | | [optional]
1818
**level** | **str** | | [optional]
19+
**is_oa** | **bool** | | [optional]
1920
**pmcid** | **str** | | [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]

docs/BaseStudyVersionsInner.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# BaseStudyVersionsInner
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**doi** | **str** | Digital object identifier of the study. | [optional]
9+
**name** | **str** | Title of the study. | [optional]
10+
**metadata** | **object** | Metadata associated with the study not covered by the other study attributes. | [optional]
11+
**description** | **str** | Long form description of the study, typically the abstract. | [optional]
12+
**publication** | **str** | The journal/place of publication for the study. | [optional]
13+
**pmid** | **str** | If the study was published on PubMed, place the PubMed ID here. | [optional]
14+
**authors** | **str** | The authors on the publication of this study. | [optional]
15+
**year** | **int** | The year this study was published. | [optional]
16+
**created_at** | **datetime** | time the resource was created on the database | [optional] [readonly]
17+
**updated_at** | **str** | when the resource was last modified/updated. | [optional] [readonly]
18+
**id** | **str** | short UUID specifying the location of this resource | [optional]
19+
**public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
20+
**user** | **str** | who owns the resource | [optional] [readonly]
21+
**username** | **str** | human readable username | [optional]
22+
**source** | **str** | | [optional]
23+
**source_id** | **str** | | [optional]
24+
**source_updated_at** | **str** | | [optional] [readonly]
25+
**analyses** | [**StudyReturnRelationshipsAnalyses**](StudyReturnRelationshipsAnalyses.md) | | [optional]
26+
**studysets** | [**List[StudyReturnAllOfStudysets]**](StudyReturnAllOfStudysets.md) | | [optional]
27+
**has_coordinates** | **bool** | | [optional]
28+
**has_images** | **bool** | | [optional]
29+
**base_study** | **str** | | [optional]
30+
**pmcid** | **str** | | [optional]
31+
32+
## Example
33+
34+
```python
35+
from neurostore_sdk.models.base_study_versions_inner import BaseStudyVersionsInner
36+
37+
# TODO update the JSON string below
38+
json = "{}"
39+
# create an instance of BaseStudyVersionsInner from a JSON string
40+
base_study_versions_inner_instance = BaseStudyVersionsInner.from_json(json)
41+
# print the JSON string representation of the object
42+
print(BaseStudyVersionsInner.to_json())
43+
44+
# convert the object into a dict
45+
base_study_versions_inner_dict = base_study_versions_inner_instance.to_dict()
46+
# create an instance of BaseStudyVersionsInner from a dict
47+
base_study_versions_inner_from_dict = BaseStudyVersionsInner.from_dict(base_study_versions_inner_dict)
48+
```
49+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
50+
51+

docs/StoreApi.md

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

11221122
# **base_studies_get**
1123-
> BaseStudyList base_studies_get(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, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info, paginate=paginate)
1123+
> BaseStudyList base_studies_get(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)
11241124
11251125

11261126

@@ -1178,6 +1178,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11781178
authors = 'authors_example' # str | search authors (optional)
11791179
level = group # str | select between studies with group results or meta results (optional) (default to group)
11801180
data_type = 'data_type_example' # str | whether searching for studies that contain coordinates, images, or both (optional)
1181+
is_oa = True # bool | (optional)
11811182
publication = 'publication_example' # str | search for papers from a particular journal (optional)
11821183
pmid = 'pmid_example' # str | search for particular pmid (optional)
11831184
doi = 'doi_example' # str | search for study with specific doi (optional)
@@ -1187,7 +1188,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11871188

11881189
try:
11891190
#
1190-
api_response = api_instance.base_studies_get(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, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info, paginate=paginate)
1191+
api_response = api_instance.base_studies_get(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)
11911192
print("The response of StoreApi->base_studies_get:\n")
11921193
pprint(api_response)
11931194
except Exception as e:
@@ -1225,6 +1226,7 @@ Name | Type | Description | Notes
12251226
**authors** | **str**| search authors | [optional]
12261227
**level** | **str**| select between studies with group results or meta results | [optional] [default to group]
12271228
**data_type** | **str**| whether searching for studies that contain coordinates, images, or both | [optional]
1229+
**is_oa** | **bool**| | [optional]
12281230
**publication** | **str**| search for papers from a particular journal | [optional]
12291231
**pmid** | **str**| search for particular pmid | [optional]
12301232
**doi** | **str**| search for study with specific doi | [optional]

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(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, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info, paginate=paginate)
19+
> BaseStudyList base_studies_get(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)
2020
2121

2222

@@ -74,6 +74,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
7474
authors = 'authors_example' # str | search authors (optional)
7575
level = group # str | select between studies with group results or meta results (optional) (default to group)
7676
data_type = 'data_type_example' # str | whether searching for studies that contain coordinates, images, or both (optional)
77+
is_oa = True # bool | (optional)
7778
publication = 'publication_example' # str | search for papers from a particular journal (optional)
7879
pmid = 'pmid_example' # str | search for particular pmid (optional)
7980
doi = 'doi_example' # str | search for study with specific doi (optional)
@@ -83,7 +84,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
8384

8485
try:
8586
#
86-
api_response = api_instance.base_studies_get(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, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info, paginate=paginate)
87+
api_response = api_instance.base_studies_get(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)
8788
print("The response of StudiesApi->base_studies_get:\n")
8889
pprint(api_response)
8990
except Exception as e:
@@ -121,6 +122,7 @@ Name | Type | Description | Notes
121122
**authors** | **str**| search authors | [optional]
122123
**level** | **str**| select between studies with group results or meta results | [optional] [default to group]
123124
**data_type** | **str**| whether searching for studies that contain coordinates, images, or both | [optional]
125+
**is_oa** | **bool**| | [optional]
124126
**publication** | **str**| search for papers from a particular journal | [optional]
125127
**pmid** | **str**| search for particular pmid | [optional]
126128
**doi** | **str**| search for study with specific doi | [optional]

neurostore_sdk/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
from neurostore_sdk.models.base_study import BaseStudy
7878
from neurostore_sdk.models.base_study_list import BaseStudyList
7979
from neurostore_sdk.models.base_study_return import BaseStudyReturn
80-
from neurostore_sdk.models.base_study_versions import BaseStudyVersions
80+
from neurostore_sdk.models.base_study_versions_inner import BaseStudyVersionsInner
8181
from neurostore_sdk.models.clone import Clone
8282
from neurostore_sdk.models.condition_base import ConditionBase
8383
from neurostore_sdk.models.condition_list import ConditionList

0 commit comments

Comments
 (0)