Skip to content

Commit 5484741

Browse files
github-actions[bot]github-actions[bot]
committed
a51e7db15639eaf8529a9843253ccef284e9a0a1
1 parent 8a7a834 commit 5484741

File tree

7 files changed

+681
-6
lines changed

7 files changed

+681
-6
lines changed

‎README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,11 @@ Class | Method | HTTP request | Description
101101
*AnalysesApi* | [**annotation_analyses_get**](docs/AnalysesApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
102102
*AnalysesApi* | [**annotation_analyses_id_get**](docs/AnalysesApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
103103
*AnalysesApi* | [**annotation_analyses_id_put**](docs/AnalysesApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
104+
*AnalysesApi* | [**annotation_analyses_post**](docs/AnalysesApi.md#annotation_analyses_post) | **POST** /annotation-analyses/ | Your POST endpoint
104105
*AnnotationsApi* | [**annotation_analyses_get**](docs/AnnotationsApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
105106
*AnnotationsApi* | [**annotation_analyses_id_get**](docs/AnnotationsApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
106107
*AnnotationsApi* | [**annotation_analyses_id_put**](docs/AnnotationsApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
108+
*AnnotationsApi* | [**annotation_analyses_post**](docs/AnnotationsApi.md#annotation_analyses_post) | **POST** /annotation-analyses/ | Your POST endpoint
107109
*AnnotationsApi* | [**annotations_get**](docs/AnnotationsApi.md#annotations_get) | **GET** /annotations/ | Your GET endpoint
108110
*AnnotationsApi* | [**annotations_id_delete**](docs/AnnotationsApi.md#annotations_id_delete) | **DELETE** /annotations/{id} | DELETE an annotation
109111
*AnnotationsApi* | [**annotations_id_get**](docs/AnnotationsApi.md#annotations_id_get) | **GET** /annotations/{id} | Your GET endpoint
@@ -132,6 +134,7 @@ Class | Method | HTTP request | Description
132134
*StoreApi* | [**annotation_analyses_get**](docs/StoreApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
133135
*StoreApi* | [**annotation_analyses_id_get**](docs/StoreApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
134136
*StoreApi* | [**annotation_analyses_id_put**](docs/StoreApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
137+
*StoreApi* | [**annotation_analyses_post**](docs/StoreApi.md#annotation_analyses_post) | **POST** /annotation-analyses/ | Your POST endpoint
135138
*StoreApi* | [**annotations_get**](docs/StoreApi.md#annotations_get) | **GET** /annotations/ | Your GET endpoint
136139
*StoreApi* | [**annotations_id_delete**](docs/StoreApi.md#annotations_id_delete) | **DELETE** /annotations/{id} | DELETE an annotation
137140
*StoreApi* | [**annotations_id_get**](docs/StoreApi.md#annotations_id_get) | **GET** /annotations/{id} | Your GET endpoint

‎docs/AnalysesApi.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Method | HTTP request | Description
1212
[**annotation_analyses_get**](AnalysesApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
1313
[**annotation_analyses_id_get**](AnalysesApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
1414
[**annotation_analyses_id_put**](AnalysesApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
15+
[**annotation_analyses_post**](AnalysesApi.md#annotation_analyses_post) | **POST** /annotation-analyses/ | Your POST endpoint
1516

1617

1718
# **analyses_get**
@@ -605,3 +606,80 @@ Name | Type | Description | Notes
605606

606607
[[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)
607608

609+
# **annotation_analyses_post**
610+
> List[NoteCollectionReturn] annotation_analyses_post(note_collection_request=note_collection_request)
611+
612+
Your POST endpoint
613+
614+
This endpoint does not allow for creation, only modification of existing annotation-analyses. If you wish to create an annotation-analysis, post to the annotations endpoint and/or add the analysis to the appropriate study in the studyset, and the annotation-analysis will be created automatically.
615+
616+
### Example
617+
618+
* Bearer Authentication (JSON-Web-Token):
619+
```python
620+
import time
621+
import os
622+
import neurostore_sdk
623+
from neurostore_sdk.models.note_collection_request import NoteCollectionRequest
624+
from neurostore_sdk.models.note_collection_return import NoteCollectionReturn
625+
from neurostore_sdk.rest import ApiException
626+
from pprint import pprint
627+
628+
# Defining the host is optional and defaults to https://neurostore.org/api
629+
# See configuration.py for a list of all supported configuration parameters.
630+
configuration = neurostore_sdk.Configuration(
631+
host = "https://neurostore.org/api"
632+
)
633+
634+
# The client must configure the authentication and authorization parameters
635+
# in accordance with the API server security policy.
636+
# Examples for each auth method are provided below, use the example that
637+
# satisfies your auth use case.
638+
639+
# Configure Bearer authorization: JSON-Web-Token
640+
configuration = neurostore_sdk.Configuration(
641+
access_token = os.environ["BEARER_TOKEN"]
642+
)
643+
644+
# Enter a context with an instance of the API client
645+
with neurostore_sdk.ApiClient(configuration) as api_client:
646+
# Create an instance of the API class
647+
api_instance = neurostore_sdk.AnalysesApi(api_client)
648+
note_collection_request = [neurostore_sdk.NoteCollectionRequest()] # List[NoteCollectionRequest] | (optional)
649+
650+
try:
651+
# Your POST endpoint
652+
api_response = api_instance.annotation_analyses_post(note_collection_request=note_collection_request)
653+
print("The response of AnalysesApi->annotation_analyses_post:\n")
654+
pprint(api_response)
655+
except Exception as e:
656+
print("Exception when calling AnalysesApi->annotation_analyses_post: %s\n" % e)
657+
```
658+
659+
660+
### Parameters
661+
662+
Name | Type | Description | Notes
663+
------------- | ------------- | ------------- | -------------
664+
**note_collection_request** | [**List[NoteCollectionRequest]**](NoteCollectionRequest.md)| | [optional]
665+
666+
### Return type
667+
668+
[**List[NoteCollectionReturn]**](NoteCollectionReturn.md)
669+
670+
### Authorization
671+
672+
[JSON-Web-Token](../README.md#JSON-Web-Token)
673+
674+
### HTTP request headers
675+
676+
- **Content-Type**: application/json
677+
- **Accept**: application/json
678+
679+
### HTTP response details
680+
| Status code | Description | Response headers |
681+
|-------------|-------------|------------------|
682+
**200** | OK | - |
683+
684+
[[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)
685+

‎docs/AnnotationsApi.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Method | HTTP request | Description
77
[**annotation_analyses_get**](AnnotationsApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
88
[**annotation_analyses_id_get**](AnnotationsApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
99
[**annotation_analyses_id_put**](AnnotationsApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
10+
[**annotation_analyses_post**](AnnotationsApi.md#annotation_analyses_post) | **POST** /annotation-analyses/ | Your POST endpoint
1011
[**annotations_get**](AnnotationsApi.md#annotations_get) | **GET** /annotations/ | Your GET endpoint
1112
[**annotations_id_delete**](AnnotationsApi.md#annotations_id_delete) | **DELETE** /annotations/{id} | DELETE an annotation
1213
[**annotations_id_get**](AnnotationsApi.md#annotations_id_get) | **GET** /annotations/{id} | Your GET endpoint
@@ -226,6 +227,83 @@ Name | Type | Description | Notes
226227

227228
[[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)
228229

230+
# **annotation_analyses_post**
231+
> List[NoteCollectionReturn] annotation_analyses_post(note_collection_request=note_collection_request)
232+
233+
Your POST endpoint
234+
235+
This endpoint does not allow for creation, only modification of existing annotation-analyses. If you wish to create an annotation-analysis, post to the annotations endpoint and/or add the analysis to the appropriate study in the studyset, and the annotation-analysis will be created automatically.
236+
237+
### Example
238+
239+
* Bearer Authentication (JSON-Web-Token):
240+
```python
241+
import time
242+
import os
243+
import neurostore_sdk
244+
from neurostore_sdk.models.note_collection_request import NoteCollectionRequest
245+
from neurostore_sdk.models.note_collection_return import NoteCollectionReturn
246+
from neurostore_sdk.rest import ApiException
247+
from pprint import pprint
248+
249+
# Defining the host is optional and defaults to https://neurostore.org/api
250+
# See configuration.py for a list of all supported configuration parameters.
251+
configuration = neurostore_sdk.Configuration(
252+
host = "https://neurostore.org/api"
253+
)
254+
255+
# The client must configure the authentication and authorization parameters
256+
# in accordance with the API server security policy.
257+
# Examples for each auth method are provided below, use the example that
258+
# satisfies your auth use case.
259+
260+
# Configure Bearer authorization: JSON-Web-Token
261+
configuration = neurostore_sdk.Configuration(
262+
access_token = os.environ["BEARER_TOKEN"]
263+
)
264+
265+
# Enter a context with an instance of the API client
266+
with neurostore_sdk.ApiClient(configuration) as api_client:
267+
# Create an instance of the API class
268+
api_instance = neurostore_sdk.AnnotationsApi(api_client)
269+
note_collection_request = [neurostore_sdk.NoteCollectionRequest()] # List[NoteCollectionRequest] | (optional)
270+
271+
try:
272+
# Your POST endpoint
273+
api_response = api_instance.annotation_analyses_post(note_collection_request=note_collection_request)
274+
print("The response of AnnotationsApi->annotation_analyses_post:\n")
275+
pprint(api_response)
276+
except Exception as e:
277+
print("Exception when calling AnnotationsApi->annotation_analyses_post: %s\n" % e)
278+
```
279+
280+
281+
### Parameters
282+
283+
Name | Type | Description | Notes
284+
------------- | ------------- | ------------- | -------------
285+
**note_collection_request** | [**List[NoteCollectionRequest]**](NoteCollectionRequest.md)| | [optional]
286+
287+
### Return type
288+
289+
[**List[NoteCollectionReturn]**](NoteCollectionReturn.md)
290+
291+
### Authorization
292+
293+
[JSON-Web-Token](../README.md#JSON-Web-Token)
294+
295+
### HTTP request headers
296+
297+
- **Content-Type**: application/json
298+
- **Accept**: application/json
299+
300+
### HTTP response details
301+
| Status code | Description | Response headers |
302+
|-------------|-------------|------------------|
303+
**200** | OK | - |
304+
305+
[[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)
306+
229307
# **annotations_get**
230308
> AnnotationList annotations_get(studyset_id=studyset_id)
231309

‎docs/StoreApi.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Method | HTTP request | Description
1212
[**annotation_analyses_get**](StoreApi.md#annotation_analyses_get) | **GET** /annotation-analyses/ | Get annotation analyses
1313
[**annotation_analyses_id_get**](StoreApi.md#annotation_analyses_id_get) | **GET** /annotation-analyses/{id} | Your GET endpoint
1414
[**annotation_analyses_id_put**](StoreApi.md#annotation_analyses_id_put) | **PUT** /annotation-analyses/{id} | Your PUT endpoint
15+
[**annotation_analyses_post**](StoreApi.md#annotation_analyses_post) | **POST** /annotation-analyses/ | Your POST endpoint
1516
[**annotations_get**](StoreApi.md#annotations_get) | **GET** /annotations/ | Your GET endpoint
1617
[**annotations_id_delete**](StoreApi.md#annotations_id_delete) | **DELETE** /annotations/{id} | DELETE an annotation
1718
[**annotations_id_get**](StoreApi.md#annotations_id_get) | **GET** /annotations/{id} | Your GET endpoint
@@ -638,6 +639,83 @@ Name | Type | Description | Notes
638639

639640
[[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)
640641

642+
# **annotation_analyses_post**
643+
> List[NoteCollectionReturn] annotation_analyses_post(note_collection_request=note_collection_request)
644+
645+
Your POST endpoint
646+
647+
This endpoint does not allow for creation, only modification of existing annotation-analyses. If you wish to create an annotation-analysis, post to the annotations endpoint and/or add the analysis to the appropriate study in the studyset, and the annotation-analysis will be created automatically.
648+
649+
### Example
650+
651+
* Bearer Authentication (JSON-Web-Token):
652+
```python
653+
import time
654+
import os
655+
import neurostore_sdk
656+
from neurostore_sdk.models.note_collection_request import NoteCollectionRequest
657+
from neurostore_sdk.models.note_collection_return import NoteCollectionReturn
658+
from neurostore_sdk.rest import ApiException
659+
from pprint import pprint
660+
661+
# Defining the host is optional and defaults to https://neurostore.org/api
662+
# See configuration.py for a list of all supported configuration parameters.
663+
configuration = neurostore_sdk.Configuration(
664+
host = "https://neurostore.org/api"
665+
)
666+
667+
# The client must configure the authentication and authorization parameters
668+
# in accordance with the API server security policy.
669+
# Examples for each auth method are provided below, use the example that
670+
# satisfies your auth use case.
671+
672+
# Configure Bearer authorization: JSON-Web-Token
673+
configuration = neurostore_sdk.Configuration(
674+
access_token = os.environ["BEARER_TOKEN"]
675+
)
676+
677+
# Enter a context with an instance of the API client
678+
with neurostore_sdk.ApiClient(configuration) as api_client:
679+
# Create an instance of the API class
680+
api_instance = neurostore_sdk.StoreApi(api_client)
681+
note_collection_request = [neurostore_sdk.NoteCollectionRequest()] # List[NoteCollectionRequest] | (optional)
682+
683+
try:
684+
# Your POST endpoint
685+
api_response = api_instance.annotation_analyses_post(note_collection_request=note_collection_request)
686+
print("The response of StoreApi->annotation_analyses_post:\n")
687+
pprint(api_response)
688+
except Exception as e:
689+
print("Exception when calling StoreApi->annotation_analyses_post: %s\n" % e)
690+
```
691+
692+
693+
### Parameters
694+
695+
Name | Type | Description | Notes
696+
------------- | ------------- | ------------- | -------------
697+
**note_collection_request** | [**List[NoteCollectionRequest]**](NoteCollectionRequest.md)| | [optional]
698+
699+
### Return type
700+
701+
[**List[NoteCollectionReturn]**](NoteCollectionReturn.md)
702+
703+
### Authorization
704+
705+
[JSON-Web-Token](../README.md#JSON-Web-Token)
706+
707+
### HTTP request headers
708+
709+
- **Content-Type**: application/json
710+
- **Accept**: application/json
711+
712+
### HTTP response details
713+
| Status code | Description | Response headers |
714+
|-------------|-------------|------------------|
715+
**200** | OK | - |
716+
717+
[[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)
718+
641719
# **annotations_get**
642720
> AnnotationList annotations_get(studyset_id=studyset_id)
643721

0 commit comments

Comments
 (0)