Skip to content

Commit e80d92c

Browse files
88a86b1475bd907841e4b026b486b5977821abd9
1 parent c639412 commit e80d92c

12 files changed

Lines changed: 135 additions & 12 deletions

docs/AnalysisReturn.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ Name | Type | Description | Notes
2222
**entities** | [**List[Entity]**](Entity.md) | | [optional]
2323
**order** | **int** | | [optional]
2424
**metadata** | **object** | | [optional]
25+
**has_coordinates** | **bool** | | [optional]
26+
**has_images** | **bool** | | [optional]
27+
**has_z_maps** | **bool** | | [optional]
28+
**has_t_maps** | **bool** | | [optional]
29+
**has_beta_and_variance_maps** | **bool** | | [optional]
2530

2631
## Example
2732

docs/BaseStudiesPost200Response.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ Name | Type | Description | Notes
2323
**public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
2424
**user** | **str** | who owns the resource | [optional] [readonly]
2525
**username** | **str** | human readable username | [optional]
26+
**has_coordinates** | **bool** | | [optional]
27+
**has_images** | **bool** | | [optional]
28+
**has_z_maps** | **bool** | | [optional]
29+
**has_t_maps** | **bool** | | [optional]
30+
**has_beta_and_variance_maps** | **bool** | | [optional]
2631
**features** | **object** | | [optional]
2732

2833
## Example

docs/BaseStudyReturn.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ Name | Type | Description | Notes
2323
**public** | **bool** | whether the resource is listed in public searches or not | [optional] [default to True]
2424
**user** | **str** | who owns the resource | [optional] [readonly]
2525
**username** | **str** | human readable username | [optional]
26+
**has_coordinates** | **bool** | | [optional]
27+
**has_images** | **bool** | | [optional]
28+
**has_z_maps** | **bool** | | [optional]
29+
**has_t_maps** | **bool** | | [optional]
30+
**has_beta_and_variance_maps** | **bool** | | [optional]
2631
**features** | **object** | | [optional]
2732

2833
## Example

docs/BaseStudyVersionsInner.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ Name | Type | Description | Notes
2727
**studysets** | [**List[StudyReturnAllOfStudysets]**](StudyReturnAllOfStudysets.md) | | [optional]
2828
**has_coordinates** | **bool** | | [optional]
2929
**has_images** | **bool** | | [optional]
30+
**has_z_maps** | **bool** | | [optional]
31+
**has_t_maps** | **bool** | | [optional]
32+
**has_beta_and_variance_maps** | **bool** | | [optional]
3033
**base_study** | **str** | | [optional]
3134
**pmcid** | **str** | | [optional]
3235

docs/StoreApi.md

Lines changed: 8 additions & 4 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, neurovault_id=neurovault_id, 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, map_type=map_type, is_oa=is_oa, publication=publication, pmid=pmid, doi=doi, neurovault_id=neurovault_id, flat=flat, info=info, paginate=paginate)
11311131
11321132

11331133

@@ -1186,6 +1186,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11861186
authors = 'authors_example' # str | search authors (optional)
11871187
level = group # str | select between studies with group results or meta results (optional) (default to group)
11881188
data_type = 'data_type_example' # str | whether searching for studies that contain coordinates, images, or both (optional)
1189+
map_type = 'map_type_example' # str | filter by stored map-type flags (optional)
11891190
is_oa = True # bool | (optional)
11901191
publication = 'publication_example' # str | search for papers from a particular journal (optional)
11911192
pmid = 'pmid_example' # str | search for particular pmid (optional)
@@ -1197,7 +1198,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11971198

11981199
try:
11991200
#
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)
1201+
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, map_type=map_type, is_oa=is_oa, publication=publication, pmid=pmid, doi=doi, neurovault_id=neurovault_id, flat=flat, info=info, paginate=paginate)
12011202
print("The response of StoreApi->base_studies_get:\n")
12021203
pprint(api_response)
12031204
except Exception as e:
@@ -1236,6 +1237,7 @@ Name | Type | Description | Notes
12361237
**authors** | **str**| search authors | [optional]
12371238
**level** | **str**| select between studies with group results or meta results | [optional] [default to group]
12381239
**data_type** | **str**| whether searching for studies that contain coordinates, images, or both | [optional]
1240+
**map_type** | **str**| filter by stored map-type flags | [optional]
12391241
**is_oa** | **bool**| | [optional]
12401242
**publication** | **str**| search for papers from a particular journal | [optional]
12411243
**pmid** | **str**| search for particular pmid | [optional]
@@ -2646,7 +2648,7 @@ Name | Type | Description | Notes
26462648
[[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)
26472649

26482650
# **studies_get**
2649-
> StudyList studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, 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)
2651+
> StudyList studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, map_type=map_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat)
26502652
26512653
GET a list of studies
26522654

@@ -2697,6 +2699,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
26972699
authors = 'authors_example' # str | search authors (optional)
26982700
user_id = 'user_id_example' # str | user id you want to filter by (optional)
26992701
data_type = 'data_type_example' # str | whether searching for studies that contain coordinates, images, or both (optional)
2702+
map_type = 'map_type_example' # str | filter by stored map-type flags (optional)
27002703
studyset_owner = 'studyset_owner_example' # str | for all studies filter which studysets are listed based on who owns the studyset (optional)
27012704
level = group # str | select between studies with group results or meta results (optional) (default to group)
27022705
pmid = 'pmid_example' # str | search for particular pmid (optional)
@@ -2705,7 +2708,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
27052708

