Skip to content

Commit 827fd2f

Browse files
3de6e5f0b9df9b728fae792852b93037c3694c64
1 parent 9f22fe7 commit 827fd2f

19 files changed

Lines changed: 223 additions & 191 deletions

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
8080

8181
try:
8282
# GET a list of annotations
83-
api_response = api_instance.annotations_get(nested=nested, ids=ids, page=page, page_size=page_size, search=search, sort=sort, desc=desc, user_id=user_id, info=info)
84-
print("The response of AnnotationsApi->annotations_get:\n")
83+
api_response = api_instance.snapshot_annotations_get(nested=nested, ids=ids, page=page, page_size=page_size, search=search, sort=sort, desc=desc, user_id=user_id, info=info)
84+
print("The response of AnnotationsApi->snapshot_annotations_get:\n")
8585
pprint(api_response)
8686
except ApiException as e:
87-
print("Exception when calling AnnotationsApi->annotations_get: %s\n" % e)
87+
print("Exception when calling AnnotationsApi->snapshot_annotations_get: %s\n" % e)
8888

8989
```
9090

@@ -94,17 +94,17 @@ All URIs are relative to *https://compose.neurosynth.org/api*
9494

9595
Class | Method | HTTP request | Description
9696
------------ | ------------- | ------------- | -------------
97-
*AnnotationsApi* | [**annotations_get**](docs/AnnotationsApi.md#annotations_get) | **GET** /annotations | GET a list of annotations
98-
*AnnotationsApi* | [**annotations_id_get**](docs/AnnotationsApi.md#annotations_id_get) | **GET** /annotations/{id} | GET information about an annotation
99-
*AnnotationsApi* | [**annotations_id_put**](docs/AnnotationsApi.md#annotations_id_put) | **PUT** /annotations/{id} | Update an Annotation
100-
*AnnotationsApi* | [**annotations_post**](docs/AnnotationsApi.md#annotations_post) | **POST** /annotations | Create a new Annotation
97+
*AnnotationsApi* | [**snapshot_annotations_get**](docs/AnnotationsApi.md#snapshot_annotations_get) | **GET** /snapshot-annotations | GET a list of annotations
98+
*AnnotationsApi* | [**snapshot_annotations_id_get**](docs/AnnotationsApi.md#snapshot_annotations_id_get) | **GET** /snapshot-annotations/{id} | GET information about an annotation
99+
*AnnotationsApi* | [**snapshot_annotations_id_put**](docs/AnnotationsApi.md#snapshot_annotations_id_put) | **PUT** /snapshot-annotations/{id} | Update an Annotation
100+
*AnnotationsApi* | [**snapshot_annotations_post**](docs/AnnotationsApi.md#snapshot_annotations_post) | **POST** /snapshot-annotations | Create a new Annotation
101101
*DefaultApi* | [**meta_analyses_id_delete**](docs/DefaultApi.md#meta_analyses_id_delete) | **DELETE** /meta-analyses/{id} |
102102
*DefaultApi* | [**neurostore_studies_get**](docs/DefaultApi.md#neurostore_studies_get) | **GET** /neurostore-studies | Your GET endpoint
103103
*DefaultApi* | [**neurostore_studies_id_get**](docs/DefaultApi.md#neurostore_studies_id_get) | **GET** /neurostore-studies/{id} | Your GET endpoint
104104
*DefaultApi* | [**neurostore_studies_id_put**](docs/DefaultApi.md#neurostore_studies_id_put) | **PUT** /neurostore-studies/{id} |
105105
*DefaultApi* | [**neurostore_studies_post**](docs/DefaultApi.md#neurostore_studies_post) | **POST** /neurostore-studies |
106-
*DefaultApi* | [**studyset_references_get**](docs/DefaultApi.md#studyset_references_get) | **GET** /studyset-references | Your GET endpoint
107-
*DefaultApi* | [**studyset_references_id_get**](docs/DefaultApi.md#studyset_references_id_get) | **GET** /studyset-references/{id} | Your GET endpoint
106+
*DefaultApi* | [**neurostore_studysets_get**](docs/DefaultApi.md#neurostore_studysets_get) | **GET** /neurostore-studysets | Your GET endpoint
107+
*DefaultApi* | [**neurostore_studysets_id_get**](docs/DefaultApi.md#neurostore_studysets_id_get) | **GET** /neurostore-studysets/{id} | Your GET endpoint
108108
*MetaAnalysesApi* | [**meta_analyses_get**](docs/MetaAnalysesApi.md#meta_analyses_get) | **GET** /meta-analyses | GET a list of meta-analyses
109109
*MetaAnalysesApi* | [**meta_analyses_id_get**](docs/MetaAnalysesApi.md#meta_analyses_id_get) | **GET** /meta-analyses/{id} | GET meta-analysis information
110110
*MetaAnalysesApi* | [**meta_analyses_id_put**](docs/MetaAnalysesApi.md#meta_analyses_id_put) | **PUT** /meta-analyses/{id} | Update a meta-analysis
@@ -133,10 +133,10 @@ Class | Method | HTTP request | Description
133133
*SpecificationsApi* | [**specifications_id_get**](docs/SpecificationsApi.md#specifications_id_get) | **GET** /specifications/{id} | Get information about a Specification
134134
*SpecificationsApi* | [**specifications_id_put**](docs/SpecificationsApi.md#specifications_id_put) | **PUT** /specifications/{id} | Update Meta-Analysis specification
135135
*SpecificationsApi* | [**specifications_post**](docs/SpecificationsApi.md#specifications_post) | **POST** /specifications | Create a Specification
136-
*StudysetsApi* | [**studysets_get**](docs/StudysetsApi.md#studysets_get) | **GET** /studysets | Get a list of Studysets
137-
*StudysetsApi* | [**studysets_id_get**](docs/StudysetsApi.md#studysets_id_get) | **GET** /studysets/{id} | Get information about a Studyset
138-
*StudysetsApi* | [**studysets_id_put**](docs/StudysetsApi.md#studysets_id_put) | **PUT** /studysets/{id} | Update a Studyset
139-
*StudysetsApi* | [**studysets_post**](docs/StudysetsApi.md#studysets_post) | **POST** /studysets | Create a new Studyset
136+
*StudysetsApi* | [**snapshot_studysets_get**](docs/StudysetsApi.md#snapshot_studysets_get) | **GET** /snapshot-studysets | Get a list of Studysets
137+
*StudysetsApi* | [**snapshot_studysets_id_get**](docs/StudysetsApi.md#snapshot_studysets_id_get) | **GET** /snapshot-studysets/{id} | Get information about a Studyset
138+
*StudysetsApi* | [**snapshot_studysets_id_put**](docs/StudysetsApi.md#snapshot_studysets_id_put) | **PUT** /snapshot-studysets/{id} | Update a Studyset
139+
*StudysetsApi* | [**snapshot_studysets_post**](docs/StudysetsApi.md#snapshot_studysets_post) | **POST** /snapshot-studysets | Create a new Studyset
140140
*TagsApi* | [**tags_get**](docs/TagsApi.md#tags_get) | **GET** /tags | Get a list of Tags
141141
*TagsApi* | [**tags_id_get**](docs/TagsApi.md#tags_id_get) | **GET** /tags/{id} | Get information about a Tag
142142
*TagsApi* | [**tags_post**](docs/TagsApi.md#tags_post) | **POST** /tags | Create a new Tag

docs/AnnotationPostBody.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**cached_studyset_id** | **str** | | [optional]
8+
**snapshot_studyset_id** | **str** | | [optional]
99
**neurostore_id** | **str** | the id of the annotation on neurostore | [optional]
1010
**snapshot** | **object** | the snapshot taken of the annotation pending a successful run of the meta-analytic algorithm | [optional]
1111
**studyset** | **str** | The related cached studyset to this annotation. | [optional] [readonly]

docs/AnnotationUpdate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**snapshot** | **object** | the snapshot taken of the annotation pending a successful run of the meta-analytic algorithm | [optional]
1010
**studyset** | **str** | The related cached studyset to this annotation. | [optional] [readonly]
1111
**neurostore_url** | **str** | | [optional] [readonly]
12-
**cached_studyset_id** | **str** | | [optional]
12+
**snapshot_studyset_id** | **str** | | [optional]
1313

1414
## Example
1515

docs/AnnotationsApi.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ All URIs are relative to *https://compose.neurosynth.org/api*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**annotations_get**](AnnotationsApi.md#annotations_get) | **GET** /annotations | GET a list of annotations
8-
[**annotations_id_get**](AnnotationsApi.md#annotations_id_get) | **GET** /annotations/{id} | GET information about an annotation
9-
[**annotations_id_put**](AnnotationsApi.md#annotations_id_put) | **PUT** /annotations/{id} | Update an Annotation
10-
[**annotations_post**](AnnotationsApi.md#annotations_post) | **POST** /annotations | Create a new Annotation
7+
[**snapshot_annotations_get**](AnnotationsApi.md#snapshot_annotations_get) | **GET** /snapshot-annotations | GET a list of annotations
8+
[**snapshot_annotations_id_get**](AnnotationsApi.md#snapshot_annotations_id_get) | **GET** /snapshot-annotations/{id} | GET information about an annotation
9+
[**snapshot_annotations_id_put**](AnnotationsApi.md#snapshot_annotations_id_put) | **PUT** /snapshot-annotations/{id} | Update an Annotation
10+
[**snapshot_annotations_post**](AnnotationsApi.md#snapshot_annotations_post) | **POST** /snapshot-annotations | Create a new Annotation
1111

1212

13-
# **annotations_get**
14-
> AnnotationList annotations_get(nested=nested, ids=ids, page=page, page_size=page_size, search=search, sort=sort, desc=desc, user_id=user_id, info=info)
13+
# **snapshot_annotations_get**
14+
> AnnotationList snapshot_annotations_get(nested=nested, ids=ids, page=page, page_size=page_size, search=search, sort=sort, desc=desc, user_id=user_id, info=info)
1515
1616
GET a list of annotations
1717

@@ -49,11 +49,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
4949

5050
try:
5151
# GET a list of annotations
52-
api_response = api_instance.annotations_get(nested=nested, ids=ids, page=page, page_size=page_size, search=search, sort=sort, desc=desc, user_id=user_id, info=info)
53-
print("The response of AnnotationsApi->annotations_get:\n")
52+
api_response = api_instance.snapshot_annotations_get(nested=nested, ids=ids, page=page, page_size=page_size, search=search, sort=sort, desc=desc, user_id=user_id, info=info)
53+
print("The response of AnnotationsApi->snapshot_annotations_get:\n")
5454
pprint(api_response)
5555
except Exception as e:
56-
print("Exception when calling AnnotationsApi->annotations_get: %s\n" % e)
56+
print("Exception when calling AnnotationsApi->snapshot_annotations_get: %s\n" % e)
5757
```
5858

