Skip to content

Commit b9f5517

Browse files
github-actions[bot]github-actions[bot]
committed
efaaa1bff474b3a73fefdf840f436bbc6a4b5a0c
1 parent 9ae1c9f commit b9f5517

14 files changed

Lines changed: 1443 additions & 14 deletions

‎.openapi-generator/FILES‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ docs/JsonLd.md
5454
docs/JsonLdContext.md
5555
docs/Metadata.md
5656
docs/NestedPutAttributes.md
57+
docs/NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response.md
58+
docs/NeurostoreResourcesNeurostoreStudysetReleasesSearch200ResponseMetadata.md
59+
docs/NeurostoreStudysetReleasesApi.md
5760
docs/NoteCollectionBase.md
5861
docs/NoteCollectionList.md
5962
docs/NoteCollectionRequest.md
@@ -114,6 +117,7 @@ docs/WriteableResourceAttributes.md
114117
git_push.sh
115118
neurostore_sdk/__init__.py
116119
neurostore_sdk/api/__init__.py
120+
neurostore_sdk/api/neurostore_studyset_releases_api.py
117121
neurostore_sdk/api/store_api.py
118122
neurostore_sdk/api_client.py
119123
neurostore_sdk/api_response.py
@@ -171,6 +175,8 @@ neurostore_sdk/models/json_ld.py
171175
neurostore_sdk/models/json_ld_context.py
172176
neurostore_sdk/models/metadata.py
173177
neurostore_sdk/models/nested_put_attributes.py
178+
neurostore_sdk/models/neurostore_resources_neurostore_studyset_releases_search200_response.py
179+
neurostore_sdk/models/neurostore_resources_neurostore_studyset_releases_search200_response_metadata.py
174180
neurostore_sdk/models/note_collection_base.py
175181
neurostore_sdk/models/note_collection_list.py
176182
neurostore_sdk/models/note_collection_request.py
@@ -286,6 +292,9 @@ test/test_json_ld.py
286292
test/test_json_ld_context.py
287293
test/test_metadata.py
288294
test/test_nested_put_attributes.py
295+
test/test_neurostore_resources_neurostore_studyset_releases_search200_response.py
296+
test/test_neurostore_resources_neurostore_studyset_releases_search200_response_metadata.py
297+
test/test_neurostore_studyset_releases_api.py
289298
test/test_note_collection_base.py
290299
test/test_note_collection_list.py
291300
test/test_note_collection_request.py

‎README.md‎

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -67,24 +67,16 @@ configuration = neurostore_sdk.Configuration(
6767
# Enter a context with an instance of the API client
6868
with neurostore_sdk.ApiClient(configuration) as api_client:
6969
# Create an instance of the API class
70-
api_instance = neurostore_sdk.StoreApi(api_client)
71-
search = 'imagin' # str | search for entries that contain the substring (optional)
72-
sort = 'created_at' # str | Parameter to sort results on (optional) (default to 'created_at')
73-
page = 56 # int | page of results (optional)
74-
desc = True # bool | sort results by descending order (as opposed to ascending order) (optional)
75-
page_size = 56 # int | number of results to show on a page (optional)
76-
paginate = True # bool | whether to paginate results (true) or return all results at once (false) (optional) (default to True)
77-
study = 'study_example' # str | Filter tables by study id (optional)
78-
name = 'name_example' # str | search the name field for a term (optional)
79-
nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)
70+
api_instance = neurostore_sdk.NeurostoreStudysetReleasesApi(api_client)
71+
version = 'version_example' # str | nightly, latest, or a monthly release in YYYY-MM format.
8072

8173
try:
82-
# GET list of analyses
83-
api_response = api_instance.analyses_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, paginate=paginate, study=study, name=name, nested=nested)
84-
print("The response of StoreApi->analyses_get:\n")
74+
# Download NeuroStore studyset release tarball
75+
api_response = api_instance.neurostore_resources_neurostore_studyset_releases_download(version)
76+
print("The response of NeurostoreStudysetReleasesApi->neurostore_resources_neurostore_studyset_releases_download:\n")
8577
pprint(api_response)
8678
except ApiException as e:
87-
print("Exception when calling StoreApi->analyses_get: %s\n" % e)
79+
print("Exception when calling NeurostoreStudysetReleasesApi->neurostore_resources_neurostore_studyset_releases_download: %s\n" % e)
8880

