Skip to content

Commit 619594a

Browse files
github-actions[bot]github-actions[bot]
committed
72c53dd9cd5ad82d4785e8d7546e145ae196f24a
1 parent 98b4c5c commit 619594a

27 files changed

+4182
-0
lines changed

‎.openapi-generator/FILES‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ docs/MetaAnalysesApi.md
1818
docs/MetaAnalysesGet400Response.md
1919
docs/MetaAnalysis.md
2020
docs/MetaAnalysisAnnotation.md
21+
docs/MetaAnalysisJobList.md
22+
docs/MetaAnalysisJobListMetadata.md
23+
docs/MetaAnalysisJobLog.md
24+
docs/MetaAnalysisJobRequest.md
25+
docs/MetaAnalysisJobResponse.md
2126
docs/MetaAnalysisList.md
2227
docs/MetaAnalysisPostBody.md
2328
docs/MetaAnalysisResults.md
@@ -97,6 +102,11 @@ neurosynth_compose_sdk/models/estimator.py
97102
neurosynth_compose_sdk/models/meta_analyses_get400_response.py
98103
neurosynth_compose_sdk/models/meta_analysis.py
99104
neurosynth_compose_sdk/models/meta_analysis_annotation.py
105+
neurosynth_compose_sdk/models/meta_analysis_job_list.py
106+
neurosynth_compose_sdk/models/meta_analysis_job_list_metadata.py
107+
neurosynth_compose_sdk/models/meta_analysis_job_log.py
108+
neurosynth_compose_sdk/models/meta_analysis_job_request.py
109+
neurosynth_compose_sdk/models/meta_analysis_job_response.py
100110
neurosynth_compose_sdk/models/meta_analysis_list.py
101111
neurosynth_compose_sdk/models/meta_analysis_post_body.py
102112
neurosynth_compose_sdk/models/meta_analysis_results.py
@@ -149,4 +159,9 @@ setup.cfg
149159
setup.py
150160
test-requirements.txt
151161
test/__init__.py
162+
test/test_meta_analysis_job_list.py
163+
test/test_meta_analysis_job_list_metadata.py
164+
test/test_meta_analysis_job_log.py
165+
test/test_meta_analysis_job_request.py
166+
test/test_meta_analysis_job_response.py
152167
tox.ini