5959

@@ -95,8 +95,8 @@ No authorization required
9595

9696
[[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)
9797

98-
# **annotations_id_get**
99-
> AnnotationReturn annotations_id_get(id)
98+
# **snapshot_annotations_id_get**
99+
> AnnotationReturn snapshot_annotations_id_get(id)
100100
101101
GET information about an annotation
102102

@@ -126,11 +126,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
126126

127127
try:
128128
# GET information about an annotation
129-
api_response = api_instance.annotations_id_get(id)
130-
print("The response of AnnotationsApi->annotations_id_get:\n")
129+
api_response = api_instance.snapshot_annotations_id_get(id)
130+
print("The response of AnnotationsApi->snapshot_annotations_id_get:\n")
131131
pprint(api_response)
132132
except Exception as e:
133-
print("Exception when calling AnnotationsApi->annotations_id_get: %s\n" % e)
133+
print("Exception when calling AnnotationsApi->snapshot_annotations_id_get: %s\n" % e)
134134
```
135135

136136

@@ -165,8 +165,8 @@ No authorization required
165165

166166
[[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)
167167

168-
# **annotations_id_put**
169-
> AnnotationReturn annotations_id_put(id, annotation_update=annotation_update)
168+
# **snapshot_annotations_id_put**
169+
> AnnotationReturn snapshot_annotations_id_put(id, annotation_update=annotation_update)
170170
171171
Update an Annotation
172172

@@ -208,11 +208,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
208208

209209
try:
210210
# Update an Annotation
211-
api_response = api_instance.annotations_id_put(id, annotation_update=annotation_update)
212-
print("The response of AnnotationsApi->annotations_id_put:\n")
211+
api_response = api_instance.snapshot_annotations_id_put(id, annotation_update=annotation_update)
212+
print("The response of AnnotationsApi->snapshot_annotations_id_put:\n")
213213
pprint(api_response)
214214
except Exception as e:
215-
print("Exception when calling AnnotationsApi->annotations_id_put: %s\n" % e)
215+
print("Exception when calling AnnotationsApi->snapshot_annotations_id_put: %s\n" % e)
216216
```
217217

218218

@@ -250,8 +250,8 @@ Name | Type | Description | Notes
250250

251251
[[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)
252252

253-
# **annotations_post**
254-
> AnnotationReturn annotations_post(annotation_post_body=annotation_post_body)
253+
# **snapshot_annotations_post**
254+
> AnnotationReturn snapshot_annotations_post(annotation_post_body=annotation_post_body)
255255
256256
Create a new Annotation
257257

@@ -292,11 +292,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
292292

293293
try:
294294
# Create a new Annotation
295-
api_response = api_instance.annotations_post(annotation_post_body=annotation_post_body)
296-
print("The response of AnnotationsApi->annotations_post:\n")
295+
api_response = api_instance.snapshot_annotations_post(annotation_post_body=annotation_post_body)
296+
print("The response of AnnotationsApi->snapshot_annotations_post:\n")
297297
pprint(api_response)
298298
except Exception as e:
299-
print("Exception when calling AnnotationsApi->annotations_post: %s\n" % e)
299+
print("Exception when calling AnnotationsApi->snapshot_annotations_post: %s\n" % e)
300300
```
301301

302302

docs/DefaultApi.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Method | HTTP request | Description
99
[**neurostore_studies_id_get**](DefaultApi.md#neurostore_studies_id_get) | **GET** /neurostore-studies/{id} | Your GET endpoint
1010
[**neurostore_studies_id_put**](DefaultApi.md#neurostore_studies_id_put) | **PUT** /neurostore-studies/{id} |
1111
[**neurostore_studies_post**](DefaultApi.md#neurostore_studies_post) | **POST** /neurostore-studies |
12-
[**studyset_references_get**](DefaultApi.md#studyset_references_get) | **GET** /studyset-references | Your GET endpoint
13-
[**studyset_references_id_get**](DefaultApi.md#studyset_references_id_get) | **GET** /studyset-references/{id} | Your GET endpoint
12+
[**neurostore_studysets_get**](DefaultApi.md#neurostore_studysets_get) | **GET** /neurostore-studysets | Your GET endpoint
13+
[**neurostore_studysets_id_get**](DefaultApi.md#neurostore_studysets_id_get) | **GET** /neurostore-studysets/{id} | Your GET endpoint
1414

1515

1616
# **meta_analyses_id_delete**
@@ -362,8 +362,8 @@ This endpoint does not need any parameter.
362362

363363
[[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)
364364

365-
# **studyset_references_get**
366-
> StudysetReferenceList studyset_references_get(nested=nested)
365+
# **neurostore_studysets_get**
366+
> StudysetReferenceList neurostore_studysets_get(nested=nested)
367367
368368
Your GET endpoint
369369

@@ -393,11 +393,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
393393

394394
try:
395395
# Your GET endpoint
396-
api_response = api_instance.studyset_references_get(nested=nested)
397-
print("The response of DefaultApi->studyset_references_get:\n")
396+
api_response = api_instance.neurostore_studysets_get(nested=nested)
397+
print("The response of DefaultApi->neurostore_studysets_get:\n")
398398
pprint(api_response)
399399
except Exception as e:
400-
print("Exception when calling DefaultApi->studyset_references_get: %s\n" % e)
400+
print("Exception when calling DefaultApi->neurostore_studysets_get: %s\n" % e)
401401
```
402402

403403

@@ -430,8 +430,8 @@ No authorization required
430430

431431
[[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)
432432

433-
# **studyset_references_id_get**
434-
> StudysetReferenceReturn studyset_references_id_get(id, nested=nested)
433+
# **neurostore_studysets_id_get**
434+
> StudysetReferenceReturn neurostore_studysets_id_get(id, nested=nested)
435435
436436
Your GET endpoint
437437

@@ -460,11 +460,11 @@ with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
460460

461461
try:
462462
# Your GET endpoint
463-
api_response = api_instance.studyset_references_id_get(id, nested=nested)
464-
print("The response of DefaultApi->studyset_references_id_get:\n")
463+
api_response = api_instance.neurostore_studysets_id_get(id, nested=nested)
464+
print("The response of DefaultApi->neurostore_studysets_id_get:\n")
465465
pprint(api_response)
466466
except Exception as e:
467-
print("Exception when calling DefaultApi->studyset_references_id_get: %s\n" % e)
467+
print("Exception when calling DefaultApi->neurostore_studysets_id_get: %s\n" % e)
468468
```
469469

470470

docs/Project.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
99
**meta_analyses** | [**ProjectMetaAnalyses**](ProjectMetaAnalyses.md) | | [optional]
1010
**name** | **str** | | [optional]
1111
**description** | **str** | | [optional]
12+
**neurostore_studyset_id** | **str** | ID of the project’s linked Neurostore studyset reference. | [optional]
13+
**neurostore_annotation_id** | **str** | ID of the project’s linked Neurostore annotation reference. | [optional]
1214
**public** | **bool** | whether the project is public or private | [optional]
1315
**neurostore_study** | [**NeurostoreStudy**](NeurostoreStudy.md) | | [optional]
1416
**neurostore_url** | **str** | | [optional]

docs/ProjectReturn.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Name | Type | Description | Notes
1414
**meta_analyses** | [**ProjectMetaAnalyses**](ProjectMetaAnalyses.md) | | [optional]
1515
**name** | **str** | | [optional]
1616
**description** | **str** | | [optional]
17+
**neurostore_studyset_id** | **str** | ID of the project’s linked Neurostore studyset reference. | [optional]
18+
**neurostore_annotation_id** | **str** | ID of the project’s linked Neurostore annotation reference. | [optional]
1719
**public** | **bool** | whether the project is public or private | [optional]
1820
**neurostore_study** | [**NeurostoreStudy**](NeurostoreStudy.md) | | [optional]
1921
**neurostore_url** | **str** | | [optional]

docs/ResultInit.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**meta_analysis_id** | **str** | | [optional]
9-
**cached_studyset** | **object** | | [optional]
10-
**cached_annotation** | **object** | | [optional]
11-
**cached_studyset_id** | **str** | ID of an existing cached studyset snapshot to link to this result. | [optional]
12-
**cached_annotation_id** | **str** | ID of an existing cached annotation snapshot to link to this result. | [optional]
9+
**snapshot_studyset** | **object** | | [optional]
10+
**snapshot_annotation** | **object** | | [optional]
11+
**snapshot_studyset_id** | **str** | ID of an existing cached studyset snapshot to link to this result. | [optional]
12+
**snapshot_annotation_id** | **str** | ID of an existing cached annotation snapshot to link to this result. | [optional]
1313
**cli_version** | **str** | | [optional]
1414

1515
## Example

docs/ResultReturn.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Name | Type | Description | Notes
1717
**created_at** | **datetime** | When the resource was created. | [optional] [readonly]
1818
**user** | **str** | Who owns the resource. | [optional]
1919
**username** | **str** | | [optional] [readonly]
20-
**cached_studyset_id** | **str** | | [optional] [readonly]
21-
**cached_annotation_id** | **str** | | [optional] [readonly]
20+
**snapshot_studyset_id** | **str** | | [optional] [readonly]
21+
**snapshot_annotation_id** | **str** | | [optional] [readonly]
2222

2323
## Example
2424

0 commit comments

Comments
 (0)