8981
```
9082

@@ -94,6 +86,9 @@ All URIs are relative to *https://neurostore.org/api*
9486

9587
Class | Method | HTTP request | Description
9688
------------ | ------------- | ------------- | -------------
89+
*NeurostoreStudysetReleasesApi* | [**neurostore_resources_neurostore_studyset_releases_download**](docs/NeurostoreStudysetReleasesApi.md#neurostore_resources_neurostore_studyset_releases_download) | **GET** /neurostore-studyset-releases/{version}/download | Download NeuroStore studyset release tarball
90+
*NeurostoreStudysetReleasesApi* | [**neurostore_resources_neurostore_studyset_releases_get**](docs/NeurostoreStudysetReleasesApi.md#neurostore_resources_neurostore_studyset_releases_get) | **GET** /neurostore-studyset-releases/{version} | GET NeuroStore studyset release manifest
91+
*NeurostoreStudysetReleasesApi* | [**neurostore_resources_neurostore_studyset_releases_search**](docs/NeurostoreStudysetReleasesApi.md#neurostore_resources_neurostore_studyset_releases_search) | **GET** /neurostore-studyset-releases/ | GET NeuroStore studyset release list
9792
*StoreApi* | [**analyses_get**](docs/StoreApi.md#analyses_get) | **GET** /analyses/ | GET list of analyses
9893
*StoreApi* | [**analyses_id_delete**](docs/StoreApi.md#analyses_id_delete) | **DELETE** /analyses/{id} | DELETE an analysis
9994
*StoreApi* | [**analyses_id_get**](docs/StoreApi.md#analyses_id_get) | **GET** /analyses/{id} | GET an analysis
@@ -218,6 +213,8 @@ Class | Method | HTTP request | Description
218213
- [JsonLdContext](docs/JsonLdContext.md)
219214
- [Metadata](docs/Metadata.md)
220215
- [NestedPutAttributes](docs/NestedPutAttributes.md)
216+
- [NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response](docs/NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response.md)
217+
- [NeurostoreResourcesNeurostoreStudysetReleasesSearch200ResponseMetadata](docs/NeurostoreResourcesNeurostoreStudysetReleasesSearch200ResponseMetadata.md)
221218
- [NoteCollectionBase](docs/NoteCollectionBase.md)
222219
- [NoteCollectionList](docs/NoteCollectionList.md)
223220
- [NoteCollectionRequest](docs/NoteCollectionRequest.md)

‎docs/NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**metadata** | [**NeurostoreResourcesNeurostoreStudysetReleasesSearch200ResponseMetadata**](NeurostoreResourcesNeurostoreStudysetReleasesSearch200ResponseMetadata.md) | | [optional]
9+
**results** | **List[object]** | | [optional]
10+
11+
## Example
12+
13+
```python
14+
from neurostore_sdk.models.neurostore_resources_neurostore_studyset_releases_search200_response import NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response
15+
16+
# TODO update the JSON string below
17+
json = "{}"
18+
# create an instance of NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response from a JSON string
19+
neurostore_resources_neurostore_studyset_releases_search200_response_instance = NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response.from_json(json)
20+
# print the JSON string representation of the object
21+
print(NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response.to_json())
22+
23+
# convert the object into a dict
24+
neurostore_resources_neurostore_studyset_releases_search200_response_dict = neurostore_resources_neurostore_studyset_releases_search200_response_instance.to_dict()
25+
# create an instance of NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response from a dict
26+
neurostore_resources_neurostore_studyset_releases_search200_response_from_dict = NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response.from_dict(neurostore_resources_neurostore_studyset_releases_search200_response_dict)
27+
```
28+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29+
30+

‎docs/NeurostoreResourcesNeurostoreStudysetReleasesSearch200ResponseMetadata.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# NeurostoreResourcesNeurostoreStudysetReleasesSearch200ResponseMetadata
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**total_count** | **int** | | [optional]
9+
10+
## Example
11+
12+
```python
13+
from neurostore_sdk.models.neurostore_resources_neurostore_studyset_releases_search200_response_metadata import NeurostoreResourcesNeurostoreStudysetReleasesSearch200ResponseMetadata
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of NeurostoreResourcesNeurostoreStudysetReleasesSearch200ResponseMetadata from a JSON string
18+
neurostore_resources_neurostore_studyset_releases_search200_response_metadata_instance = NeurostoreResourcesNeurostoreStudysetReleasesSearch200ResponseMetadata.from_json(json)
19+
# print the JSON string representation of the object
20+
print(NeurostoreResourcesNeurostoreStudysetReleasesSearch200ResponseMetadata.to_json())
21+
22+
# convert the object into a dict
23+
neurostore_resources_neurostore_studyset_releases_search200_response_metadata_dict = neurostore_resources_neurostore_studyset_releases_search200_response_metadata_instance.to_dict()
24+
# create an instance of NeurostoreResourcesNeurostoreStudysetReleasesSearch200ResponseMetadata from a dict
25+
neurostore_resources_neurostore_studyset_releases_search200_response_metadata_from_dict = NeurostoreResourcesNeurostoreStudysetReleasesSearch200ResponseMetadata.from_dict(neurostore_resources_neurostore_studyset_releases_search200_response_metadata_dict)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+

