Skip to content

Commit f966187

Browse files
github-actions[bot]github-actions[bot]
committed
3f27c9cd7cefb7d38fa24b5f8326a08531cdba7d
1 parent bced55c commit f966187

32 files changed

+1232
-19
lines changed

‎.openapi-generator/FILES‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ docs/SpecificationsApi.md
5858
docs/Studyset.md
5959
docs/StudysetList.md
6060
docs/StudysetPostBody.md
61+
docs/StudysetReference.md
62+
docs/StudysetReferenceList.md
63+
docs/StudysetReferenceReturn.md
64+
docs/StudysetReferenceSnapshotsInner.md
6165
docs/StudysetReturn.md
6266
docs/StudysetsApi.md
6367
docs/User.md
@@ -129,6 +133,10 @@ neurosynth_compose_sdk/models/specification_return.py
129133
neurosynth_compose_sdk/models/studyset.py
130134
neurosynth_compose_sdk/models/studyset_list.py
131135
neurosynth_compose_sdk/models/studyset_post_body.py
136+
neurosynth_compose_sdk/models/studyset_reference.py
137+
neurosynth_compose_sdk/models/studyset_reference_list.py
138+
neurosynth_compose_sdk/models/studyset_reference_return.py
139+
neurosynth_compose_sdk/models/studyset_reference_snapshots_inner.py
132140
neurosynth_compose_sdk/models/studyset_return.py
133141
neurosynth_compose_sdk/models/user.py
134142
neurosynth_compose_sdk/models/user_list.py
@@ -140,4 +148,8 @@ setup.cfg
140148
setup.py
141149
test-requirements.txt
142150
test/__init__.py
151+
test/test_studyset_reference.py
152+
test/test_studyset_reference_list.py
153+
test/test_studyset_reference_return.py
154+
test/test_studyset_reference_snapshots_inner.py
143155
tox.ini

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,8 @@ Class | Method | HTTP request | Description
127127
*DefaultApi* | [**neurostore_studies_id_put**](docs/DefaultApi.md#neurostore_studies_id_put) | **PUT** /neurostore-studies/{id} |
128128
*DefaultApi* | [**neurostore_studies_post**](docs/DefaultApi.md#neurostore_studies_post) | **POST** /neurostore-studies |
129129
*DefaultApi* | [**projects_id_delete**](docs/DefaultApi.md#projects_id_delete) | **DELETE** /projects/{id} |
130+
*DefaultApi* | [**studyset_references_get**](docs/DefaultApi.md#studyset_references_get) | **GET** /studyset-references | Your GET endpoint
131+
*DefaultApi* | [**studyset_references_id_get**](docs/DefaultApi.md#studyset_references_id_get) | **GET** /studyset-references/{id} | Your GET endpoint
130132
*GetApi* | [**annotations_get**](docs/GetApi.md#annotations_get) | **GET** /annotations | GET a list of annotations
131133
*GetApi* | [**annotations_id_get**](docs/GetApi.md#annotations_id_get) | **GET** /annotations/{id} | GET information about an annotation
132134
*GetApi* | [**meta_analyses_get**](docs/GetApi.md#meta_analyses_get) | **GET** /meta-analyses | GET a list of meta-analyses
@@ -240,6 +242,10 @@ Class | Method | HTTP request | Description
240242
- [Studyset](docs/Studyset.md)
241243
- [StudysetList](docs/StudysetList.md)
242244
- [StudysetPostBody](docs/StudysetPostBody.md)
245+
- [StudysetReference](docs/StudysetReference.md)
246+
- [StudysetReferenceList](docs/StudysetReferenceList.md)
247+
- [StudysetReferenceReturn](docs/StudysetReferenceReturn.md)
248+
- [StudysetReferenceSnapshotsInner](docs/StudysetReferenceSnapshotsInner.md)
243249
- [StudysetReturn](docs/StudysetReturn.md)
244250
- [User](docs/User.md)
245251
- [UserList](docs/UserList.md)

‎docs/DefaultApi.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Method | HTTP request | Description
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 |
1212
[**projects_id_delete**](DefaultApi.md#projects_id_delete) | **DELETE** /projects/{id} |
13+
[**studyset_references_get**](DefaultApi.md#studyset_references_get) | **GET** /studyset-references | Your GET endpoint
14+
[**studyset_references_id_get**](DefaultApi.md#studyset_references_id_get) | **GET** /studyset-references/{id} | Your GET endpoint
1315

1416

1517
# **meta_analyses_id_delete**
@@ -422,3 +424,129 @@ void (empty response body)
422424

423425
[[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)
424426

427+
# **studyset_references_get**
428+
> StudysetReferenceList studyset_references_get()
429+
430+
Your GET endpoint
431+
432+
433+
434+
### Example
435+
436+
```python
437+
import time
438+
import os
439+
import neurosynth_compose_sdk
440+
from neurosynth_compose_sdk.models.studyset_reference_list import StudysetReferenceList
441+
from neurosynth_compose_sdk.rest import ApiException
442+
from pprint import pprint
443+
444+
# Defining the host is optional and defaults to https://compose.neurosynth.org/api
445+
# See configuration.py for a list of all supported configuration parameters.
446+
configuration = neurosynth_compose_sdk.Configuration(
447+
host = "https://compose.neurosynth.org/api"
448+
)
449+
450+
451+
# Enter a context with an instance of the API client
452+
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
453+
# Create an instance of the API class
454+
api_instance = neurosynth_compose_sdk.DefaultApi(api_client)
455+
456+
try:
457+
# Your GET endpoint
458+
api_response = api_instance.studyset_references_get()
459+
print("The response of DefaultApi->studyset_references_get:\n")
460+
pprint(api_response)
461+
except Exception as e:
462+
print("Exception when calling DefaultApi->studyset_references_get: %s\n" % e)
463+
```
464+
465+
466+
### Parameters
467+
This endpoint does not need any parameter.
468+
469+
### Return type
470+
471+
[**StudysetReferenceList**](StudysetReferenceList.md)
472+
473+
### Authorization
474+
475+
No authorization required
476+
477+
### HTTP request headers
478+
479+
- **Content-Type**: Not defined
480+
- **Accept**: application/json
481+
482+
### HTTP response details
483+
| Status code | Description | Response headers |
484+
|-------------|-------------|------------------|
485+
**200** | OK | - |
486+
487+
[[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)
488+
489+
# **studyset_references_id_get**
490+
> StudysetReferenceReturn studyset_references_id_get(id)
491+
492+
Your GET endpoint
493+
494+
### Example
495+
496+
```python
497+
import time
498+
import os
499+
import neurosynth_compose_sdk
500+
from neurosynth_compose_sdk.models.studyset_reference_return import StudysetReferenceReturn
501+
from neurosynth_compose_sdk.rest import ApiException
502+
from pprint import pprint
503+
504+
# Defining the host is optional and defaults to https://compose.neurosynth.org/api
505+
# See configuration.py for a list of all supported configuration parameters.
506+
configuration = neurosynth_compose_sdk.Configuration(
507+
host = "https://compose.neurosynth.org/api"
508+
)
509+
510+
511+
# Enter a context with an instance of the API client
512+
with neurosynth_compose_sdk.ApiClient(configuration) as api_client:
513+
# Create an instance of the API class
514+
api_instance = neurosynth_compose_sdk.DefaultApi(api_client)
515+
id = 'id_example' # str |
516+
517+
try:
518+
# Your GET endpoint
519+
api_response = api_instance.studyset_references_id_get(id)
520+
print("The response of DefaultApi->studyset_references_id_get:\n")
521+
pprint(api_response)
522+
except Exception as e:
523+
print("Exception when calling DefaultApi->studyset_references_id_get: %s\n" % e)
524+
```
525+
526+
527+
### Parameters
528+
529+
Name | Type | Description | Notes
530+
------------- | ------------- | ------------- | -------------
531+
**id** | **str**| |
532+
533+
### Return type
534+
535+
[**StudysetReferenceReturn**](StudysetReferenceReturn.md)
536+
537+
### Authorization
538+
539+
No authorization required
540+
541+
### HTTP request headers
542+
543+
- **Content-Type**: Not defined
544+
- **Accept**: application/json
545+
546+
### HTTP response details
547+
| Status code | Description | Response headers |
548+
|-------------|-------------|------------------|
549+
**200** | OK | - |
550+
551+
[[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)
552+

‎docs/MetaAnalysisSpecification.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Name | Type | Description | Notes
77
**type** | **str** | the type of meta-analysis being run, typically either cbma or ibma, but others may become available in the future. | [optional]
88
**estimator** | [**Estimator**](Estimator.md) | | [optional]
99
**mask** | **str** | a string representing a binary nifti file to select which voxels a user wants to include in the analysis. | [optional]
10-
**contrast** | **str** | underspecified selection of columns to contrast (TODO, make better). | [optional]
10+
**contrast** | **str** | selection of categories in the filter column to differentiate groups, or \"neurosynth\", \"neuroquery\", or \"neurostore\" to compare to a database reference group | [optional]
1111
**transformer** | **str** | A transformation applied to column(s) (e.g., binarize based on a threshold). This is likely to become deprecated. | [optional]
1212
**corrector** | [**Corrector**](Corrector.md) | | [optional]
13-
**filter** | **str** | a boolean column from annotations selecting which analyses to include in the meta-analysis | [optional]
13+
**filter** | **str** | a column from annotations selecting which analyses to include in the meta-analysis | [optional]
1414

1515
## Example
1616

‎docs/MetaAnalysisStudyset.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
**neurostore_id** | **str** | The id of the studyset on neurostore. | [optional]
88
**snapshot** | **object** | The snapshot of the studyset pending a successful run of the meta-analysis. | [optional]
99
**neurostore_url** | **str** | | [optional] [readonly]
10+
**version** | **str** | A string representing a labeled version of this particular studyset. | [optional]
1011

1112
## Example
1213

‎docs/Specification.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Name | Type | Description | Notes
88
**type** | **str** | the type of meta-analysis being run, typically either cbma or ibma, but others may become available in the future. | [optional]
99
**estimator** | [**Estimator**](Estimator.md) | | [optional]
1010
**mask** | **str** | a string representing a binary nifti file to select which voxels a user wants to include in the analysis. | [optional]
11-
**contrast** | **str** | underspecified selection of columns to contrast (TODO, make better). | [optional]
11+
**contrast** | **str** | selection of categories in the filter column to differentiate groups, or \"neurosynth\", \"neuroquery\", or \"neurostore\" to compare to a database reference group | [optional]
1212
**transformer** | **str** | A transformation applied to column(s) (e.g., binarize based on a threshold). This is likely to become deprecated. | [optional]
1313
**corrector** | [**Corrector**](Corrector.md) | | [optional]
14-
**filter** | **str** | a boolean column from annotations selecting which analyses to include in the meta-analysis | [optional]
14+
**filter** | **str** | a column from annotations selecting which analyses to include in the meta-analysis | [optional]
1515

1616
## Example
1717

‎docs/SpecificationPostBody.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Name | Type | Description | Notes
77
**type** | **str** | the type of meta-analysis being run, typically either cbma or ibma, but others may become available in the future. | [optional]
88
**estimator** | [**Estimator**](Estimator.md) | | [optional]
99
**mask** | **str** | a string representing a binary nifti file to select which voxels a user wants to include in the analysis. | [optional]
10-
**contrast** | **str** | underspecified selection of columns to contrast (TODO, make better). | [optional]
10+
**contrast** | **str** | selection of categories in the filter column to differentiate groups, or \"neurosynth\", \"neuroquery\", or \"neurostore\" to compare to a database reference group | [optional]
1111
**transformer** | **str** | A transformation applied to column(s) (e.g., binarize based on a threshold). This is likely to become deprecated. | [optional]
1212
**corrector** | [**Corrector**](Corrector.md) | | [optional]
13-
**filter** | **str** | a boolean column from annotations selecting which analyses to include in the meta-analysis | [optional]
13+
**filter** | **str** | a column from annotations selecting which analyses to include in the meta-analysis | [optional]
1414

1515
## Example
1616

‎docs/SpecificationReturn.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Name | Type | Description | Notes
88
**type** | **str** | the type of meta-analysis being run, typically either cbma or ibma, but others may become available in the future. | [optional]
99
**estimator** | [**Estimator**](Estimator.md) | | [optional]
1010
**mask** | **str** | a string representing a binary nifti file to select which voxels a user wants to include in the analysis. | [optional]
11-
**contrast** | **str** | underspecified selection of columns to contrast (TODO, make better). | [optional]
11+
**contrast** | **str** | selection of categories in the filter column to differentiate groups, or \"neurosynth\", \"neuroquery\", or \"neurostore\" to compare to a database reference group | [optional]
1212
**transformer** | **str** | A transformation applied to column(s) (e.g., binarize based on a threshold). This is likely to become deprecated. | [optional]
1313
**corrector** | [**Corrector**](Corrector.md) | | [optional]
14-
**filter** | **str** | a boolean column from annotations selecting which analyses to include in the meta-analysis | [optional]
14+
**filter** | **str** | a column from annotations selecting which analyses to include in the meta-analysis | [optional]
1515
**id** | **str** | the identifier for the resource. | [optional]
1616
**updated_at** | **datetime** | when the resource was last modified. | [optional] [readonly]
1717
**created_at** | **datetime** | When the resource was created. | [optional] [readonly]

‎docs/Studyset.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
**neurostore_id** | **str** | The id of the studyset on neurostore. | [optional]
88
**snapshot** | **object** | The snapshot of the studyset pending a successful run of the meta-analysis. | [optional]
99
**neurostore_url** | **str** | | [optional] [readonly]
10+
**version** | **str** | A string representing a labeled version of this particular studyset. | [optional]
1011

1112
## Example
1213

‎docs/StudysetPostBody.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
**neurostore_id** | **str** | The id of the studyset on neurostore. |
88
**snapshot** | **object** | The snapshot of the studyset pending a successful run of the meta-analysis. | [optional]
99
**neurostore_url** | **str** | | [optional] [readonly]
10+
**version** | **str** | A string representing a labeled version of this particular studyset. | [optional]
1011

1112
## Example
1213

0 commit comments

Comments
 (0)