Skip to content

Commit 636bcb7

Browse files
github-actions[bot]github-actions[bot]
committed
347792a0e53ad023adabfc7f21c134106029dca0
1 parent 46a05e5 commit 636bcb7

20 files changed

+4300
-137
lines changed

‎.openapi-generator/FILES

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ docs/ConditionList.md
4343
docs/ConditionRequest.md
4444
docs/ConditionReturn.md
4545
docs/ConditionsApi.md
46-
docs/DefaultApi.md
4746
docs/Entity.md
4847
docs/ImageBase.md
4948
docs/ImageCommon.md
@@ -57,6 +56,7 @@ docs/JsonLdContext.md
5756
docs/Metadata.md
5857
docs/NestedPutAttributes.md
5958
docs/NoteCollectionBase.md
59+
docs/NoteCollectionList.md
6060
docs/NoteCollectionRequest.md
6161
docs/NoteCollectionReturn.md
6262
docs/NoteCollectionReturnAllOf.md
@@ -108,7 +108,6 @@ neurostore_sdk/api/__init__.py
108108
neurostore_sdk/api/analyses_api.py
109109
neurostore_sdk/api/annotations_api.py
110110
neurostore_sdk/api/conditions_api.py
111-
neurostore_sdk/api/default_api.py
112111
neurostore_sdk/api/images_api.py
113112
neurostore_sdk/api/points_api.py
114113
neurostore_sdk/api/store_api.py
@@ -169,6 +168,7 @@ neurostore_sdk/models/json_ld_context.py
169168
neurostore_sdk/models/metadata.py
170169
neurostore_sdk/models/nested_put_attributes.py
171170
neurostore_sdk/models/note_collection_base.py
171+
neurostore_sdk/models/note_collection_list.py
172172
neurostore_sdk/models/note_collection_request.py
173173
neurostore_sdk/models/note_collection_return.py
174174
neurostore_sdk/models/note_collection_return_all_of.py
@@ -216,5 +216,5 @@ setup.cfg
216216
setup.py
217217
test-requirements.txt
218218
test/__init__.py
219-
test/test_study_request_all_of.py
219+
test/test_note_collection_list.py
220220
tox.ini

