Skip to content

Commit b103bf7

Browse files
github-actions[bot]github-actions[bot]
committed
d84932a1b1bb67892bbaf4aff0313ecb62b09e30
1 parent 40d9565 commit b103bf7

9 files changed

Lines changed: 1001 additions & 874 deletions

File tree

‎.openapi-generator/FILES‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ docs/JsonLd.md
5454
docs/JsonLdContext.md
5555
docs/Metadata.md
5656
docs/NestedPutAttributes.md
57-
docs/NeurostoreStudysetReleasesApi.md
5857
docs/NeurostoreStudysetReleasesGet200Response.md
5958
docs/NeurostoreStudysetReleasesGet200ResponseMetadata.md
6059
docs/NoteCollectionBase.md
@@ -117,7 +116,6 @@ docs/WriteableResourceAttributes.md
117116
git_push.sh
118117
neurostore_sdk/__init__.py
119118
neurostore_sdk/api/__init__.py
120-
neurostore_sdk/api/neurostore_studyset_releases_api.py
121119
neurostore_sdk/api/store_api.py
122120
neurostore_sdk/api_client.py
123121
neurostore_sdk/api_response.py
@@ -292,7 +290,6 @@ test/test_json_ld.py
292290
test/test_json_ld_context.py
293291
test/test_metadata.py
294292
test/test_nested_put_attributes.py
295-
test/test_neurostore_studyset_releases_api.py
296293
test/test_neurostore_studyset_releases_get200_response.py
297294
test/test_neurostore_studyset_releases_get200_response_metadata.py
298295
test/test_note_collection_base.py

‎README.md‎

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,24 @@ 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.NeurostoreStudysetReleasesApi(api_client)
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)
7180

7281
try:
73-
# GET NeuroStore studyset release list
74-
api_response = api_instance.neurostore_studyset_releases_get()
75-
print("The response of NeurostoreStudysetReleasesApi->neurostore_studyset_releases_get:\n")
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")
7685
pprint(api_response)
7786
except ApiException as e:
78-
print("Exception when calling NeurostoreStudysetReleasesApi->neurostore_studyset_releases_get: %s\n" % e)
87+
print("Exception when calling StoreApi->analyses_get: %s\n" % e)
7988

