Skip to content

Commit e39ad3b

Browse files
github-actions[bot]github-actions[bot]
committed
d2fa531c2e8d1291e96aed8da2771320f7260350
1 parent fce5e01 commit e39ad3b

26 files changed

+687
-241
lines changed

‎.openapi-generator/FILES

+4
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ docs/models/PointValue.md
5555
docs/models/ReadableResourceAttributes.md
5656
docs/models/ResourceAttributes.md
5757
docs/models/StudyBase.md
58+
docs/models/StudyCommon.md
5859
docs/models/StudyList.md
5960
docs/models/StudyRequest.md
6061
docs/models/StudyRequestRelationships.md
@@ -173,6 +174,8 @@ neurostore_sdk/model/resource_attributes.py
173174
neurostore_sdk/model/resource_attributes.pyi
174175
neurostore_sdk/model/study_base.py
175176
neurostore_sdk/model/study_base.pyi
177+
neurostore_sdk/model/study_common.py
178+
neurostore_sdk/model/study_common.pyi
176179
neurostore_sdk/model/study_list.py
177180
neurostore_sdk/model/study_list.pyi
178181
neurostore_sdk/model/study_request.py
@@ -214,4 +217,5 @@ setup.py
214217
test-requirements.txt
215218
test/__init__.py
216219
test/test_models/__init__.py
220+
test/test_models/test_study_common.py
217221
tox.ini

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,7 @@ Class | Method | HTTP request | Description
312312
- [ReadableResourceAttributes](docs/models/ReadableResourceAttributes.md)
313313
- [ResourceAttributes](docs/models/ResourceAttributes.md)
314314
- [StudyBase](docs/models/StudyBase.md)
315+
- [StudyCommon](docs/models/StudyCommon.md)
315316
- [StudyList](docs/models/StudyList.md)
316317
- [StudyRequest](docs/models/StudyRequest.md)
317318
- [StudyRequestRelationships](docs/models/StudyRequestRelationships.md)

‎docs/apis/tags/StoreApi.md

+9
Original file line numberDiff line numberDiff line change
@@ -2967,6 +2967,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
29672967
'user_id': "user_id_example",
29682968
'data_type': "coordinate",
29692969
'studyset_owner': "studyset_owner_example",
2970+
'level': "group",
29702971
}
29712972
try:
29722973
# GET a list of studies
@@ -3007,6 +3008,7 @@ authors | AuthorsSchema | | optional
30073008
user_id | UserIdSchema | | optional
30083009
data_type | DataTypeSchema | | optional
30093010
studyset_owner | StudysetOwnerSchema | | optional
3011+
level | LevelSchema | | optional
30103012

30113013

30123014
# SearchSchema
@@ -3114,6 +3116,13 @@ Input Type | Accessed Type | Description | Notes
31143116
------------ | ------------- | ------------- | -------------
31153117
str, | str, | |
31163118

3119+
# LevelSchema
3120+
3121+
## Model Type Info
3122+
Input Type | Accessed Type | Description | Notes
3123+
------------ | ------------- | ------------- | -------------
3124+
str, | str, | | must be one of ["group", "meta", ] if omitted the server will use the default value of "group"
3125+
31173126
### Return Types, Responses
31183127

31193128
Code | Class | Description

‎docs/apis/tags/StudiesApi.md

+9
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
6464
'user_id': "user_id_example",
6565
'data_type': "coordinate",
6666
'studyset_owner': "studyset_owner_example",
67+
'level': "group",
6768
}
6869
try:
6970
# GET a list of studies
@@ -104,6 +105,7 @@ authors | AuthorsSchema | | optional
104105
user_id | UserIdSchema | | optional
105106
data_type | DataTypeSchema | | optional
106107
studyset_owner | StudysetOwnerSchema | | optional
108+
level | LevelSchema | | optional
107109

108110

109111
# SearchSchema
@@ -211,6 +213,13 @@ Input Type | Accessed Type | Description | Notes
211213
------------ | ------------- | ------------- | -------------
212214
str, | str, | |
213215

216+
# LevelSchema
217+
218+
## Model Type Info
219+
Input Type | Accessed Type | Description | Notes
220+
------------ | ------------- | ------------- | -------------
221+
str, | str, | | must be one of ["group", "meta", ] if omitted the server will use the default value of "group"
222+
214223
### Return Types, Responses
215224