‎README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,9 @@ Class | Method | HTTP request | Description
110110
*ComposeApi* | [**meta_analysis_results_id_get**](docs/ComposeApi.md#meta_analysis_results_id_get) | **GET** /meta-analysis-results/{id} | Your GET endpoint
111111
*ComposeApi* | [**meta_analysis_results_id_put**](docs/ComposeApi.md#meta_analysis_results_id_put) | **PUT** /meta-analysis-results/{id} |
112112
*ComposeApi* | [**meta_analysis_results_post**](docs/ComposeApi.md#meta_analysis_results_post) | **POST** /meta-analysis-results |
113+
*ComposeApi* | [**neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_job_resource_get**](docs/ComposeApi.md#neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_job_resource_get) | **GET** /meta-analysis-jobs/{job_id} | Get status and logs for a meta-analysis job
114+
*ComposeApi* | [**neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_get**](docs/ComposeApi.md#neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_get) | **GET** /meta-analysis-jobs | List meta-analysis jobs for the current user
115+
*ComposeApi* | [**neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post**](docs/ComposeApi.md#neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post) | **POST** /meta-analysis-jobs | Submit a meta-analysis job
113116
*ComposeApi* | [**projects_get**](docs/ComposeApi.md#projects_get) | **GET** /projects | Your GET endpoint
114117
*ComposeApi* | [**projects_id_delete**](docs/ComposeApi.md#projects_id_delete) | **DELETE** /projects/{id} |
115118
*ComposeApi* | [**projects_id_get**](docs/ComposeApi.md#projects_id_get) | **GET** /projects/{id} | Your GET endpoint
@@ -132,6 +135,8 @@ Class | Method | HTTP request | Description
132135
*GetApi* | [**meta_analyses_id_get**](docs/GetApi.md#meta_analyses_id_get) | **GET** /meta-analyses/{id} | GET meta-analysis information
133136
*GetApi* | [**meta_analysis_results_get**](docs/GetApi.md#meta_analysis_results_get) | **GET** /meta-analysis-results | Your GET endpoint
134137
*GetApi* | [**meta_analysis_results_id_get**](docs/GetApi.md#meta_analysis_results_id_get) | **GET** /meta-analysis-results/{id} | Your GET endpoint
138+
*GetApi* | [**neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_job_resource_get**](docs/GetApi.md#neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_job_resource_get) | **GET** /meta-analysis-jobs/{job_id} | Get status and logs for a meta-analysis job
139+
*GetApi* | [**neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_get**](docs/GetApi.md#neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_get) | **GET** /meta-analysis-jobs | List meta-analysis jobs for the current user
135140
*GetApi* | [**projects_get**](docs/GetApi.md#projects_get) | **GET** /projects | Your GET endpoint
136141
*GetApi* | [**projects_id_get**](docs/GetApi.md#projects_id_get) | **GET** /projects/{id} | Your GET endpoint
137142
*GetApi* | [**specifications_get**](docs/GetApi.md#specifications_get) | **GET** /specifications | Get a list of Specifications
@@ -146,9 +151,13 @@ Class | Method | HTTP request | Description
146151
*MetaAnalysesApi* | [**meta_analysis_results_id_get**](docs/MetaAnalysesApi.md#meta_analysis_results_id_get) | **GET** /meta-analysis-results/{id} | Your GET endpoint
147152
*MetaAnalysesApi* | [**meta_analysis_results_id_put**](docs/MetaAnalysesApi.md#meta_analysis_results_id_put) | **PUT** /meta-analysis-results/{id} |
148153
*MetaAnalysesApi* | [**meta_analysis_results_post**](docs/MetaAnalysesApi.md#meta_analysis_results_post) | **POST** /meta-analysis-results |
154+
*MetaAnalysesApi* | [**neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_job_resource_get**](docs/MetaAnalysesApi.md#neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_job_resource_get) | **GET** /meta-analysis-jobs/{job_id} | Get status and logs for a meta-analysis job
155+
*MetaAnalysesApi* | [**neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_get**](docs/MetaAnalysesApi.md#neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_get) | **GET** /meta-analysis-jobs | List meta-analysis jobs for the current user
156+
*MetaAnalysesApi* | [**neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post**](docs/MetaAnalysesApi.md#neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post) | **POST** /meta-analysis-jobs | Submit a meta-analysis job
149157
*PostApi* | [**annotations_post**](docs/PostApi.md#annotations_post) | **POST** /annotations | Create a new Annotation
150158
*PostApi* | [**meta_analyses_post**](docs/PostApi.md#meta_analyses_post) | **POST** /meta-analyses | Create a new meta-analysis
151159
*PostApi* | [**meta_analysis_results_post**](docs/PostApi.md#meta_analysis_results_post) | **POST** /meta-analysis-results |
160+
*PostApi* | [**neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post**](docs/PostApi.md#neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post) | **POST** /meta-analysis-jobs | Submit a meta-analysis job
152161
*PostApi* | [**projects_post**](docs/PostApi.md#projects_post) | **POST** /projects |
153162
*PostApi* | [**specifications_post**](docs/PostApi.md#specifications_post) | **POST** /specifications | Create a Specification
154163
*PostApi* | [**studysets_post**](docs/PostApi.md#studysets_post) | **POST** /studysets | Create a new Studyset
@@ -189,6 +198,11 @@ Class | Method | HTTP request | Description
189198
- [MetaAnalysesGet400Response](docs/MetaAnalysesGet400Response.md)
190199
- [MetaAnalysis](docs/MetaAnalysis.md)
191200
- [MetaAnalysisAnnotation](docs/MetaAnalysisAnnotation.md)
201+
- [MetaAnalysisJobList](docs/MetaAnalysisJobList.md)
202+
- [MetaAnalysisJobListMetadata](docs/MetaAnalysisJobListMetadata.md)
203+
- [MetaAnalysisJobLog](docs/MetaAnalysisJobLog.md)
204+
- [MetaAnalysisJobRequest](docs/MetaAnalysisJobRequest.md)
205+
- [MetaAnalysisJobResponse](docs/MetaAnalysisJobResponse.md)
192206
- [MetaAnalysisList](docs/MetaAnalysisList.md)
193207
- [MetaAnalysisPostBody](docs/MetaAnalysisPostBody.md)
194208
- [MetaAnalysisResults](docs/MetaAnalysisResults.md)

‎docs/ComposeApi.md‎

Lines changed: 243 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ Method | HTTP request | Description
1616
[**meta_analysis_results_id_get**](ComposeApi.md#meta_analysis_results_id_get) | **GET** /meta-analysis-results/{id} | Your GET endpoint
1717
[**meta_analysis_results_id_put**](ComposeApi.md#meta_analysis_results_id_put) | **PUT** /meta-analysis-results/{id} |
1818
[**meta_analysis_results_post**](ComposeApi.md#meta_analysis_results_post) | **POST** /meta-analysis-results |
19+
[**neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_job_resource_get**](ComposeApi.md#neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_job_resource_get) | **GET** /meta-analysis-jobs/{job_id} | Get status and logs for a meta-analysis job
20+
[**neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_get**](ComposeApi.md#neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_get) | **GET** /meta-analysis-jobs | List meta-analysis jobs for the current user
21+
[**neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post**](ComposeApi.md#neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post) | **POST** /meta-analysis-jobs | Submit a meta-analysis job
1922
[**projects_get**](ComposeApi.md#projects_get) | **GET** /projects | Your GET endpoint
2023
[**projects_id_delete**](ComposeApi.md#projects_id_delete) | **DELETE** /projects/{id} |
2124
[**projects_id_get**](ComposeApi.md#projects_id_get) | **GET** /projects/{id} | Your GET endpoint
@@ -979,6 +982,246 @@ Name | Type | Description | Notes
979982

980983
[[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)
981984

985+
# **neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_job_resource_get**
986+
> MetaAnalysisJobResponse neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_job_resource_get(job_id)
987+
988+
Get status and logs for a meta-analysis job
989+
990+
Retrieve the most recent status information and logs for a submitted job.
991+
992+
### Example
993+
994+
* Bearer Authentication (JSON-Web-Token):
995+
996+
```python
997+
import neurosynth_compose_sdk
998+
from neurosynth_compose_sdk.models.meta_analysis_job_response import MetaAnalysisJobResponse
999+
from neurosynth_compose_sdk.rest import ApiException
1000+
from pprint import pprint
1001+
1002+
# Defining the host is optional and defaults to https://compose.neurosynth.org/api
1003+
# See configuration.py for a list of all supported configuration parameters.
1004+
configuration = neurosynth_compose_sdk.Configuration(
1005+
host = "https://compose.neurosynth.org/api"
1006+
)
1007+
1008+
# The client must configure the authentication and authorization parameters
1009+
# in accordance with the API server security policy.
1010+
# Examples for each auth method are provided below, use the example that
1011+
# satisfies your auth use case.
1012+
1013+
# Configure Bearer authorization: JSON-Web-Token
1014+
configuration = neurosynth_compose_sdk.Configuration(
1015+
access_token = os.environ["BEARER_TOKEN"]
1016+
)
1017+
1018+
# Enter a context with an instance of the API client
1019+
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
1020+
# Create an instance of the API class
1021+
api_instance = neurosynth_compose_sdk.ComposeApi(api_client)
1022+
job_id = 'job_id_example' # str |
1023+
1024+
try:
1025+
# Get status and logs for a meta-analysis job
1026+
api_response = api_instance.neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_job_resource_get(job_id)
1027+
print("The response of ComposeApi->neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_job_resource_get:\n")
1028+
pprint(api_response)
1029+
except Exception as e:
1030+
print("Exception when calling ComposeApi->neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_job_resource_get: %s\n" % e)
1031+
```
1032+
1033+
1034+
1035+
### Parameters
1036+
1037+
1038+
Name | Type | Description | Notes
1039+
------------- | ------------- | ------------- | -------------
1040+
**job_id** | **str**| |
1041+
1042+
### Return type
1043+
1044+
[**MetaAnalysisJobResponse**](MetaAnalysisJobResponse.md)
1045+
1046+
### Authorization
1047+
1048+
[JSON-Web-Token](../README.md#JSON-Web-Token)
1049+
1050+
### HTTP request headers
1051+
1052+
- **Content-Type**: Not defined
1053+
- **Accept**: application/json, application/problem+json
1054+
1055+
### HTTP response details
1056+
1057+
| Status code | Description | Response headers |
1058+
|-------------|-------------|------------------|
1059+
**200** | OK | - |
1060+
**401** | form when a request goes wrong | - |
1061+
**404** | form when a request goes wrong | - |
1062+
**502** | form when a request goes wrong | - |
1063+
1064+
[[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)
1065+
1066+
# **neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_get**
1067+
> MetaAnalysisJobList neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_get()
1068+
1069+
List meta-analysis jobs for the current user
1070+
1071+
Return cached job submissions associated with the authenticated user.
1072+
1073+
### Example
1074+
1075+
* Bearer Authentication (JSON-Web-Token):
1076+
1077+
```python
1078+
import neurosynth_compose_sdk
1079+
from neurosynth_compose_sdk.models.meta_analysis_job_list import MetaAnalysisJobList
1080+
from neurosynth_compose_sdk.rest import ApiException
1081+
from pprint import pprint
1082+
1083+
# Defining the host is optional and defaults to https://compose.neurosynth.org/api
1084+
# See configuration.py for a list of all supported configuration parameters.
1085+
configuration = neurosynth_compose_sdk.Configuration(
1086+
host = "https://compose.neurosynth.org/api"
1087+
)
1088+
1089+
# The client must configure the authentication and authorization parameters
1090+
# in accordance with the API server security policy.
1091+
# Examples for each auth method are provided below, use the example that
1092+
# satisfies your auth use case.
1093+
1094+
# Configure Bearer authorization: JSON-Web-Token
1095+
configuration = neurosynth_compose_sdk.Configuration(
1096+
access_token = os.environ["BEARER_TOKEN"]
1097+
)
1098+
1099+
# Enter a context with an instance of the API client
1100+
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
1101+
# Create an instance of the API class
1102+
api_instance = neurosynth_compose_sdk.ComposeApi(api_client)
1103+
1104+
try:
1105+
# List meta-analysis jobs for the current user
1106+
api_response = api_instance.neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_get()
1107+
print("The response of ComposeApi->neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_get:\n")
1108+
pprint(api_response)
1109+
except Exception as e:
1110+
print("Exception when calling ComposeApi->neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_get: %s\n" % e)
1111+
```
1112+
1113+
1114+
1115+
### Parameters
1116+
1117+
This endpoint does not need any parameter.
1118+
1119+
### Return type
1120+
1121+
[**MetaAnalysisJobList**](MetaAnalysisJobList.md)
1122+
1123+
### Authorization
1124+
1125+
[JSON-Web-Token](../README.md#JSON-Web-Token)
1126+
1127+
### HTTP request headers
1128+
1129+
- **Content-Type**: Not defined
1130+
- **Accept**: application/json, application/problem+json
1131+
1132+
### HTTP response details
1133+
1134+
| Status code | Description | Response headers |
1135+
|-------------|-------------|------------------|
1136+
**200** | OK | - |
1137+
**401** | form when a request goes wrong | - |
1138+
**502** | form when a request goes wrong | - |
1139+
1140+
[[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)
1141+
1142+
# **neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post**
1143+
> MetaAnalysisJobResponse neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post(meta_analysis_job_request)
1144+
1145+
Submit a meta-analysis job
1146+
1147+
Submit a meta-analysis to the compose runner service.
1148+
1149+
### Example
1150+
1151+
* Bearer Authentication (JSON-Web-Token):
1152+
1153+
```python
1154+
import neurosynth_compose_sdk
1155+
from neurosynth_compose_sdk.models.meta_analysis_job_request import MetaAnalysisJobRequest
1156+
from neurosynth_compose_sdk.models.meta_analysis_job_response import MetaAnalysisJobResponse
1157+
from neurosynth_compose_sdk.rest import ApiException
1158+
from pprint import pprint
1159+
1160+
# Defining the host is optional and defaults to https://compose.neurosynth.org/api
1161+
# See configuration.py for a list of all supported configuration parameters.
1162+
configuration = neurosynth_compose_sdk.Configuration(
1163+
host = "https://compose.neurosynth.org/api"
1164+
)
1165+
1166+
# The client must configure the authentication and authorization parameters
1167+
# in accordance with the API server security policy.
1168+
# Examples for each auth method are provided below, use the example that
1169+
# satisfies your auth use case.
1170+
1171+
# Configure Bearer authorization: JSON-Web-Token
1172+
configuration = neurosynth_compose_sdk.Configuration(
1173+
access_token = os.environ["BEARER_TOKEN"]
1174+
)
1175+
1176+
# Enter a context with an instance of the API client
1177+
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
1178+
# Create an instance of the API class
1179+
api_instance = neurosynth_compose_sdk.ComposeApi(api_client)
1180+
meta_analysis_job_request = neurosynth_compose_sdk.MetaAnalysisJobRequest() # MetaAnalysisJobRequest |
1181+
1182+
try:
1183+
# Submit a meta-analysis job
1184+
api_response = api_instance.neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post(meta_analysis_job_request)
1185+
print("The response of ComposeApi->neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post:\n")
1186+
pprint(api_response)
1187+
except Exception as e:
1188+
print("Exception when calling ComposeApi->neurosynth_compose_resources_meta_analysis_jobs_meta_analysis_jobs_resource_post: %s\n" % e)
1189+
```
1190+
1191+
1192+
1193+
### Parameters
1194+
1195+
1196+
Name | Type | Description | Notes
1197+
------------- | ------------- | ------------- | -------------
1198+
**meta_analysis_job_request** | [**MetaAnalysisJobRequest**](MetaAnalysisJobRequest.md)| |
1199+
1200+
### Return type
1201+
1202+
[**MetaAnalysisJobResponse**](MetaAnalysisJobResponse.md)
1203+
1204+
### Authorization
1205+
1206+
[JSON-Web-Token](../README.md#JSON-Web-Token)
1207+
1208+
### HTTP request headers
1209+
1210+
- **Content-Type**: application/json
1211+
- **Accept**: application/json, application/problem+json
1212+
1213+
### HTTP response details
1214+
1215+
| Status code | Description | Response headers |
1216+
|-------------|-------------|------------------|
1217+
**202** | Job accepted | - |
1218+
**401** | form when a request goes wrong | - |
1219+
**403** | form when a request goes wrong | - |
1220+
**422** | form when a request goes wrong | - |
1221+
**502** | form when a request goes wrong | - |
1222+
1223+
[[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)
1224+
9821225
# **projects_get**
9831226
> ProjectList projects_get(page=page, page_size=page_size, name=name, search=search, description=description, sort=sort, desc=desc, user_id=user_id)
9841227

0 commit comments

Comments
 (0)