347792a0e53ad023adabfc7f21c134106029dca0

neurostuff · Mar 13, 2024 · 636bcb7 · 636bcb7
1 parent 46a05e5
commit 636bcb7
Show file tree

Hide file tree

Showing 20 changed files with 4,300 additions and 137 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -43,7 +43,6 @@ docs/ConditionList.md
 docs/ConditionRequest.md
 docs/ConditionReturn.md
 docs/ConditionsApi.md
-docs/DefaultApi.md
 docs/Entity.md
 docs/ImageBase.md
 docs/ImageCommon.md
@@ -57,6 +56,7 @@ docs/JsonLdContext.md
 docs/Metadata.md
 docs/NestedPutAttributes.md
 docs/NoteCollectionBase.md
+docs/NoteCollectionList.md
 docs/NoteCollectionRequest.md
 docs/NoteCollectionReturn.md
 docs/NoteCollectionReturnAllOf.md
@@ -108,7 +108,6 @@ neurostore_sdk/api/__init__.py
 neurostore_sdk/api/analyses_api.py
 neurostore_sdk/api/annotations_api.py
 neurostore_sdk/api/conditions_api.py
-neurostore_sdk/api/default_api.py
 neurostore_sdk/api/images_api.py
 neurostore_sdk/api/points_api.py
 neurostore_sdk/api/store_api.py
@@ -169,6 +168,7 @@ neurostore_sdk/models/json_ld_context.py
 neurostore_sdk/models/metadata.py
 neurostore_sdk/models/nested_put_attributes.py
 neurostore_sdk/models/note_collection_base.py
+neurostore_sdk/models/note_collection_list.py
 neurostore_sdk/models/note_collection_request.py
 neurostore_sdk/models/note_collection_return.py
 neurostore_sdk/models/note_collection_return_all_of.py
@@ -216,5 +216,5 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
-test/test_study_request_all_of.py
+test/test_note_collection_list.py
 tox.ini