216225
Code | Class | Description

‎docs/models/AnalysisCommon.md

+13
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,20 @@ dict, frozendict.frozendict, | frozendict.frozendict, | attributes common betw
1111
Key | Input Type | Accessed Type | Description | Notes
1212
------------ | ------------- | ------------- | ------------- | -------------
1313
**study** | str, | str, | | [optional]
14+
**[entities](#entities)** | list, tuple, | tuple, | | [optional]
1415
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
1516

17+
# entities
18+
19+
## Model Type Info
20+
Input Type | Accessed Type | Description | Notes
21+
------------ | ------------- | ------------- | -------------
22+
list, tuple, | tuple, | |
23+
24+
### Tuple Items
25+
Class Name | Input Type | Accessed Type | Description | Notes
26+
------------- | ------------- | ------------- | ------------- | -------------
27+
[**Entity**](Entity.md) | [**Entity**](Entity.md) | [**Entity**](Entity.md) | |
28+
1629
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1730

‎docs/models/Entity.md

+5-19
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,18 @@
11
# neurostore_sdk.model.entity.Entity
22

3-
descriptor of level of analysis for a particular image/point (run, session, subject, group, meta)
3+
WARNING: not currently used. descriptor of level of analysis for a particular image/point (run, session, subject, group, meta)
44

55
## Model Type Info
66
Input Type | Accessed Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, | frozendict.frozendict, str, decimal.Decimal, BoolClass, NoneClass, tuple, bytes, FileIO | descriptor of level of analysis for a particular image/point (run, session, subject, group, meta) |
9-
10-
### Composed Schemas (allOf/anyOf/oneOf/not)
11-
#### allOf
12-
Class Name | Input Type | Accessed Type | Description | Notes
13-
------------- | ------------- | ------------- | ------------- | -------------
14-
[all_of_0](#all_of_0) | dict, frozendict.frozendict, | frozendict.frozendict, | |
15-
[UserlessResourceAttributes](UserlessResourceAttributes.md) | [**UserlessResourceAttributes**](UserlessResourceAttributes.md) | [**UserlessResourceAttributes**](UserlessResourceAttributes.md) | |
16-
17-
# all_of_0
18-
19-
## Model Type Info
20-
Input Type | Accessed Type | Description | Notes
21-
------------ | ------------- | ------------- | -------------
22-
dict, frozendict.frozendict, | frozendict.frozendict, | |
8+
dict, frozendict.frozendict, | frozendict.frozendict, | WARNING: not currently used. descriptor of level of analysis for a particular image/point (run, session, subject, group, meta) |
239

2410
### Dictionary Keys
2511
Key | Input Type | Accessed Type | Description | Notes
2612
------------ | ------------- | ------------- | ------------- | -------------
27-
**label** | str, | str, | | [optional]
28-
**level** | str, | str, | | [optional] must be one of ["run", "session", "subject", "group", "meta", ]
29-
**analysis** | str, | str, | | [optional]
13+
**label** | None, str, | NoneClass, str, | | [optional]
14+
**level** | None, str, | NoneClass, str, | | [optional]
15+
**analysis** | None, str, | NoneClass, str, | | [optional]
3016
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
3117

3218
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)

‎docs/models/PointCommon.md

+2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ dict, frozendict.frozendict, | frozendict.frozendict, | |
99
Key | Input Type | Accessed Type | Description | Notes
1010
------------ | ------------- | ------------- | ------------- | -------------
1111
**analysis** | str, | str, | | [optional]
12+
**cluster_size** | None, decimal.Decimal, int, float, | NoneClass, decimal.Decimal, | size of the cluster in cubic millimeters | [optional]
13+
**subpeak** | bool, | BoolClass, | whether the reported peak is the max-peak statistic or a sub-maxmimal peak. | [optional]
1214
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
1315

1416
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)

‎docs/models/StudyCommon.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# neurostore_sdk.model.study_common.StudyCommon
2+
3+
## Model Type Info
4+
Input Type | Accessed Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
dict, frozendict.frozendict, | frozendict.frozendict, | |
7+
8+
### Dictionary Keys
9+
Key | Input Type | Accessed Type | Description | Notes
10+
------------ | ------------- | ------------- | ------------- | -------------
11+
**level** | str, | str, | | [optional] must be one of ["group", "meta", ]
12+
**any_string_name** | dict, frozendict.frozendict, str, date, datetime, int, float, bool, decimal.Decimal, None, list, tuple, bytes, io.FileIO, io.BufferedReader | frozendict.frozendict, str, BoolClass, decimal.Decimal, NoneClass, tuple, bytes, FileIO | any string name can be used but the value must be the correct type | [optional]
13+
14+
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
15+

