Skip to content

Commit ee9e8cd

Browse files
5a0afd0704cb9dcd93fee803fc4a8f3deecd8dc1
1 parent 4aa72c5 commit ee9e8cd

File tree

5 files changed

+84
-15
lines changed

5 files changed

+84
-15
lines changed

.openapi-generator/FILES

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -247,11 +247,4 @@ setup.cfg
247247
setup.py
248248
test-requirements.txt
249249
test/__init__.py
250-
test/test_table_common.py
251-
test/test_table_list.py
252-
test/test_table_request.py
253-
test/test_table_request_relationships.py
254-
test/test_table_return.py
255-
test/test_table_return_relationships.py
256-
test/test_tables_api.py
257250
tox.ini

docs/StoreApi.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1125,7 +1125,7 @@ Name | Type | Description | Notes
11251125
[[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)
11261126

11271127
# **base_studies_get**
1128-
> 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)
1128+
> 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)
11291129
11301130

11311131

@@ -1159,6 +1159,7 @@ configuration = neurostore_sdk.Configuration(
11591159
with neurostore_sdk.ApiClient(configuration) as api_client:
11601160
# Create an instance of the API class
11611161
api_instance = neurostore_sdk.StoreApi(api_client)
1162+
nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)
11621163
year_min = 56 # int | Minimum publication year (inclusive) for study search (optional)
11631164
x = 10 # float | X coordinate for spatial query (requires y, z, and radius) (optional)
11641165
y = 20 # float | Y coordinate for spatial query (requires x, z, and radius) (optional)
@@ -1193,7 +1194,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11931194

11941195
try:
11951196
#
1196-
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)
1197+
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)
11971198
print("The response of StoreApi->base_studies_get:\n")
11981199
pprint(api_response)
11991200
except Exception as e:
@@ -1207,6 +1208,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
12071208

12081209
Name | Type | Description | Notes
12091210
------------- | ------------- | ------------- | -------------
1211+
**nested** | **bool**| whether to show the URI to a resource (false) or to embed the object in the response (true) | [optional]
12101212
**year_min** | **int**| Minimum publication year (inclusive) for study search | [optional]
12111213
**x** | **float**| X coordinate for spatial query (requires y, z, and radius) | [optional]
12121214
**y** | **float**| Y coordinate for spatial query (requires x, z, and radius) | [optional]
@@ -1261,7 +1263,7 @@ Name | Type | Description | Notes
12611263
[[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)
12621264

12631265
# **base_studies_id_get**
1264-
> BaseStudyReturn base_studies_id_get(id, flat=flat, info=info)
1266+
> BaseStudyReturn base_studies_id_get(id, flat=flat, info=info, nested=nested)
12651267
12661268
Your GET endpoint
12671269

@@ -1288,10 +1290,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
12881290
id = 'id_example' # str |
12891291
flat = True # bool | do not return any embedded relationships. When set, it is incompatible with nested. (optional)
12901292
info = True # bool | show additional for endpoint-object relationships without being fully nested. Incompatible with nested (optional)
1293+
nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)
12911294

12921295
try:
12931296
# Your GET endpoint
1294-
api_response = api_instance.base_studies_id_get(id, flat=flat, info=info)
1297+
api_response = api_instance.base_studies_id_get(id, flat=flat, info=info, nested=nested)
12951298
print("The response of StoreApi->base_studies_id_get:\n")
12961299
pprint(api_response)
12971300
except Exception as e:
@@ -1308,6 +1311,7 @@ Name | Type | Description | Notes
13081311
**id** | **str**| |
13091312
**flat** | **bool**| do not return any embedded relationships. When set, it is incompatible with nested. | [optional]
13101313
**info** | **bool**| show additional for endpoint-object relationships without being fully nested. Incompatible with nested | [optional]
1314+
**nested** | **bool**| whether to show the URI to a resource (false) or to embed the object in the response (true) | [optional]
13111315

13121316
### Return type
13131317

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(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, flat=flat, info=info, paginate=paginate)
2020
2121

2222

@@ -50,6 +50,7 @@ configuration = neurostore_sdk.Configuration(
5050
with neurostore_sdk.ApiClient(configuration) as api_client:
5151
# Create an instance of the API class
5252
api_instance = neurostore_sdk.StudiesApi(api_client)
53+
nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)
5354
year_min = 56 # int | Minimum publication year (inclusive) for study search (optional)
5455
x = 10 # float | X coordinate for spatial query (requires y, z, and radius) (optional)
5556
y = 20 # float | Y coordinate for spatial query (requires x, z, and radius) (optional)
@@ -84,7 +85,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
8485

8586
try:
8687
#
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)
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)
8889
print("The response of StudiesApi->base_studies_get:\n")
8990
pprint(api_response)
9091
except Exception as e:
@@ -98,6 +99,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
9899

99100
Name | Type | Description | Notes
100101
------------- | ------------- | ------------- | -------------
102+
**nested** | **bool**| whether to show the URI to a resource (false) or to embed the object in the response (true) | [optional]
101103
**year_min** | **int**| Minimum publication year (inclusive) for study search | [optional]
102104
**x** | **float**| X coordinate for spatial query (requires y, z, and radius) | [optional]
103105
**y** | **float**| Y coordinate for spatial query (requires x, z, and radius) | [optional]
@@ -152,7 +154,7 @@ Name | Type | Description | Notes
152154
[[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)
153155

154156
# **base_studies_id_get**
155-
> BaseStudyReturn base_studies_id_get(id, flat=flat, info=info)
157+
> BaseStudyReturn base_studies_id_get(id, flat=flat, info=info, nested=nested)
156158
157159
Your GET endpoint
158160

@@ -179,10 +181,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
179181
id = 'id_example' # str |
180182
flat = True # bool | do not return any embedded relationships. When set, it is incompatible with nested. (optional)
181183
info = True # bool | show additional for endpoint-object relationships without being fully nested. Incompatible with nested (optional)
184+
nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)
182185

183186
try:
184187
# Your GET endpoint
185-
api_response = api_instance.base_studies_id_get(id, flat=flat, info=info)
188+
api_response = api_instance.base_studies_id_get(id, flat=flat, info=info, nested=nested)
186189
print("The response of StudiesApi->base_studies_id_get:\n")
187190
pprint(api_response)
188191
except Exception as e:
@@ -199,6 +202,7 @@ Name | Type | Description | Notes
199202
**id** | **str**| |
200203
**flat** | **bool**| do not return any embedded relationships. When set, it is incompatible with nested. | [optional]
201204
**info** | **bool**| show additional for endpoint-object relationships without being fully nested. Incompatible with nested | [optional]
205+
**nested** | **bool**| whether to show the URI to a resource (false) or to embed the object in the response (true) | [optional]
202206

203207
### Return type
204208

0 commit comments

Comments
 (0)