Skip to content

Commit 28fe10f

Browse files
5c243257de84690d757308d7d2a4ff6385a19d2e
1 parent 9ae1c9f commit 28fe10f

233 files changed

Lines changed: 1583 additions & 233 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.openapi-generator/FILES

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ docs/JsonLd.md
5454
docs/JsonLdContext.md
5555
docs/Metadata.md
5656
docs/NestedPutAttributes.md
57+
docs/NeurostoreStudysetReleasesGet200Response.md
58+
docs/NeurostoreStudysetReleasesGet200ResponseMetadata.md
5759
docs/NoteCollectionBase.md
5860
docs/NoteCollectionList.md
5961
docs/NoteCollectionRequest.md
@@ -171,6 +173,8 @@ neurostore_sdk/models/json_ld.py
171173
neurostore_sdk/models/json_ld_context.py
172174
neurostore_sdk/models/metadata.py
173175
neurostore_sdk/models/nested_put_attributes.py
176+
neurostore_sdk/models/neurostore_studyset_releases_get200_response.py
177+
neurostore_sdk/models/neurostore_studyset_releases_get200_response_metadata.py
174178
neurostore_sdk/models/note_collection_base.py
175179
neurostore_sdk/models/note_collection_list.py
176180
neurostore_sdk/models/note_collection_request.py
@@ -286,6 +290,8 @@ test/test_json_ld.py
286290
test/test_json_ld_context.py
287291
test/test_metadata.py
288292
test/test_nested_put_attributes.py
293+
test/test_neurostore_studyset_releases_get200_response.py
294+
test/test_neurostore_studyset_releases_get200_response_metadata.py
289295
test/test_note_collection_base.py
290296
test/test_note_collection_list.py
291297
test/test_note_collection_request.py

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ Create studysets for meta-analysis
33

44
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
55