8089
```
8190

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

8695
Class | Method | HTTP request | Description
8796
------------ | ------------- | ------------- | -------------
88-
*NeurostoreStudysetReleasesApi* | [**neurostore_studyset_releases_get**](docs/NeurostoreStudysetReleasesApi.md#neurostore_studyset_releases_get) | **GET** /neurostore-studyset-releases/ | GET NeuroStore studyset release list
89-
*NeurostoreStudysetReleasesApi* | [**neurostore_studyset_releases_version_download_get**](docs/NeurostoreStudysetReleasesApi.md#neurostore_studyset_releases_version_download_get) | **GET** /neurostore-studyset-releases/{version}/download | Download NeuroStore studyset release tarball
90-
*NeurostoreStudysetReleasesApi* | [**neurostore_studyset_releases_version_get**](docs/NeurostoreStudysetReleasesApi.md#neurostore_studyset_releases_version_get) | **GET** /neurostore-studyset-releases/{version} | GET NeuroStore studyset release manifest
9197
*StoreApi* | [**analyses_get**](docs/StoreApi.md#analyses_get) | **GET** /analyses/ | GET list of analyses
9298
*StoreApi* | [**analyses_id_delete**](docs/StoreApi.md#analyses_id_delete) | **DELETE** /analyses/{id} | DELETE an analysis
9399
*StoreApi* | [**analyses_id_get**](docs/StoreApi.md#analyses_id_get) | **GET** /analyses/{id} | GET an analysis
@@ -116,6 +122,9 @@ Class | Method | HTTP request | Description
116122
*StoreApi* | [**images_id_get**](docs/StoreApi.md#images_id_get) | **GET** /images/{id} | GET an image
117123
*StoreApi* | [**images_id_put**](docs/StoreApi.md#images_id_put) | **PUT** /images/{id} | PUT/update an image
118124
*StoreApi* | [**images_post**](docs/StoreApi.md#images_post) | **POST** /images/ | POST/create an image
125+
*StoreApi* | [**neurostore_studyset_releases_get**](docs/StoreApi.md#neurostore_studyset_releases_get) | **GET** /neurostore-studyset-releases/ | GET NeuroStore studyset release list
126+
*StoreApi* | [**neurostore_studyset_releases_version_download_get**](docs/StoreApi.md#neurostore_studyset_releases_version_download_get) | **GET** /neurostore-studyset-releases/{version}/download | Download NeuroStore studyset release tarball
127+
*StoreApi* | [**neurostore_studyset_releases_version_get**](docs/StoreApi.md#neurostore_studyset_releases_version_get) | **GET** /neurostore-studyset-releases/{version} | GET NeuroStore studyset release manifest
119128
*StoreApi* | [**pipeline_configs_get**](docs/StoreApi.md#pipeline_configs_get) | **GET** /pipeline-configs/ | GET a list of pipeline configs
120129
*StoreApi* | [**pipeline_configs_id_delete**](docs/StoreApi.md#pipeline_configs_id_delete) | **DELETE** /pipeline-configs/{id} | DELETE a pipeline config by ID
121130
*StoreApi* | [**pipeline_configs_id_get**](docs/StoreApi.md#pipeline_configs_id_get) | **GET** /pipeline-configs/{id} | GET a pipeline config by ID

‎docs/StoreApi.md‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ Method | HTTP request | Description
3232
[**images_id_get**](StoreApi.md#images_id_get) | **GET** /images/{id} | GET an image
3333
[**images_id_put**](StoreApi.md#images_id_put) | **PUT** /images/{id} | PUT/update an image
3434
[**images_post**](StoreApi.md#images_post) | **POST** /images/ | POST/create an image
35+
[**neurostore_studyset_releases_get**](StoreApi.md#neurostore_studyset_releases_get) | **GET** /neurostore-studyset-releases/ | GET NeuroStore studyset release list
36+
[**neurostore_studyset_releases_version_download_get**](StoreApi.md#neurostore_studyset_releases_version_download_get) | **GET** /neurostore-studyset-releases/{version}/download | Download NeuroStore studyset release tarball
37+
[**neurostore_studyset_releases_version_get**](StoreApi.md#neurostore_studyset_releases_version_get) | **GET** /neurostore-studyset-releases/{version} | GET NeuroStore studyset release manifest
3538
[**pipeline_configs_get**](StoreApi.md#pipeline_configs_get) | **GET** /pipeline-configs/ | GET a list of pipeline configs
3639
[**pipeline_configs_id_delete**](StoreApi.md#pipeline_configs_id_delete) | **DELETE** /pipeline-configs/{id} | DELETE a pipeline config by ID
3740
[**pipeline_configs_id_get**](StoreApi.md#pipeline_configs_id_get) | **GET** /pipeline-configs/{id} | GET a pipeline config by ID
@@ -2298,6 +2301,200 @@ Name | Type | Description | Notes
22982301

22992302
[[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)
23002303

2304+
# **neurostore_studyset_releases_get**
2305+
> NeurostoreStudysetReleasesGet200Response neurostore_studyset_releases_get()
2306+
2307+
GET NeuroStore studyset release list
2308+
2309+
### Example
2310+
2311+
2312+
```python
2313+
import neurostore_sdk
2314+
from neurostore_sdk.models.neurostore_studyset_releases_get200_response import NeurostoreStudysetReleasesGet200Response
2315+
from neurostore_sdk.rest import ApiException
2316+
from pprint import pprint
2317+
2318+
# Defining the host is optional and defaults to https://neurostore.org/api
2319+
# See configuration.py for a list of all supported configuration parameters.
2320+
configuration = neurostore_sdk.Configuration(
2321+
host = "https://neurostore.org/api"
2322+
)
2323+
2324+
2325+
# Enter a context with an instance of the API client
2326+
with neurostore_sdk.ApiClient(configuration) as api_client:
2327+
# Create an instance of the API class
2328+
api_instance = neurostore_sdk.StoreApi(api_client)
2329+
2330+
try:
2331+
# GET NeuroStore studyset release list
2332+
api_response = api_instance.neurostore_studyset_releases_get()
2333+
print("The response of StoreApi->neurostore_studyset_releases_get:\n")
2334+
pprint(api_response)
2335+
except Exception as e:
2336+
print("Exception when calling StoreApi->neurostore_studyset_releases_get: %s\n" % e)
2337+
```
2338+
2339+
2340+
2341+
### Parameters
2342+
2343+
This endpoint does not need any parameter.
2344+
2345+
### Return type
2346+
2347+
[**NeurostoreStudysetReleasesGet200Response**](NeurostoreStudysetReleasesGet200Response.md)
2348+
2349+
### Authorization
2350+
2351+
No authorization required
2352+
2353+
### HTTP request headers
2354+
2355+
- **Content-Type**: Not defined
2356+
- **Accept**: application/json
2357+
2358+
### HTTP response details
2359+
2360+
| Status code | Description | Response headers |
2361+
|-------------|-------------|------------------|
2362+
**200** | OK | - |
2363+
2364+
[[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)
2365+
2366+
# **neurostore_studyset_releases_version_download_get**
2367+
> bytearray neurostore_studyset_releases_version_download_get(version)
2368+
2369+
Download NeuroStore studyset release tarball
2370+
2371+
### Example
2372+
2373+
2374+
```python
2375+
import neurostore_sdk
2376+
from neurostore_sdk.rest import ApiException
2377+
from pprint import pprint
2378+
2379+
# Defining the host is optional and defaults to https://neurostore.org/api
2380+
# See configuration.py for a list of all supported configuration parameters.
2381+
configuration = neurostore_sdk.Configuration(
2382+
host = "https://neurostore.org/api"
2383+
)
2384+
2385+
2386+
# Enter a context with an instance of the API client
2387+
with neurostore_sdk.ApiClient(configuration) as api_client:
2388+
# Create an instance of the API class
2389+
api_instance = neurostore_sdk.StoreApi(api_client)
2390+
version = 'version_example' # str | nightly, latest, or a monthly release in YYYY-MM format.
2391+
2392+
try:
2393+
# Download NeuroStore studyset release tarball
2394+
api_response = api_instance.neurostore_studyset_releases_version_download_get(version)
2395+
print("The response of StoreApi->neurostore_studyset_releases_version_download_get:\n")
2396+
pprint(api_response)
2397+
except Exception as e:
2398+
print("Exception when calling StoreApi->neurostore_studyset_releases_version_download_get: %s\n" % e)
2399+
```
2400+
2401+
2402+
2403+
### Parameters
2404+
2405+
2406+
Name | Type | Description | Notes
2407+
------------- | ------------- | ------------- | -------------
2408+
**version** | **str**| nightly, latest, or a monthly release in YYYY-MM format. |
2409+
2410+
### Return type
2411+
2412+
**bytearray**
2413+
2414+
### Authorization
2415+
2416+
No authorization required
2417+
2418+
### HTTP request headers
2419+
2420+
- **Content-Type**: Not defined
2421+
- **Accept**: application/gzip, application/json
2422+
2423+
### HTTP response details
2424+
2425+
| Status code | Description | Response headers |
2426+
|-------------|-------------|------------------|
2427+
**200** | OK | - |
2428+
**404** | Not Found | - |
2429+
2430+
[[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)
2431+
2432+
# **neurostore_studyset_releases_version_get**
2433+
> object neurostore_studyset_releases_version_get(version)
2434+
2435+
GET NeuroStore studyset release manifest
2436+
2437+
### Example
2438+
2439+
2440+
```python
2441+
import neurostore_sdk
2442+
from neurostore_sdk.rest import ApiException
2443+
from pprint import pprint
2444+
2445+
# Defining the host is optional and defaults to https://neurostore.org/api
2446+
# See configuration.py for a list of all supported configuration parameters.
2447+
configuration = neurostore_sdk.Configuration(
2448+
host = "https://neurostore.org/api"
2449+
)
2450+
2451+
2452+
# Enter a context with an instance of the API client
2453+
with neurostore_sdk.ApiClient(configuration) as api_client:
2454+
# Create an instance of the API class
2455+
api_instance = neurostore_sdk.StoreApi(api_client)
2456+
version = 'version_example' # str | nightly, latest, or a monthly release in YYYY-MM format.
2457+
2458+
try:
2459+
# GET NeuroStore studyset release manifest
2460+
api_response = api_instance.neurostore_studyset_releases_version_get(version)
2461+
print("The response of StoreApi->neurostore_studyset_releases_version_get:\n")
2462+
pprint(api_response)
2463+
except Exception as e:
2464+
print("Exception when calling StoreApi->neurostore_studyset_releases_version_get: %s\n" % e)
2465+
```
2466+
2467+
2468+
2469+
### Parameters
2470+
2471+
2472+
Name | Type | Description | Notes
2473+
------------- | ------------- | ------------- | -------------
2474+
**version** | **str**| nightly, latest, or a monthly release in YYYY-MM format. |
2475+
2476+
### Return type
2477+
2478+
**object**
2479+
2480+
### Authorization
2481+
2482+
No authorization required
2483+
2484+
### HTTP request headers
2485+
2486+
- **Content-Type**: Not defined
2487+
- **Accept**: application/json
2488+
2489+
### HTTP response details
2490+
2491+
| Status code | Description | Response headers |
2492+
|-------------|-------------|------------------|
2493+
**200** | OK | - |
2494+
**404** | Not Found | - |
2495+
2496+
[[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)
2497+
23012498
# **pipeline_configs_get**
23022499
> PipelineConfigList pipeline_configs_get(pipeline=pipeline, paginate=paginate, has_embeddings=has_embeddings, embedding_dimensions=embedding_dimensions)
23032500

‎neurostore_sdk/__init__.py‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919

2020
# Define package exports
2121
__all__ = [
22-
"NeurostoreStudysetReleasesApi",
2322
"StoreApi",
2423
"ApiResponse",
2524
"ApiClient",
@@ -143,7 +142,6 @@
143142

144143
if __import__("typing").TYPE_CHECKING:
145144
# import apis into sdk package
146-
from neurostore_sdk.api.neurostore_studyset_releases_api import NeurostoreStudysetReleasesApi as NeurostoreStudysetReleasesApi
147145
from neurostore_sdk.api.store_api import StoreApi as StoreApi
148146

149147
# import ApiClient
@@ -277,7 +275,6 @@
277275
("__version__", __version__),
278276
("__all__", __all__),
279277
"""# import apis into sdk package
280-
from neurostore_sdk.api.neurostore_studyset_releases_api import NeurostoreStudysetReleasesApi as NeurostoreStudysetReleasesApi
281278
from neurostore_sdk.api.store_api import StoreApi as StoreApi
282279
283280
# import ApiClient

‎neurostore_sdk/api/__init__.py‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
if __import__("typing").TYPE_CHECKING:
44
# import apis into api package
5-
from neurostore_sdk.api.neurostore_studyset_releases_api import NeurostoreStudysetReleasesApi
65
from neurostore_sdk.api.store_api import StoreApi
76

87
else:
@@ -12,7 +11,6 @@
1211
LazyModule(
1312
*as_package(__file__),
1413
"""# import apis into api package
15-
from neurostore_sdk.api.neurostore_studyset_releases_api import NeurostoreStudysetReleasesApi
1614
from neurostore_sdk.api.store_api import StoreApi
1715
1816
""",

0 commit comments

Comments
 (0)