Skip to content

Commit acc9bfa

Browse files
github-actions[bot]github-actions[bot]
committed
ea17ccde456add22099f955f591ab6845d9393ca
1 parent 26e69b0 commit acc9bfa

34 files changed

Lines changed: 476 additions & 56 deletions

‎.openapi-generator/FILES‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ README.md
66
docs/Annotation.md
77
docs/AnnotationList.md
88
docs/AnnotationPostBody.md
9+
docs/AnnotationReference.md
910
docs/AnnotationReferenceReturn.md
1011
docs/AnnotationReturn.md
12+
docs/AnnotationSnapshotSummary.md
1113
docs/AnnotationUpdate.md
1214
docs/AnnotationsApi.md
1315
docs/Corrector.md
@@ -65,7 +67,6 @@ docs/StudysetPostBody.md
6567
docs/StudysetReference.md
6668
docs/StudysetReferenceList.md
6769
docs/StudysetReferenceReturn.md
68-
docs/StudysetReferenceStudysetsInner.md
6970
docs/StudysetReturn.md
7071
docs/StudysetSnapshotSummary.md
7172
docs/StudysetsApi.md
@@ -97,8 +98,10 @@ neurosynth_compose_sdk/models/__init__.py
9798
neurosynth_compose_sdk/models/annotation.py
9899
neurosynth_compose_sdk/models/annotation_list.py
99100
neurosynth_compose_sdk/models/annotation_post_body.py
101+
neurosynth_compose_sdk/models/annotation_reference.py
100102
neurosynth_compose_sdk/models/annotation_reference_return.py
101103
neurosynth_compose_sdk/models/annotation_return.py
104+
neurosynth_compose_sdk/models/annotation_snapshot_summary.py
102105
neurosynth_compose_sdk/models/annotation_update.py
103106
neurosynth_compose_sdk/models/corrector.py
104107
neurosynth_compose_sdk/models/estimator.py
@@ -150,7 +153,6 @@ neurosynth_compose_sdk/models/studyset_post_body.py
150153
neurosynth_compose_sdk/models/studyset_reference.py
151154
neurosynth_compose_sdk/models/studyset_reference_list.py
152155
neurosynth_compose_sdk/models/studyset_reference_return.py
153-
neurosynth_compose_sdk/models/studyset_reference_studysets_inner.py
154156
neurosynth_compose_sdk/models/studyset_return.py
155157
neurosynth_compose_sdk/models/studyset_snapshot_summary.py
156158
neurosynth_compose_sdk/models/tag.py
@@ -167,7 +169,6 @@ setup.cfg
167169
setup.py
168170
test-requirements.txt
169171
test/__init__.py
170-
test/test_annotation_reference_return.py
171-
test/test_studyset_reference_studysets_inner.py
172-
test/test_studyset_snapshot_summary.py
172+
test/test_annotation_reference.py
173+
test/test_annotation_snapshot_summary.py
173174
tox.ini

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,10 @@ Class | Method | HTTP request | Description
152152
- [Annotation](docs/Annotation.md)
153153
- [AnnotationList](docs/AnnotationList.md)
154154
- [AnnotationPostBody](docs/AnnotationPostBody.md)
155+
- [AnnotationReference](docs/AnnotationReference.md)
155156
- [AnnotationReferenceReturn](docs/AnnotationReferenceReturn.md)
156157
- [AnnotationReturn](docs/AnnotationReturn.md)
158+
- [AnnotationSnapshotSummary](docs/AnnotationSnapshotSummary.md)
157159
- [AnnotationUpdate](docs/AnnotationUpdate.md)
158160
- [Corrector](docs/Corrector.md)
159161
- [Estimator](docs/Estimator.md)
@@ -205,7 +207,6 @@ Class | Method | HTTP request | Description
205207
- [StudysetReference](docs/StudysetReference.md)
206208
- [StudysetReferenceList](docs/StudysetReferenceList.md)
207209
- [StudysetReferenceReturn](docs/StudysetReferenceReturn.md)
208-
- [StudysetReferenceStudysetsInner](docs/StudysetReferenceStudysetsInner.md)
209210
- [StudysetReturn](docs/StudysetReturn.md)
210211
- [StudysetSnapshotSummary](docs/StudysetSnapshotSummary.md)
211212
- [Tag](docs/Tag.md)

‎docs/Annotation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
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]
11-
**snapshot_studyset** | **str** | The related cached studyset to this annotation. | [optional] [readonly]
11+
**snapshot_studyset** | [**StudysetSnapshotSummary**](StudysetSnapshotSummary.md) | | [optional]
1212
**neurostore_url** | **str** | | [optional] [readonly]
1313

1414
## Example

‎docs/AnnotationPostBody.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**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]
11-
**snapshot_studyset** | **str** | The related cached studyset to this annotation. | [optional] [readonly]
11+
**snapshot_studyset** | [**StudysetSnapshotSummary**](StudysetSnapshotSummary.md) | | [optional]
1212
**neurostore_url** | **str** | | [optional] [readonly]
1313

1414
## Example