6-
- API version: 1.1
7-
- Package version: 1.1
6+
- API version: 1.2
7+
- Package version: 1.2
88
- Generator version: 7.17.0
99
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
1010
For more information, please visit [https://github.com/jdkent](https://github.com/jdkent)
@@ -122,6 +122,9 @@ Class | Method | HTTP request | Description
122122
*StoreApi* | [**images_id_get**](docs/StoreApi.md#images_id_get) | **GET** /images/{id} | GET an image
123123
*StoreApi* | [**images_id_put**](docs/StoreApi.md#images_id_put) | **PUT** /images/{id} | PUT/update an image
124124
*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
125128
*StoreApi* | [**pipeline_configs_get**](docs/StoreApi.md#pipeline_configs_get) | **GET** /pipeline-configs/ | GET a list of pipeline configs
126129
*StoreApi* | [**pipeline_configs_id_delete**](docs/StoreApi.md#pipeline_configs_id_delete) | **DELETE** /pipeline-configs/{id} | DELETE a pipeline config by ID
127130
*StoreApi* | [**pipeline_configs_id_get**](docs/StoreApi.md#pipeline_configs_id_get) | **GET** /pipeline-configs/{id} | GET a pipeline config by ID
@@ -218,6 +221,8 @@ Class | Method | HTTP request | Description
218221
- [JsonLdContext](docs/JsonLdContext.md)
219222
- [Metadata](docs/Metadata.md)
220223
- [NestedPutAttributes](docs/NestedPutAttributes.md)
224+
- [NeurostoreStudysetReleasesGet200Response](docs/NeurostoreStudysetReleasesGet200Response.md)
225+
- [NeurostoreStudysetReleasesGet200ResponseMetadata](docs/NeurostoreStudysetReleasesGet200ResponseMetadata.md)
221226
- [NoteCollectionBase](docs/NoteCollectionBase.md)
222227
- [NoteCollectionList](docs/NoteCollectionList.md)
223228
- [NoteCollectionRequest](docs/NoteCollectionRequest.md)
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# NeurostoreStudysetReleasesGet200Response
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**metadata** | [**NeurostoreStudysetReleasesGet200ResponseMetadata**](NeurostoreStudysetReleasesGet200ResponseMetadata.md) | | [optional]
9+
**results** | **List[object]** | | [optional]
10+
11+
## Example
12+
13+
```python
14+
from neurostore_sdk.models.neurostore_studyset_releases_get200_response import NeurostoreStudysetReleasesGet200Response
15+
16+
# TODO update the JSON string below
17+
json = "{}"
18+
# create an instance of NeurostoreStudysetReleasesGet200Response from a JSON string
19+
neurostore_studyset_releases_get200_response_instance = NeurostoreStudysetReleasesGet200Response.from_json(json)
20+
# print the JSON string representation of the object
21+
print(NeurostoreStudysetReleasesGet200Response.to_json())
22+
23+
# convert the object into a dict
24+
neurostore_studyset_releases_get200_response_dict = neurostore_studyset_releases_get200_response_instance.to_dict()
25+
# create an instance of NeurostoreStudysetReleasesGet200Response from a dict
26+
neurostore_studyset_releases_get200_response_from_dict = NeurostoreStudysetReleasesGet200Response.from_dict(neurostore_studyset_releases_get200_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+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# NeurostoreStudysetReleasesGet200ResponseMetadata
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_studyset_releases_get200_response_metadata import NeurostoreStudysetReleasesGet200ResponseMetadata
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of NeurostoreStudysetReleasesGet200ResponseMetadata from a JSON string
18+
neurostore_studyset_releases_get200_response_metadata_instance = NeurostoreStudysetReleasesGet200ResponseMetadata.from_json(json)
19+
# print the JSON string representation of the object
20+
print(NeurostoreStudysetReleasesGet200ResponseMetadata.to_json())
21+
22+
# convert the object into a dict
23+
neurostore_studyset_releases_get200_response_metadata_dict = neurostore_studyset_releases_get200_response_metadata_instance.to_dict()
24+
# create an instance of NeurostoreStudysetReleasesGet200ResponseMetadata from a dict
25+
neurostore_studyset_releases_get200_response_metadata_from_dict = NeurostoreStudysetReleasesGet200ResponseMetadata.from_dict(neurostore_studyset_releases_get200_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/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: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
88
Create studysets for meta-analysis
99
10-
The version of the OpenAPI document: 1.1
10+
The version of the OpenAPI document: 1.2
1111
Contact: jamesdkent21@gmail.com
1212
Generated by OpenAPI Generator (https://openapi-generator.tech)
1313
1414
Do not edit the class manually.
1515
""" # noqa: E501
1616

1717

18-
__version__ = "1.1"
18+
__version__ = "1.2"
1919

2020
# Define package exports
2121
__all__ = [
@@ -80,6 +80,8 @@
8080
"JsonLdContext",
8181
"Metadata",
8282
"NestedPutAttributes",
83+
"NeurostoreStudysetReleasesGet200Response",
84+
"NeurostoreStudysetReleasesGet200ResponseMetadata",
8385
"NoteCollectionBase",
8486
"NoteCollectionList",
8587
"NoteCollectionRequest",
@@ -205,6 +207,8 @@
205207
from neurostore_sdk.models.json_ld_context import JsonLdContext as JsonLdContext
206208
from neurostore_sdk.models.metadata import Metadata as Metadata
207209
from neurostore_sdk.models.nested_put_attributes import NestedPutAttributes as NestedPutAttributes
210+
from neurostore_sdk.models.neurostore_studyset_releases_get200_response import NeurostoreStudysetReleasesGet200Response as NeurostoreStudysetReleasesGet200Response
211+
from neurostore_sdk.models.neurostore_studyset_releases_get200_response_metadata import NeurostoreStudysetReleasesGet200ResponseMetadata as NeurostoreStudysetReleasesGet200ResponseMetadata
208212
from neurostore_sdk.models.note_collection_base import NoteCollectionBase as NoteCollectionBase
209213
from neurostore_sdk.models.note_collection_list import NoteCollectionList as NoteCollectionList
210214
from neurostore_sdk.models.note_collection_request import NoteCollectionRequest as NoteCollectionRequest
@@ -336,6 +340,8 @@
336340
from neurostore_sdk.models.json_ld_context import JsonLdContext as JsonLdContext
337341
from neurostore_sdk.models.metadata import Metadata as Metadata
338342
from neurostore_sdk.models.nested_put_attributes import NestedPutAttributes as NestedPutAttributes
343+
from neurostore_sdk.models.neurostore_studyset_releases_get200_response import NeurostoreStudysetReleasesGet200Response as NeurostoreStudysetReleasesGet200Response
344+
from neurostore_sdk.models.neurostore_studyset_releases_get200_response_metadata import NeurostoreStudysetReleasesGet200ResponseMetadata as NeurostoreStudysetReleasesGet200ResponseMetadata
339345
from neurostore_sdk.models.note_collection_base import NoteCollectionBase as NoteCollectionBase
340346
from neurostore_sdk.models.note_collection_list import NoteCollectionList as NoteCollectionList
341347
from neurostore_sdk.models.note_collection_request import NoteCollectionRequest as NoteCollectionRequest

0 commit comments

Comments
 (0)