27062709
try:
27072710
# GET a list of studies
2708-
api_response = api_instance.studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, 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)
2711+
api_response = api_instance.studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, map_type=map_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat)
27092712
print("The response of StoreApi->studies_get:\n")
27102713
pprint(api_response)
27112714
except Exception as e:
@@ -2734,6 +2737,7 @@ Name | Type | Description | Notes
27342737
**authors** | **str**| search authors | [optional]
27352738
**user_id** | **str**| user id you want to filter by | [optional]
27362739
**data_type** | **str**| whether searching for studies that contain coordinates, images, or both | [optional]
2740+
**map_type** | **str**| filter by stored map-type flags | [optional]
27372741
**studyset_owner** | **str**| for all studies filter which studysets are listed based on who owns the studyset | [optional]
27382742
**level** | **str**| select between studies with group results or meta results | [optional] [default to group]
27392743
**pmid** | **str**| search for particular pmid | [optional]

docs/StudiesApi.md

Lines changed: 8 additions & 4 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, neurovault_id=neurovault_id, 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, map_type=map_type, is_oa=is_oa, publication=publication, pmid=pmid, doi=doi, neurovault_id=neurovault_id, flat=flat, info=info, paginate=paginate)
2020
2121

2222

@@ -75,6 +75,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
7575
authors = 'authors_example' # str | search authors (optional)
7676
level = group # str | select between studies with group results or meta results (optional) (default to group)
7777
data_type = 'data_type_example' # str | whether searching for studies that contain coordinates, images, or both (optional)
78+
map_type = 'map_type_example' # str | filter by stored map-type flags (optional)
7879
is_oa = True # bool | (optional)
7980
publication = 'publication_example' # str | search for papers from a particular journal (optional)
8081
pmid = 'pmid_example' # str | search for particular pmid (optional)
@@ -86,7 +87,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
8687

8788
try:
8889
#
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)
90+
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, map_type=map_type, is_oa=is_oa, publication=publication, pmid=pmid, doi=doi, neurovault_id=neurovault_id, flat=flat, info=info, paginate=paginate)
9091
print("The response of StudiesApi->base_studies_get:\n")
9192
pprint(api_response)
9293
except Exception as e:
@@ -125,6 +126,7 @@ Name | Type | Description | Notes
125126
**authors** | **str**| search authors | [optional]
126127
**level** | **str**| select between studies with group results or meta results | [optional] [default to group]
127128
**data_type** | **str**| whether searching for studies that contain coordinates, images, or both | [optional]
129+
**map_type** | **str**| filter by stored map-type flags | [optional]
128130
**is_oa** | **bool**| | [optional]
129131
**publication** | **str**| search for papers from a particular journal | [optional]
130132
**pmid** | **str**| search for particular pmid | [optional]
@@ -384,7 +386,7 @@ Name | Type | Description | Notes
384386
[[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)
385387

386388
# **studies_get**
387-
> StudyList studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, 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)
389+
> StudyList studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, map_type=map_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat)
388390
389391
GET a list of studies
390392

@@ -435,6 +437,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
435437
authors = 'authors_example' # str | search authors (optional)
436438
user_id = 'user_id_example' # str | user id you want to filter by (optional)
437439
data_type = 'data_type_example' # str | whether searching for studies that contain coordinates, images, or both (optional)
440+
map_type = 'map_type_example' # str | filter by stored map-type flags (optional)
438441
studyset_owner = 'studyset_owner_example' # str | for all studies filter which studysets are listed based on who owns the studyset (optional)
439442
level = group # str | select between studies with group results or meta results (optional) (default to group)
440443
pmid = 'pmid_example' # str | search for particular pmid (optional)
@@ -443,7 +446,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
443446

444447
try:
445448
# GET a list of studies
446-
api_response = api_instance.studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, 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)
449+
api_response = api_instance.studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, map_type=map_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat)
447450
print("The response of StudiesApi->studies_get:\n")
448451
pprint(api_response)
449452
except Exception as e:
@@ -472,6 +475,7 @@ Name | Type | Description | Notes
472475
**authors** | **str**| search authors | [optional]
473476
**user_id** | **str**| user id you want to filter by | [optional]
474477
**data_type** | **str**| whether searching for studies that contain coordinates, images, or both | [optional]
478+
**map_type** | **str**| filter by stored map-type flags | [optional]
475479
**studyset_owner** | **str**| for all studies filter which studysets are listed based on who owns the studyset | [optional]
476480
**level** | **str**| select between studies with group results or meta results | [optional] [default to group]
477481
**pmid** | **str**| search for particular pmid | [optional]

docs/StudyReturn.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ Name | Type | Description | Notes
2727
**studysets** | [**List[StudyReturnAllOfStudysets]**](StudyReturnAllOfStudysets.md) | | [optional]
2828
**has_coordinates** | **bool** | | [optional]
2929
**has_images** | **bool** | | [optional]
30+
**has_z_maps** | **bool** | | [optional]
31+
**has_t_maps** | **bool** | | [optional]
32+
**has_beta_and_variance_maps** | **bool** | | [optional]
3033
**base_study** | **str** | | [optional]
3134
**pmcid** | **str** | | [optional]
3235

0 commit comments

Comments
 (0)