‎docs/NeurostoreStudysetReleasesApi.md‎

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
# neurostore_sdk.NeurostoreStudysetReleasesApi
2+
3+
All URIs are relative to *https://neurostore.org/api*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**neurostore_resources_neurostore_studyset_releases_download**](NeurostoreStudysetReleasesApi.md#neurostore_resources_neurostore_studyset_releases_download) | **GET** /neurostore-studyset-releases/{version}/download | Download NeuroStore studyset release tarball
8+
[**neurostore_resources_neurostore_studyset_releases_get**](NeurostoreStudysetReleasesApi.md#neurostore_resources_neurostore_studyset_releases_get) | **GET** /neurostore-studyset-releases/{version} | GET NeuroStore studyset release manifest
9+
[**neurostore_resources_neurostore_studyset_releases_search**](NeurostoreStudysetReleasesApi.md#neurostore_resources_neurostore_studyset_releases_search) | **GET** /neurostore-studyset-releases/ | GET NeuroStore studyset release list
10+
11+
12+
# **neurostore_resources_neurostore_studyset_releases_download**
13+
> bytearray neurostore_resources_neurostore_studyset_releases_download(version)
14+
15+
Download NeuroStore studyset release tarball
16+
17+
### Example
18+
19+
20+
```python
21+
import neurostore_sdk
22+
from neurostore_sdk.rest import ApiException
23+
from pprint import pprint
24+
25+
# Defining the host is optional and defaults to https://neurostore.org/api
26+
# See configuration.py for a list of all supported configuration parameters.
27+
configuration = neurostore_sdk.Configuration(
28+
host = "https://neurostore.org/api"
29+
)
30+
31+
32+
# Enter a context with an instance of the API client
33+
with neurostore_sdk.ApiClient(configuration) as api_client:
34+
# Create an instance of the API class
35+
api_instance = neurostore_sdk.NeurostoreStudysetReleasesApi(api_client)
36+
version = 'version_example' # str | nightly, latest, or a monthly release in YYYY-MM format.
37+
38+
try:
39+
# Download NeuroStore studyset release tarball
40+
api_response = api_instance.neurostore_resources_neurostore_studyset_releases_download(version)
41+
print("The response of NeurostoreStudysetReleasesApi->neurostore_resources_neurostore_studyset_releases_download:\n")
42+
pprint(api_response)
43+
except Exception as e:
44+
print("Exception when calling NeurostoreStudysetReleasesApi->neurostore_resources_neurostore_studyset_releases_download: %s\n" % e)
45+
```
46+
47+
48+
49+
### Parameters
50+
51+
52+
Name | Type | Description | Notes
53+
------------- | ------------- | ------------- | -------------
54+
**version** | **str**| nightly, latest, or a monthly release in YYYY-MM format. |
55+
56+
### Return type
57+
58+
**bytearray**
59+
60+
### Authorization
61+
62+
No authorization required
63+
64+
### HTTP request headers
65+
66+
- **Content-Type**: Not defined
67+
- **Accept**: application/gzip, application/json
68+
69+
### HTTP response details
70+
71+
| Status code | Description | Response headers |
72+
|-------------|-------------|------------------|
73+
**200** | OK | - |
74+
**404** | Not Found | - |
75+
76+
[[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)
77+
78+
# **neurostore_resources_neurostore_studyset_releases_get**
79+
> object neurostore_resources_neurostore_studyset_releases_get(version)
80+
81+
GET NeuroStore studyset release manifest
82+
83+
### Example
84+
85+
86+
```python
87+
import neurostore_sdk
88+
from neurostore_sdk.rest import ApiException
89+
from pprint import pprint
90+
91+
# Defining the host is optional and defaults to https://neurostore.org/api
92+
# See configuration.py for a list of all supported configuration parameters.
93+
configuration = neurostore_sdk.Configuration(
94+
host = "https://neurostore.org/api"
95+
)
96+
97+
98+
# Enter a context with an instance of the API client
99+
with neurostore_sdk.ApiClient(configuration) as api_client:
100+
# Create an instance of the API class
101+
api_instance = neurostore_sdk.NeurostoreStudysetReleasesApi(api_client)
102+
version = 'version_example' # str | nightly, latest, or a monthly release in YYYY-MM format.
103+
104+
try:
105+
# GET NeuroStore studyset release manifest
106+
api_response = api_instance.neurostore_resources_neurostore_studyset_releases_get(version)
107+
print("The response of NeurostoreStudysetReleasesApi->neurostore_resources_neurostore_studyset_releases_get:\n")
108+
pprint(api_response)
109+
except Exception as e:
110+
print("Exception when calling NeurostoreStudysetReleasesApi->neurostore_resources_neurostore_studyset_releases_get: %s\n" % e)
111+
```
112+
113+
114+
115+
### Parameters
116+
117+
118+
Name | Type | Description | Notes
119+
------------- | ------------- | ------------- | -------------
120+
**version** | **str**| nightly, latest, or a monthly release in YYYY-MM format. |
121+
122+
### Return type
123+
124+
**object**
125+
126+
### Authorization
127+
128+
No authorization required
129+
130+
### HTTP request headers
131+
132+
- **Content-Type**: Not defined
133+
- **Accept**: application/json
134+
135+
### HTTP response details
136+
137+
| Status code | Description | Response headers |
138+
|-------------|-------------|------------------|
139+
**200** | OK | - |
140+
**404** | Not Found | - |
141+
142+
[[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)
143+
144+
# **neurostore_resources_neurostore_studyset_releases_search**
145+
> NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response neurostore_resources_neurostore_studyset_releases_search()
146+
147+
GET NeuroStore studyset release list
148+
149+
### Example
150+
151+
152+
```python
153+
import neurostore_sdk
154+
from neurostore_sdk.models.neurostore_resources_neurostore_studyset_releases_search200_response import NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response
155+
from neurostore_sdk.rest import ApiException
156+
from pprint import pprint
157+
158+
# Defining the host is optional and defaults to https://neurostore.org/api
159+
# See configuration.py for a list of all supported configuration parameters.
160+
configuration = neurostore_sdk.Configuration(
161+
host = "https://neurostore.org/api"
162+
)
163+
164+
165+
# Enter a context with an instance of the API client
166+
with neurostore_sdk.ApiClient(configuration) as api_client:
167+
# Create an instance of the API class
168+
api_instance = neurostore_sdk.NeurostoreStudysetReleasesApi(api_client)
169+
170+
try:
171+
# GET NeuroStore studyset release list
172+
api_response = api_instance.neurostore_resources_neurostore_studyset_releases_search()
173+
print("The response of NeurostoreStudysetReleasesApi->neurostore_resources_neurostore_studyset_releases_search:\n")
174+
pprint(api_response)
175+
except Exception as e:
176+
print("Exception when calling NeurostoreStudysetReleasesApi->neurostore_resources_neurostore_studyset_releases_search: %s\n" % e)
177+
```
178+
179+
180+
181+
### Parameters
182+
183+
This endpoint does not need any parameter.
184+
185+
### Return type
186+
187+
[**NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response**](NeurostoreResourcesNeurostoreStudysetReleasesSearch200Response.md)
188+
189+
### Authorization
190+
191+
No authorization required
192+
193+
### HTTP request headers
194+
195+
- **Content-Type**: Not defined
196+
- **Accept**: application/json
197+
198+
### HTTP response details
199+
200+
| Status code | Description | Response headers |
201+
|-------------|-------------|------------------|
202+
**200** | OK | - |
203+
204+
[[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)
205+

0 commit comments

Comments
 (0)