‎docs/AnnotationReference.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# AnnotationReference
2+
3+
A lightweight reference keyed by the Neurostore annotation ID.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**annotations** | [**List[AnnotationSnapshotSummary]**](AnnotationSnapshotSummary.md) | | [optional]
10+
11+
## Example
12+
13+
```python
14+
from neurosynth_compose_sdk.models.annotation_reference import AnnotationReference
15+
16+
# TODO update the JSON string below
17+
json = "{}"
18+
# create an instance of AnnotationReference from a JSON string
19+
annotation_reference_instance = AnnotationReference.from_json(json)
20+
# print the JSON string representation of the object
21+
print(AnnotationReference.to_json())
22+
23+
# convert the object into a dict
24+
annotation_reference_dict = annotation_reference_instance.to_dict()
25+
# create an instance of AnnotationReference from a dict
26+
annotation_reference_from_dict = AnnotationReference.from_dict(annotation_reference_dict)
27+
```
28+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29+
30+

‎docs/AnnotationReferenceReturn.md‎

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

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8+
**annotations** | [**List[AnnotationSnapshotSummary]**](AnnotationSnapshotSummary.md) | | [optional]
89
**id** | **str** | the identifier for the resource. | [optional]
910
**updated_at** | **datetime** | when the resource was last modified. | [optional] [readonly]
1011
**created_at** | **datetime** | When the resource was created. | [optional] [readonly]

‎docs/AnnotationReturn.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**neurostore_id** | **str** | the id of the annotation on neurostore | [optional]
99
**snapshot** | **object** | the snapshot taken of the annotation pending a successful run of the meta-analytic algorithm | [optional]
10-
**snapshot_studyset** | **str** | The related cached studyset to this annotation. | [optional] [readonly]
10+
**snapshot_studyset** | [**StudysetSnapshotSummary**](StudysetSnapshotSummary.md) | | [optional]
1111
**neurostore_url** | **str** | | [optional] [readonly]
1212
**id** | **str** | the identifier for the resource. | [optional]
1313
**updated_at** | **datetime** | when the resource was last modified. | [optional] [readonly]

‎docs/AnnotationSnapshotSummary.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# AnnotationSnapshotSummary
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**id** | **str** | Compose snapshot annotation identifier. | [optional]
9+
**md5** | **str** | Canonical md5 hash of the snapshot payload. | [optional]
10+
11+
## Example
12+
13+
```python
14+
from neurosynth_compose_sdk.models.annotation_snapshot_summary import AnnotationSnapshotSummary
15+
16+
# TODO update the JSON string below
17+
json = "{}"
18+
# create an instance of AnnotationSnapshotSummary from a JSON string
19+
annotation_snapshot_summary_instance = AnnotationSnapshotSummary.from_json(json)
20+
# print the JSON string representation of the object
21+
print(AnnotationSnapshotSummary.to_json())
22+
23+
# convert the object into a dict
24+
annotation_snapshot_summary_dict = annotation_snapshot_summary_instance.to_dict()
25+
# create an instance of AnnotationSnapshotSummary from a dict
26+
annotation_snapshot_summary_from_dict = AnnotationSnapshotSummary.from_dict(annotation_snapshot_summary_dict)
27+
```
28+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29+
30+

‎docs/AnnotationUpdate.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**neurostore_id** | **str** | the id of the annotation on neurostore | [optional]
99
**snapshot** | **object** | the snapshot taken of the annotation pending a successful run of the meta-analytic algorithm | [optional]
10-
**snapshot_studyset** | **str** | The related cached studyset to this annotation. | [optional] [readonly]
10+
**snapshot_studyset** | [**StudysetSnapshotSummary**](StudysetSnapshotSummary.md) | | [optional]
1111
**neurostore_url** | **str** | | [optional] [readonly]
1212
**snapshot_studyset_id** | **str** | | [optional]
1313

‎docs/DefaultApi.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ void (empty response body)
9292
9393
Get a Neurostore annotation reference by Neurostore ID
9494

95-
Resolve a Neurostore annotation reference using the same ID exposed by the Neurostore API.
95+
Resolve a Neurostore annotation reference using the same ID exposed by the Neurostore API, including each linked snapshot's compose ID and md5.
9696

9797
### Example
9898

@@ -436,7 +436,7 @@ This endpoint does not need any parameter.
436436
437437
List Neurostore studyset references
438438

439-
List reference rows keyed by the actual Neurostore studyset ID.
439+
List reference rows keyed by the actual Neurostore studyset ID, including compact snapshot summaries.
440440

441441
### Example
442442

@@ -504,7 +504,7 @@ No authorization required
504504
505505
Get a Neurostore studyset reference by Neurostore ID
506506

507-
Resolve a Neurostore studyset reference using the same ID exposed by the Neurostore API. By default, this returns each linked snapshot with its compose snapshot ID and md5.
507+
Resolve a Neurostore studyset reference using the same ID exposed by the Neurostore API, including each linked snapshot's compose ID and md5.
508508

509509
### Example
510510

0 commit comments

Comments
 (0)