‎docs/models/StudysetRequest.md

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Class Name | Input Type | Accessed Type | Description | Notes
1212
[StudysetBase](StudysetBase.md) | [**StudysetBase**](StudysetBase.md) | [**StudysetBase**](StudysetBase.md) | |
1313
[StudysetRequestRelationships](StudysetRequestRelationships.md) | [**StudysetRequestRelationships**](StudysetRequestRelationships.md) | [**StudysetRequestRelationships**](StudysetRequestRelationships.md) | |
1414
[WriteableResourceAttributes](WriteableResourceAttributes.md) | [**WriteableResourceAttributes**](WriteableResourceAttributes.md) | [**WriteableResourceAttributes**](WriteableResourceAttributes.md) | |
15+
[StudyCommon](StudyCommon.md) | [**StudyCommon**](StudyCommon.md) | [**StudyCommon**](StudyCommon.md) | |
1516

1617
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1718

‎docs/models/StudysetReturn.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Class Name | Input Type | Accessed Type | Description | Notes
1313
[ResourceAttributes](ResourceAttributes.md) | [**ResourceAttributes**](ResourceAttributes.md) | [**ResourceAttributes**](ResourceAttributes.md) | |
1414
[Clone](Clone.md) | [**Clone**](Clone.md) | [**Clone**](Clone.md) | |
1515
[StudysetReturnRelationships](StudysetReturnRelationships.md) | [**StudysetReturnRelationships**](StudysetReturnRelationships.md) | [**StudysetReturnRelationships**](StudysetReturnRelationships.md) | |
16+
[StudyCommon](StudyCommon.md) | [**StudyCommon**](StudyCommon.md) | [**StudyCommon**](StudyCommon.md) | |
1617

1718
[[Back to Model list]](../../README.md#documentation-for-models) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to README]](../../README.md)
1819

‎neurostore_sdk/model/analysis_common.py

+39-2
Original file line numberDiff line numberDiff line change
@@ -40,42 +40,79 @@ class MetaOapg:
4040

4141
class properties:
4242
study = schemas.StrSchema
43+
44+
45+
class entities(
46+
schemas.ListSchema
47+
):
48+
49+
50+
class MetaOapg:
51+
52+
@staticmethod
53+
def items() -> typing.Type['Entity']:
54+
return Entity
55+
56+
def __new__(
57+
cls,
58+
_arg: typing.Union[typing.Tuple['Entity'], typing.List['Entity']],
59+
_configuration: typing.Optional[schemas.Configuration] = None,
60+
) -> 'entities':
61+
return super().__new__(
62+
cls,
63+
_arg,
64+
_configuration=_configuration,
65+
)
66+
67+
def __getitem__(self, i: int) -> 'Entity':
68+
return super().__getitem__(i)
4369
__annotations__ = {
4470
"study": study,
71+
"entities": entities,
4572
}
4673

4774
@typing.overload
4875
def __getitem__(self, name: typing_extensions.Literal["study"]) -> MetaOapg.properties.study: ...
4976

77+
@typing.overload
78+
def __getitem__(self, name: typing_extensions.Literal["entities"]) -> MetaOapg.properties.entities: ...
79+
5080
@typing.overload
5181
def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ...
5282

53-
def __getitem__(self, name: typing.Union[typing_extensions.Literal["study", ], str]):
83+
def __getitem__(self, name: typing.Union[typing_extensions.Literal["study", "entities", ], str]):
5484
# dict_instance[name] accessor
5585
return super().__getitem__(name)
5686

5787

5888
@typing.overload
5989
def get_item_oapg(self, name: typing_extensions.Literal["study"]) -> typing.Union[MetaOapg.properties.study, schemas.Unset]: ...
6090

91+
@typing.overload
92+
def get_item_oapg(self, name: typing_extensions.Literal["entities"]) -> typing.Union[MetaOapg.properties.entities, schemas.Unset]: ...
93+
6194
@typing.overload
6295
def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ...
6396

64-
def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["study", ], str]):
97+
def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["study", "entities", ], str]):
6598
return super().get_item_oapg(name)
6699