‎README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,12 @@ Class | Method | HTTP request | Description
9898
*AnalysesApi* | [**analyses_id_get**](docs/AnalysesApi.md#analyses_id_get) | **GET** /analyses/{id} | GET an analysis
9999
*AnalysesApi* | [**analyses_id_put**](docs/AnalysesApi.md#analyses_id_put) | **PUT** /analyses/{id} | PUT/update an analysis
100100
*AnalysesApi* | [**analyses_post**](docs/AnalysesApi.md#analyses_post) | **POST** /analyses/ | POST/create an analysis
101+
*AnalysesApi* | [**annotation_analyses_get**](docs/AnalysesApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
102+
*AnalysesApi* | [**annotation_analyses_id_get**](docs/AnalysesApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
103+
*AnalysesApi* | [**annotation_analyses_id_put**](docs/AnalysesApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
104+
*AnnotationsApi* | [**annotation_analyses_get**](docs/AnnotationsApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
105+
*AnnotationsApi* | [**annotation_analyses_id_get**](docs/AnnotationsApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
106+
*AnnotationsApi* | [**annotation_analyses_id_put**](docs/AnnotationsApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
101107
*AnnotationsApi* | [**annotations_get**](docs/AnnotationsApi.md#annotations_get) | **GET** /annotations/ | Your GET endpoint
102108
*AnnotationsApi* | [**annotations_id_delete**](docs/AnnotationsApi.md#annotations_id_delete) | **DELETE** /annotations/{id} | DELETE an annotation
103109
*AnnotationsApi* | [**annotations_id_get**](docs/AnnotationsApi.md#annotations_id_get) | **GET** /annotations/{id} | Your GET endpoint
@@ -108,10 +114,6 @@ Class | Method | HTTP request | Description
108114
*ConditionsApi* | [**conditions_id_get**](docs/ConditionsApi.md#conditions_id_get) | **GET** /conditions/{id} | GET a condition
109115
*ConditionsApi* | [**conditions_id_put**](docs/ConditionsApi.md#conditions_id_put) | **PUT** /conditions/{id} | PUT/update a condition
110116
*ConditionsApi* | [**conditions_post**](docs/ConditionsApi.md#conditions_post) | **POST** /conditions/ | POST/Create a condition
111-
*DefaultApi* | [**base_studies_get**](docs/DefaultApi.md#base_studies_get) | **GET** /base-studies/ |
112-
*DefaultApi* | [**base_studies_id_get**](docs/DefaultApi.md#base_studies_id_get) | **GET** /base-studies/{id} | Your GET endpoint
113-
*DefaultApi* | [**base_studies_id_put**](docs/DefaultApi.md#base_studies_id_put) | **PUT** /base-studies/{id} |
114-
*DefaultApi* | [**base_studies_post**](docs/DefaultApi.md#base_studies_post) | **POST** /base-studies/ |
115117
*ImagesApi* | [**images_get**](docs/ImagesApi.md#images_get) | **GET** /images/ | GET a list of images
116118
*ImagesApi* | [**images_id_delete**](docs/ImagesApi.md#images_id_delete) | **DELETE** /images/{id} | DELETE an image
117119
*ImagesApi* | [**images_id_get**](docs/ImagesApi.md#images_id_get) | **GET** /images/{id} | GET an image
@@ -127,11 +129,18 @@ Class | Method | HTTP request | Description
127129
*StoreApi* | [**analyses_id_get**](docs/StoreApi.md#analyses_id_get) | **GET** /analyses/{id} | GET an analysis
128130
*StoreApi* | [**analyses_id_put**](docs/StoreApi.md#analyses_id_put) | **PUT** /analyses/{id} | PUT/update an analysis
129131
*StoreApi* | [**analyses_post**](docs/StoreApi.md#analyses_post) | **POST** /analyses/ | POST/create an analysis
132+
*StoreApi* | [**annotation_analyses_get**](docs/StoreApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
133+
*StoreApi* | [**annotation_analyses_id_get**](docs/StoreApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
134+
*StoreApi* | [**annotation_analyses_id_put**](docs/StoreApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
130135
*StoreApi* | [**annotations_get**](docs/StoreApi.md#annotations_get) | **GET** /annotations/ | Your GET endpoint
131136
*StoreApi* | [**annotations_id_delete**](docs/StoreApi.md#annotations_id_delete) | **DELETE** /annotations/{id} | DELETE an annotation
132137
*StoreApi* | [**annotations_id_get**](docs/StoreApi.md#annotations_id_get) | **GET** /annotations/{id} | Your GET endpoint
133138
*StoreApi* | [**annotations_id_put**](docs/StoreApi.md#annotations_id_put) | **PUT** /annotations/{id} | Update an annotation
134139
*StoreApi* | [**annotations_post**](docs/StoreApi.md#annotations_post) | **POST** /annotations/ | Post Annotation
140+
*StoreApi* | [**base_studies_get**](docs/StoreApi.md#base_studies_get) | **GET** /base-studies/ |
141+
*StoreApi* | [**base_studies_id_get**](docs/StoreApi.md#base_studies_id_get) | **GET** /base-studies/{id} | Your GET endpoint
142+
*StoreApi* | [**base_studies_id_put**](docs/StoreApi.md#base_studies_id_put) | **PUT** /base-studies/{id} |
143+
*StoreApi* | [**base_studies_post**](docs/StoreApi.md#base_studies_post) | **POST** /base-studies/ |
135144
*StoreApi* | [**conditions_get**](docs/StoreApi.md#conditions_get) | **GET** /conditions/ | GET Conditions
136145
*StoreApi* | [**conditions_id_delete**](docs/StoreApi.md#conditions_id_delete) | **DELETE** /conditions/{id} | DELETE a condition
137146
*StoreApi* | [**conditions_id_get**](docs/StoreApi.md#conditions_id_get) | **GET** /conditions/{id} | GET a condition
@@ -156,6 +165,10 @@ Class | Method | HTTP request | Description
156165
*StoreApi* | [**studysets_id_get**](docs/StoreApi.md#studysets_id_get) | **GET** /studysets/{id} | GET a studyset
157166
*StoreApi* | [**studysets_id_put**](docs/StoreApi.md#studysets_id_put) | **PUT** /studysets/{id} | PUT/update a studyset
158167
*StoreApi* | [**studysets_post**](docs/StoreApi.md#studysets_post) | **POST** /studysets/ | POST/create a studyset
168+
*StudiesApi* | [**base_studies_get**](docs/StudiesApi.md#base_studies_get) | **GET** /base-studies/ |
169+
*StudiesApi* | [**base_studies_id_get**](docs/StudiesApi.md#base_studies_id_get) | **GET** /base-studies/{id} | Your GET endpoint
170+
*StudiesApi* | [**base_studies_id_put**](docs/StudiesApi.md#base_studies_id_put) | **PUT** /base-studies/{id} |
171+
*StudiesApi* | [**base_studies_post**](docs/StudiesApi.md#base_studies_post) | **POST** /base-studies/ |
159172
*StudiesApi* | [**studies_get**](docs/StudiesApi.md#studies_get) | **GET** /studies/ | GET a list of studies
160173
*StudiesApi* | [**studies_id_delete**](docs/StudiesApi.md#studies_id_delete) | **DELETE** /studies/{id} | DELETE a study
161174
*StudiesApi* | [**studies_id_get**](docs/StudiesApi.md#studies_id_get) | **GET** /studies/{id} | GET a study
@@ -223,6 +236,7 @@ Class | Method | HTTP request | Description
223236
- [Metadata](docs/Metadata.md)
224237
- [NestedPutAttributes](docs/NestedPutAttributes.md)
225238
- [NoteCollectionBase](docs/NoteCollectionBase.md)
239+
- [NoteCollectionList](docs/NoteCollectionList.md)
226240
- [NoteCollectionRequest](docs/NoteCollectionRequest.md)
227241
- [NoteCollectionReturn](docs/NoteCollectionReturn.md)
228242
- [NoteCollectionReturnAllOf](docs/NoteCollectionReturnAllOf.md)

‎docs/AnalysesApi.md

Lines changed: 215 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ Method | HTTP request | Description
99
[**analyses_id_get**](AnalysesApi.md#analyses_id_get) | **GET** /analyses/{id} | GET an analysis
1010
[**analyses_id_put**](AnalysesApi.md#analyses_id_put) | **PUT** /analyses/{id} | PUT/update an analysis
1111
[**analyses_post**](AnalysesApi.md#analyses_post) | **POST** /analyses/ | POST/create an analysis
12+
[**annotation_analyses_get**](AnalysesApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
13+
[**annotation_analyses_id_get**](AnalysesApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
14+
[**annotation_analyses_id_put**](AnalysesApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
1215

1316

1417
# **analyses_get**
@@ -390,3 +393,215 @@ Name | Type | Description | Notes
390393

391394
[[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)
392395

396+
# **annotation_analyses_get**
397+
> NoteCollectionList annotation_analyses_get()
398+
399+
Get annotation analyses
400+
401+
### Example
402+
403+
```python
404+
import time
405+
import os
406+
import neurostore_sdk
407+
from neurostore_sdk.models.note_collection_list import NoteCollectionList
408+
from neurostore_sdk.rest import ApiException
409+
from pprint import pprint
410+
411+
# Defining the host is optional and defaults to https://neurostore.org/api
412+
# See configuration.py for a list of all supported configuration parameters.
413+
configuration = neurostore_sdk.Configuration(
414+
host = "https://neurostore.org/api"
415+
)
416+
417+
418+
# Enter a context with an instance of the API client
419+
with neurostore_sdk.ApiClient(configuration) as api_client:
420+
# Create an instance of the API class
421+
api_instance = neurostore_sdk.AnalysesApi(api_client)
422+
423+
try:
424+
# Get annotation analyses
425+
api_response = api_instance.annotation_analyses_get()
426+
print("The response of AnalysesApi->annotation_analyses_get:\n")
427+
pprint(api_response)
428+
except Exception as e:
429+
print("Exception when calling AnalysesApi->annotation_analyses_get: %s\n" % e)
430+
```
431+
432+
433+
### Parameters
434+
This endpoint does not need any parameter.
435+
436+
### Return type
437+
438+
[**NoteCollectionList**](NoteCollectionList.md)
439+
440+
### Authorization
441+
442+
No authorization required
443+
444+
### HTTP request headers
445+
446+
- **Content-Type**: Not defined
447+
- **Accept**: application/json
448+
449+
### HTTP response details
450+
| Status code | Description | Response headers |
451+
|-------------|-------------|------------------|
452+
**200** | OK | - |
453+
**2XX** | Success | - |
454+
455+
[[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)
456+
457+
# **annotation_analyses_id_get**
458+
> NoteCollectionReturn annotation_analyses_id_get(id)
459+
460+
Your GET endpoint
461+
462+
### Example
463+
464+
* Bearer Authentication (JSON-Web-Token):
465+
```python
466+
import time
467+
import os
468+
import neurostore_sdk
469+
from neurostore_sdk.models.note_collection_return import NoteCollectionReturn
470+
from neurostore_sdk.rest import ApiException
471+
from pprint import pprint
472+
473+
# Defining the host is optional and defaults to https://neurostore.org/api
474+
# See configuration.py for a list of all supported configuration parameters.
475+
configuration = neurostore_sdk.Configuration(
476+
host = "https://neurostore.org/api"
477+
)
478+
479+
# The client must configure the authentication and authorization parameters
480+
# in accordance with the API server security policy.
481+
# Examples for each auth method are provided below, use the example that
482+
# satisfies your auth use case.
483+
484+
# Configure Bearer authorization: JSON-Web-Token
485+
configuration = neurostore_sdk.Configuration(
486+
access_token = os.environ["BEARER_TOKEN"]
487+
)
488+
489+
# Enter a context with an instance of the API client
490+
with neurostore_sdk.ApiClient(configuration) as api_client:
491+
# Create an instance of the API class
492+
api_instance = neurostore_sdk.AnalysesApi(api_client)
493+
id = 'id_example' # str |
494+
495+
try:
496+
# Your GET endpoint
497+
api_response = api_instance.annotation_analyses_id_get(id)
498+
print("The response of AnalysesApi->annotation_analyses_id_get:\n")
499+
pprint(api_response)
500+
except Exception as e:
501+
print("Exception when calling AnalysesApi->annotation_analyses_id_get: %s\n" % e)
502+
```
503+
504+
505+
### Parameters
506+
507+
Name | Type | Description | Notes
508+
------------- | ------------- | ------------- | -------------
509+
**id** | **str**| |
510+
511+
### Return type
512+
513+
[**NoteCollectionReturn**](NoteCollectionReturn.md)
514+
515+
### Authorization
516+
517+
[JSON-Web-Token](../README.md#JSON-Web-Token)
518+
519+
### HTTP request headers
520+
521+
- **Content-Type**: Not defined
522+
- **Accept**: application/json
523+
524+
### HTTP response details
525+
| Status code | Description | Response headers |
526+
|-------------|-------------|------------------|
527+
**200** | OK | - |
528+
529+
[[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)
530+
531+
# **annotation_analyses_id_put**
532+
> NoteCollectionReturn annotation_analyses_id_put(id, note_collection_request=note_collection_request)
533+
534+
Your PUT endpoint
535+
536+
### Example
537+
538+
* Bearer Authentication (JSON-Web-Token):
539+
```python
540+
import time
541+
import os
542+
import neurostore_sdk
543+
from neurostore_sdk.models.note_collection_request import NoteCollectionRequest
544+
from neurostore_sdk.models.note_collection_return import NoteCollectionReturn
545+
from neurostore_sdk.rest import ApiException
546+
from pprint import pprint
547+
548+
# Defining the host is optional and defaults to https://neurostore.org/api
549+
# See configuration.py for a list of all supported configuration parameters.
550+
configuration = neurostore_sdk.Configuration(
551+
host = "https://neurostore.org/api"
552+
)
553+
554+
# The client must configure the authentication and authorization parameters
555+
# in accordance with the API server security policy.
556+
# Examples for each auth method are provided below, use the example that
557+
# satisfies your auth use case.
558+
559+
# Configure Bearer authorization: JSON-Web-Token
560+
configuration = neurostore_sdk.Configuration(
561+
access_token = os.environ["BEARER_TOKEN"]
562+
)
563+
564+
# Enter a context with an instance of the API client
565+
with neurostore_sdk.ApiClient(configuration) as api_client:
566+
# Create an instance of the API class
567+
api_instance = neurostore_sdk.AnalysesApi(api_client)
568+
id = 'id_example' # str |
569+
note_collection_request = neurostore_sdk.NoteCollectionRequest() # NoteCollectionRequest | (optional)
570+
571+
try:
572+
# Your PUT endpoint
573+
api_response = api_instance.annotation_analyses_id_put(id, note_collection_request=note_collection_request)
574+
print("The response of AnalysesApi->annotation_analyses_id_put:\n")
575+
pprint(api_response)
576+
except Exception as e:
577+
print("Exception when calling AnalysesApi->annotation_analyses_id_put: %s\n" % e)
578+
```
579+
580+
581+
### Parameters
582+
583+
Name | Type | Description | Notes
584+
------------- | ------------- | ------------- | -------------
585+
**id** | **str**| |
586+
**note_collection_request** | [**NoteCollectionRequest**](NoteCollectionRequest.md)| | [optional]
587+
588+
### Return type
589+
590+
[**NoteCollectionReturn**](NoteCollectionReturn.md)
591+
592+
### Authorization
593+
594+
[JSON-Web-Token](../README.md#JSON-Web-Token)
595+
596+
### HTTP request headers
597+
598+
- **Content-Type**: application/json
599+
- **Accept**: application/json
600+
601+
### HTTP response details
602+
| Status code | Description | Response headers |
603+
|-------------|-------------|------------------|
604+
**200** | OK | - |
605+
606+
[[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)
607+

0 commit comments

Comments
 (0)