Skip to content

Commit 78a99b4

Browse files
a6a541f44f38858234a23bc73dc6173ed44044b3
1 parent 1a714a0 commit 78a99b4

File tree

4 files changed

+42
-4
lines changed

4 files changed

+42
-4
lines changed

Diff for: docs/StoreApi.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1112,7 +1112,7 @@ Name | Type | Description | Notes
11121112
[[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)
11131113

11141114
# **base_studies_get**
1115-
> BaseStudyList base_studies_get(feature_filter=feature_filter, feature_display=feature_display, 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)
1115+
> BaseStudyList base_studies_get(feature_filter=feature_filter, feature_display=feature_display, 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)
11161116
11171117

11181118

@@ -1148,6 +1148,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11481148
api_instance = neurostore_sdk.StoreApi(api_client)
11491149
feature_filter = 'feature_filter_example' # str | Filter studies by features (optional)
11501150
feature_display = 'feature_display_example' # str | display features from pipelines (optional)
1151+
feature_flatten = True # bool | (optional)
11511152
search = 'imagin' # str | search for entries that contain the substring (optional)
11521153
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')
11531154
page = 56 # int | page of results (optional)
@@ -1166,7 +1167,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
11661167

11671168
try:
11681169
#
1169-
api_response = api_instance.base_studies_get(feature_filter=feature_filter, feature_display=feature_display, 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)
1170+
api_response = api_instance.base_studies_get(feature_filter=feature_filter, feature_display=feature_display, 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)
11701171
print("The response of StoreApi->base_studies_get:\n")
11711172
pprint(api_response)
11721173
except Exception as e:
@@ -1182,6 +1183,7 @@ Name | Type | Description | Notes
11821183
------------- | ------------- | ------------- | -------------
11831184
**feature_filter** | **str**| Filter studies by features | [optional]
11841185
**feature_display** | **str**| display features from pipelines | [optional]
1186+
**feature_flatten** | **bool**| | [optional]
11851187
**search** | **str**| search for entries that contain the substring | [optional]
11861188
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']
11871189
**page** | **int**| page of results | [optional]

Diff for: docs/StudiesApi.md

+4-2
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(feature_filter=feature_filter, feature_display=feature_display, 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)
19+
> BaseStudyList base_studies_get(feature_filter=feature_filter, feature_display=feature_display, 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)
2020
2121

2222

@@ -52,6 +52,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
5252
api_instance = neurostore_sdk.StudiesApi(api_client)
5353
feature_filter = 'feature_filter_example' # str | Filter studies by features (optional)
5454
feature_display = 'feature_display_example' # str | display features from pipelines (optional)
55+
feature_flatten = True # bool | (optional)
5556
search = 'imagin' # str | search for entries that contain the substring (optional)
5657
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')
5758
page = 56 # int | page of results (optional)
@@ -70,7 +71,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
7071

7172
try:
7273
#
73-
api_response = api_instance.base_studies_get(feature_filter=feature_filter, feature_display=feature_display, 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)
74+
api_response = api_instance.base_studies_get(feature_filter=feature_filter, feature_display=feature_display, 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)
7475
print("The response of StudiesApi->base_studies_get:\n")
7576
pprint(api_response)
7677
except Exception as e:
@@ -86,6 +87,7 @@ Name | Type | Description | Notes
8687
------------- | ------------- | ------------- | -------------
8788
**feature_filter** | **str**| Filter studies by features | [optional]
8889
**feature_display** | **str**| display features from pipelines | [optional]
90+
**feature_flatten** | **bool**| | [optional]
8991
**search** | **str**| search for entries that contain the substring | [optional]
9092
**sort** | **str**| Parameter to sort results on | [optional] [default to 'created_at']
9193
**page** | **int**| page of results | [optional]

Diff for: neurostore_sdk/api/store_api.py

+17
Original file line numberDiff line numberDiff line change
@@ -4007,6 +4007,7 @@ def base_studies_get(
40074007
self,
40084008
feature_filter: Annotated[Optional[StrictStr], Field(description="Filter studies by features")] = None,
40094009
feature_display: Annotated[Optional[StrictStr], Field(description="display features from pipelines")] = None,
4010+
feature_flatten: Optional[StrictBool] = None,
40104011
search: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="search for entries that contain the substring")] = None,
40114012
sort: Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None,
40124013
page: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="page of results")] = None,
@@ -4042,6 +4043,8 @@ def base_studies_get(
40424043
:type feature_filter: str
40434044
:param feature_display: display features from pipelines
40444045
:type feature_display: str
4046+
:param feature_flatten:
4047+
:type feature_flatten: bool
40454048
:param search: search for entries that contain the substring
40464049
:type search: str
40474050
:param sort: Parameter to sort results on
@@ -4097,6 +4100,7 @@ def base_studies_get(
40974100
_param = self._base_studies_get_serialize(
40984101
feature_filter=feature_filter,
40994102
feature_display=feature_display,
4103+
feature_flatten=feature_flatten,
41004104
search=search,
41014105
sort=sort,
41024106
page=page,
@@ -4137,6 +4141,7 @@ def base_studies_get_with_http_info(
41374141
self,
41384142
feature_filter: Annotated[Optional[StrictStr], Field(description="Filter studies by features")] = None,
41394143
feature_display: Annotated[Optional[StrictStr], Field(description="display features from pipelines")] = None,
4144+
feature_flatten: Optional[StrictBool] = None,
41404145
search: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="search for entries that contain the substring")] = None,
41414146
sort: Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None,
41424147
page: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="page of results")] = None,
@@ -4172,6 +4177,8 @@ def base_studies_get_with_http_info(
41724177
:type feature_filter: str
41734178
:param feature_display: display features from pipelines
41744179
:type feature_display: str
4180+
:param feature_flatten:
4181+
:type feature_flatten: bool
41754182
:param search: search for entries that contain the substring
41764183
:type search: str
41774184
:param sort: Parameter to sort results on
@@ -4227,6 +4234,7 @@ def base_studies_get_with_http_info(
42274234
_param = self._base_studies_get_serialize(
42284235
feature_filter=feature_filter,
42294236
feature_display=feature_display,
4237+
feature_flatten=feature_flatten,
42304238
search=search,
42314239
sort=sort,
42324240
page=page,
@@ -4267,6 +4275,7 @@ def base_studies_get_without_preload_content(
42674275
self,
42684276
feature_filter: Annotated[Optional[StrictStr], Field(description="Filter studies by features")] = None,
42694277
feature_display: Annotated[Optional[StrictStr], Field(description="display features from pipelines")] = None,
4278+
feature_flatten: Optional[StrictBool] = None,
42704279
search: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="search for entries that contain the substring")] = None,
42714280
sort: Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None,
42724281
page: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="page of results")] = None,
@@ -4302,6 +4311,8 @@ def base_studies_get_without_preload_content(
43024311
:type feature_filter: str
43034312
:param feature_display: display features from pipelines
43044313
:type feature_display: str
4314+
:param feature_flatten:
4315+
:type feature_flatten: bool
43054316
:param search: search for entries that contain the substring
43064317
:type search: str
43074318
:param sort: Parameter to sort results on
@@ -4357,6 +4368,7 @@ def base_studies_get_without_preload_content(
43574368
_param = self._base_studies_get_serialize(
43584369
feature_filter=feature_filter,
43594370
feature_display=feature_display,
4371+
feature_flatten=feature_flatten,
43604372
search=search,
43614373
sort=sort,
43624374
page=page,
@@ -4392,6 +4404,7 @@ def _base_studies_get_serialize(
43924404
self,
43934405
feature_filter,
43944406
feature_display,
4407+
feature_flatten,
43954408
search,
43964409
sort,
43974410
page,
@@ -4437,6 +4450,10 @@ def _base_studies_get_serialize(
44374450

44384451
_query_params.append(('feature_display', feature_display))
44394452

4453+
if feature_flatten is not None:
4454+
4455+
_query_params.append(('feature_flatten', feature_flatten))
4456+
44404457
if search is not None:
44414458

44424459
_query_params.append(('search', search))

Diff for: neurostore_sdk/api/studies_api.py

+17
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ def base_studies_get(
5252
self,
5353
feature_filter: Annotated[Optional[StrictStr], Field(description="Filter studies by features")] = None,
5454
feature_display: Annotated[Optional[StrictStr], Field(description="display features from pipelines")] = None,
55+
feature_flatten: Optional[StrictBool] = None,
5556
search: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="search for entries that contain the substring")] = None,
5657
sort: Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None,
5758
page: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="page of results")] = None,
@@ -87,6 +88,8 @@ def base_studies_get(
8788
:type feature_filter: str
8889
:param feature_display: display features from pipelines
8990
:type feature_display: str
91+
:param feature_flatten:
92+
:type feature_flatten: bool
9093
:param search: search for entries that contain the substring
9194
:type search: str
9295
:param sort: Parameter to sort results on
@@ -142,6 +145,7 @@ def base_studies_get(
142145
_param = self._base_studies_get_serialize(
143146
feature_filter=feature_filter,
144147
feature_display=feature_display,
148+
feature_flatten=feature_flatten,
145149
search=search,
146150
sort=sort,
147151
page=page,
@@ -182,6 +186,7 @@ def base_studies_get_with_http_info(
182186
self,
183187
feature_filter: Annotated[Optional[StrictStr], Field(description="Filter studies by features")] = None,
184188
feature_display: Annotated[Optional[StrictStr], Field(description="display features from pipelines")] = None,
189+
feature_flatten: Optional[StrictBool] = None,
185190
search: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="search for entries that contain the substring")] = None,
186191
sort: Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None,
187192
page: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="page of results")] = None,
@@ -217,6 +222,8 @@ def base_studies_get_with_http_info(
217222
:type feature_filter: str
218223
:param feature_display: display features from pipelines
219224
:type feature_display: str
225+
:param feature_flatten:
226+
:type feature_flatten: bool
220227
:param search: search for entries that contain the substring
221228
:type search: str
222229
:param sort: Parameter to sort results on
@@ -272,6 +279,7 @@ def base_studies_get_with_http_info(
272279
_param = self._base_studies_get_serialize(
273280
feature_filter=feature_filter,
274281
feature_display=feature_display,
282+
feature_flatten=feature_flatten,
275283
search=search,
276284
sort=sort,
277285
page=page,
@@ -312,6 +320,7 @@ def base_studies_get_without_preload_content(
312320
self,
313321
feature_filter: Annotated[Optional[StrictStr], Field(description="Filter studies by features")] = None,
314322
feature_display: Annotated[Optional[StrictStr], Field(description="display features from pipelines")] = None,
323+
feature_flatten: Optional[StrictBool] = None,
315324
search: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="search for entries that contain the substring")] = None,
316325
sort: Annotated[Optional[StrictStr], Field(description="Parameter to sort results on")] = None,
317326
page: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="page of results")] = None,
@@ -347,6 +356,8 @@ def base_studies_get_without_preload_content(
347356
:type feature_filter: str
348357
:param feature_display: display features from pipelines
349358
:type feature_display: str
359+
:param feature_flatten:
360+
:type feature_flatten: bool
350361
:param search: search for entries that contain the substring
351362
:type search: str
352363
:param sort: Parameter to sort results on
@@ -402,6 +413,7 @@ def base_studies_get_without_preload_content(
402413
_param = self._base_studies_get_serialize(
403414
feature_filter=feature_filter,
404415
feature_display=feature_display,
416+
feature_flatten=feature_flatten,
405417
search=search,
406418
sort=sort,
407419
page=page,
@@ -437,6 +449,7 @@ def _base_studies_get_serialize(
437449
self,
438450
feature_filter,
439451
feature_display,
452+
feature_flatten,
440453
search,
441454
sort,
442455
page,
@@ -482,6 +495,10 @@ def _base_studies_get_serialize(
482495

483496
_query_params.append(('feature_display', feature_display))
484497

498+
if feature_flatten is not None:
499+
500+
_query_params.append(('feature_flatten', feature_flatten))
501+
485502
if search is not None:
486503

487504
_query_params.append(('search', search))

0 commit comments

Comments
 (0)