67100

68101
def __new__(
69102
cls,
70103
*_args: typing.Union[dict, frozendict.frozendict, ],
71104
study: typing.Union[MetaOapg.properties.study, str, schemas.Unset] = schemas.unset,
105+
entities: typing.Union[MetaOapg.properties.entities, list, tuple, schemas.Unset] = schemas.unset,
72106
_configuration: typing.Optional[schemas.Configuration] = None,
73107
**kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes],
74108
) -> 'AnalysisCommon':
75109
return super().__new__(
76110
cls,
77111
*_args,
78112
study=study,
113+
entities=entities,
79114
_configuration=_configuration,
80115
**kwargs,
81116
)
117+
118+
from neurostore_sdk.model.entity import Entity

‎neurostore_sdk/model/analysis_common.pyi

+39-2
Original file line numberDiff line numberDiff line change
@@ -40,42 +40,79 @@ class AnalysisCommon(
4040

4141
class properties:
4242
study = schemas.StrSchema
43+
44+
45+
class entities(
46+
schemas.ListSchema
47+
):
48+
49+
50+
class MetaOapg:
51+
52+
@staticmethod
53+
def items() -> typing.Type['Entity']:
54+
return Entity
55+
56+
def __new__(
57+
cls,
58+
_arg: typing.Union[typing.Tuple['Entity'], typing.List['Entity']],
59+
_configuration: typing.Optional[schemas.Configuration] = None,
60+
) -> 'entities':
61+
return super().__new__(
62+
cls,
63+
_arg,
64+
_configuration=_configuration,
65+
)
66+
67+
def __getitem__(self, i: int) -> 'Entity':
68+
return super().__getitem__(i)
4369
__annotations__ = {
4470
"study": study,
71+
"entities": entities,
4572
}
4673

4774
@typing.overload
4875
def __getitem__(self, name: typing_extensions.Literal["study"]) -> MetaOapg.properties.study: ...
4976

77+
@typing.overload
78+
def __getitem__(self, name: typing_extensions.Literal["entities"]) -> MetaOapg.properties.entities: ...
79+
5080
@typing.overload
5181
def __getitem__(self, name: str) -> schemas.UnsetAnyTypeSchema: ...
5282

53-
def __getitem__(self, name: typing.Union[typing_extensions.Literal["study", ], str]):
83+
def __getitem__(self, name: typing.Union[typing_extensions.Literal["study", "entities", ], str]):
5484
# dict_instance[name] accessor
5585
return super().__getitem__(name)
5686

5787

5888
@typing.overload
5989
def get_item_oapg(self, name: typing_extensions.Literal["study"]) -> typing.Union[MetaOapg.properties.study, schemas.Unset]: ...
6090

91+
@typing.overload
92+
def get_item_oapg(self, name: typing_extensions.Literal["entities"]) -> typing.Union[MetaOapg.properties.entities, schemas.Unset]: ...
93+
6194
@typing.overload
6295
def get_item_oapg(self, name: str) -> typing.Union[schemas.UnsetAnyTypeSchema, schemas.Unset]: ...
6396

64-
def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["study", ], str]):
97+
def get_item_oapg(self, name: typing.Union[typing_extensions.Literal["study", "entities", ], str]):
6598
return super().get_item_oapg(name)
6699

67100

68101
def __new__(
69102
cls,
70103
*_args: typing.Union[dict, frozendict.frozendict, ],
71104
study: typing.Union[MetaOapg.properties.study, str, schemas.Unset] = schemas.unset,
105+
entities: typing.Union[MetaOapg.properties.entities, list, tuple, schemas.Unset] = schemas.unset,
72106
_configuration: typing.Optional[schemas.Configuration] = None,
73107
**kwargs: typing.Union[schemas.AnyTypeSchema, dict, frozendict.frozendict, str, date, datetime, uuid.UUID, int, float, decimal.Decimal, None, list, tuple, bytes],
74108
) -> 'AnalysisCommon':
75109
return super().__new__(
76110
cls,
77111
*_args,
78112
study=study,
113+
entities=entities,
79114
_configuration=_configuration,
80115
**kwargs,
81116
)
117+
118+
from neurostore_sdk.model.entity import Entity

0 commit comments

Comments
 (0)