diff --git a/README.md b/README.md
@@ -98,6 +98,12 @@ Class | Method | HTTP request | Description
 *AnalysesApi* | [**analyses_id_get**](docs/AnalysesApi.md#analyses_id_get) | **GET** /analyses/{id} | GET an analysis
 *AnalysesApi* | [**analyses_id_put**](docs/AnalysesApi.md#analyses_id_put) | **PUT** /analyses/{id} | PUT/update an analysis
 *AnalysesApi* | [**analyses_post**](docs/AnalysesApi.md#analyses_post) | **POST** /analyses/ | POST/create an analysis
+*AnalysesApi* | [**annotation_analyses_get**](docs/AnalysesApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
+*AnalysesApi* | [**annotation_analyses_id_get**](docs/AnalysesApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
+*AnalysesApi* | [**annotation_analyses_id_put**](docs/AnalysesApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
+*AnnotationsApi* | [**annotation_analyses_get**](docs/AnnotationsApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
+*AnnotationsApi* | [**annotation_analyses_id_get**](docs/AnnotationsApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
+*AnnotationsApi* | [**annotation_analyses_id_put**](docs/AnnotationsApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
 *AnnotationsApi* | [**annotations_get**](docs/AnnotationsApi.md#annotations_get) | **GET** /annotations/ | Your GET endpoint
 *AnnotationsApi* | [**annotations_id_delete**](docs/AnnotationsApi.md#annotations_id_delete) | **DELETE** /annotations/{id} | DELETE an annotation
 *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
 *ConditionsApi* | [**conditions_id_get**](docs/ConditionsApi.md#conditions_id_get) | **GET** /conditions/{id} | GET a condition
 *ConditionsApi* | [**conditions_id_put**](docs/ConditionsApi.md#conditions_id_put) | **PUT** /conditions/{id} | PUT/update a condition
 *ConditionsApi* | [**conditions_post**](docs/ConditionsApi.md#conditions_post) | **POST** /conditions/ | POST/Create a condition
-*DefaultApi* | [**base_studies_get**](docs/DefaultApi.md#base_studies_get) | **GET** /base-studies/ | 
-*DefaultApi* | [**base_studies_id_get**](docs/DefaultApi.md#base_studies_id_get) | **GET** /base-studies/{id} | Your GET endpoint
-*DefaultApi* | [**base_studies_id_put**](docs/DefaultApi.md#base_studies_id_put) | **PUT** /base-studies/{id} | 
-*DefaultApi* | [**base_studies_post**](docs/DefaultApi.md#base_studies_post) | **POST** /base-studies/ | 
 *ImagesApi* | [**images_get**](docs/ImagesApi.md#images_get) | **GET** /images/ | GET a list of images
 *ImagesApi* | [**images_id_delete**](docs/ImagesApi.md#images_id_delete) | **DELETE** /images/{id} | DELETE an image
 *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
 *StoreApi* | [**analyses_id_get**](docs/StoreApi.md#analyses_id_get) | **GET** /analyses/{id} | GET an analysis
 *StoreApi* | [**analyses_id_put**](docs/StoreApi.md#analyses_id_put) | **PUT** /analyses/{id} | PUT/update an analysis
 *StoreApi* | [**analyses_post**](docs/StoreApi.md#analyses_post) | **POST** /analyses/ | POST/create an analysis
+*StoreApi* | [**annotation_analyses_get**](docs/StoreApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
+*StoreApi* | [**annotation_analyses_id_get**](docs/StoreApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
+*StoreApi* | [**annotation_analyses_id_put**](docs/StoreApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
 *StoreApi* | [**annotations_get**](docs/StoreApi.md#annotations_get) | **GET** /annotations/ | Your GET endpoint
 *StoreApi* | [**annotations_id_delete**](docs/StoreApi.md#annotations_id_delete) | **DELETE** /annotations/{id} | DELETE an annotation
 *StoreApi* | [**annotations_id_get**](docs/StoreApi.md#annotations_id_get) | **GET** /annotations/{id} | Your GET endpoint
 *StoreApi* | [**annotations_id_put**](docs/StoreApi.md#annotations_id_put) | **PUT** /annotations/{id} | Update an annotation
 *StoreApi* | [**annotations_post**](docs/StoreApi.md#annotations_post) | **POST** /annotations/ | Post Annotation
+*StoreApi* | [**base_studies_get**](docs/StoreApi.md#base_studies_get) | **GET** /base-studies/ | 
+*StoreApi* | [**base_studies_id_get**](docs/StoreApi.md#base_studies_id_get) | **GET** /base-studies/{id} | Your GET endpoint
+*StoreApi* | [**base_studies_id_put**](docs/StoreApi.md#base_studies_id_put) | **PUT** /base-studies/{id} | 
+*StoreApi* | [**base_studies_post**](docs/StoreApi.md#base_studies_post) | **POST** /base-studies/ | 
 *StoreApi* | [**conditions_get**](docs/StoreApi.md#conditions_get) | **GET** /conditions/ | GET Conditions
 *StoreApi* | [**conditions_id_delete**](docs/StoreApi.md#conditions_id_delete) | **DELETE** /conditions/{id} | DELETE a condition
 *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
 *StoreApi* | [**studysets_id_get**](docs/StoreApi.md#studysets_id_get) | **GET** /studysets/{id} | GET a studyset
 *StoreApi* | [**studysets_id_put**](docs/StoreApi.md#studysets_id_put) | **PUT** /studysets/{id} | PUT/update a studyset
 *StoreApi* | [**studysets_post**](docs/StoreApi.md#studysets_post) | **POST** /studysets/ | POST/create a studyset
+*StudiesApi* | [**base_studies_get**](docs/StudiesApi.md#base_studies_get) | **GET** /base-studies/ | 
+*StudiesApi* | [**base_studies_id_get**](docs/StudiesApi.md#base_studies_id_get) | **GET** /base-studies/{id} | Your GET endpoint
+*StudiesApi* | [**base_studies_id_put**](docs/StudiesApi.md#base_studies_id_put) | **PUT** /base-studies/{id} | 
+*StudiesApi* | [**base_studies_post**](docs/StudiesApi.md#base_studies_post) | **POST** /base-studies/ | 
 *StudiesApi* | [**studies_get**](docs/StudiesApi.md#studies_get) | **GET** /studies/ | GET a list of studies
 *StudiesApi* | [**studies_id_delete**](docs/StudiesApi.md#studies_id_delete) | **DELETE** /studies/{id} | DELETE a study
 *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
  - [Metadata](docs/Metadata.md)
  - [NestedPutAttributes](docs/NestedPutAttributes.md)
  - [NoteCollectionBase](docs/NoteCollectionBase.md)
+ - [NoteCollectionList](docs/NoteCollectionList.md)
  - [NoteCollectionRequest](docs/NoteCollectionRequest.md)
  - [NoteCollectionReturn](docs/NoteCollectionReturn.md)
  - [NoteCollectionReturnAllOf](docs/NoteCollectionReturnAllOf.md)

diff --git a/docs/AnalysesApi.md b/docs/AnalysesApi.md
@@ -9,6 +9,9 @@ Method | HTTP request | Description
 [**analyses_id_get**](AnalysesApi.md#analyses_id_get) | **GET** /analyses/{id} | GET an analysis
 [**analyses_id_put**](AnalysesApi.md#analyses_id_put) | **PUT** /analyses/{id} | PUT/update an analysis
 [**analyses_post**](AnalysesApi.md#analyses_post) | **POST** /analyses/ | POST/create an analysis
+[**annotation_analyses_get**](AnalysesApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
+[**annotation_analyses_id_get**](AnalysesApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
+[**annotation_analyses_id_put**](AnalysesApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
 
 
 # **analyses_get**
@@ -390,3 +393,215 @@ Name | Type | Description  | Notes
 
 [[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)
 
+# **annotation_analyses_get**
+> NoteCollectionList annotation_analyses_get()
+
+Get annotation analyses
+
+### Example
+
+```python
+import time
+import os
+import neurostore_sdk
+from neurostore_sdk.models.note_collection_list import NoteCollectionList
+from neurostore_sdk.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://neurostore.org/api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = neurostore_sdk.Configuration(
+    host = "https://neurostore.org/api"
+)
+
+
+# Enter a context with an instance of the API client
+with neurostore_sdk.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = neurostore_sdk.AnalysesApi(api_client)
+
+    try:
+        # Get annotation analyses
+        api_response = api_instance.annotation_analyses_get()
+        print("The response of AnalysesApi->annotation_analyses_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling AnalysesApi->annotation_analyses_get: %s\n" % e)
+```
+
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**NoteCollectionList**](NoteCollectionList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+**2XX** | Success |  -  |
+
+[[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)
+
+# **annotation_analyses_id_get**
+> NoteCollectionReturn annotation_analyses_id_get(id)
+
+Your GET endpoint
+
+### Example
+
+* Bearer Authentication (JSON-Web-Token):
+```python
+import time
+import os
+import neurostore_sdk
+from neurostore_sdk.models.note_collection_return import NoteCollectionReturn
+from neurostore_sdk.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://neurostore.org/api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = neurostore_sdk.Configuration(
+    host = "https://neurostore.org/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization: JSON-Web-Token
+configuration = neurostore_sdk.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with neurostore_sdk.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = neurostore_sdk.AnalysesApi(api_client)
+    id = 'id_example' # str | 
+
+    try:
+        # Your GET endpoint
+        api_response = api_instance.annotation_analyses_id_get(id)
+        print("The response of AnalysesApi->annotation_analyses_id_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling AnalysesApi->annotation_analyses_id_get: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **str**|  | 
+
+### Return type
+
+[**NoteCollectionReturn**](NoteCollectionReturn.md)
+
+### Authorization
+
+[JSON-Web-Token](../README.md#JSON-Web-Token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[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)
+
+# **annotation_analyses_id_put**
+> NoteCollectionReturn annotation_analyses_id_put(id, note_collection_request=note_collection_request)
+
+Your PUT endpoint
+
+### Example
+
+* Bearer Authentication (JSON-Web-Token):
+```python
+import time
+import os
+import neurostore_sdk
+from neurostore_sdk.models.note_collection_request import NoteCollectionRequest
+from neurostore_sdk.models.note_collection_return import NoteCollectionReturn
+from neurostore_sdk.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://neurostore.org/api
+# See configuration.py for a list of all supported configuration parameters.
+configuration = neurostore_sdk.Configuration(
+    host = "https://neurostore.org/api"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization: JSON-Web-Token
+configuration = neurostore_sdk.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with neurostore_sdk.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = neurostore_sdk.AnalysesApi(api_client)
+    id = 'id_example' # str | 
+    note_collection_request = neurostore_sdk.NoteCollectionRequest() # NoteCollectionRequest |  (optional)
+
+    try:
+        # Your PUT endpoint
+        api_response = api_instance.annotation_analyses_id_put(id, note_collection_request=note_collection_request)
+        print("The response of AnalysesApi->annotation_analyses_id_put:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling AnalysesApi->annotation_analyses_id_put: %s\n" % e)
+```
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **str**|  | 
+ **note_collection_request** | [**NoteCollectionRequest**](NoteCollectionRequest.md)|  | [optional] 
+
+### Return type
+
+[**NoteCollectionReturn**](NoteCollectionReturn.md)
+
+### Authorization
+
+[JSON-Web-Token](../README.md#JSON-Web-Token)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK |  -  |
+
+[[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)
+