syndb_api_client 0.2.4

Synapse DB

syndb-api-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.1.13
• Package version: 0.2.4
• Generator version: 7.6.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import syndb_api_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import syndb_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import syndb_api_client
from syndb_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = syndb_api_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with syndb_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = syndb_api_client.AuthApi(api_client)
    username = 'username_example' # str | 
    password = 'password_example' # str | 
    grant_type = 'grant_type_example' # str |  (optional)
    scope = '' # str |  (optional) (default to '')
    client_id = 'client_id_example' # str |  (optional)
    client_secret = 'client_secret_example' # str |  (optional)

    try:
        # Auth:Database.Login
        api_response = api_instance.auth_database_login_user_auth_database_login_post(username, password, grant_type=grant_type, scope=scope, client_id=client_id, client_secret=client_secret)
        print("The response of AuthApi->auth_database_login_user_auth_database_login_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthApi->auth_database_login_user_auth_database_login_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AuthApi	auth_database_login_user_auth_database_login_post	POST /user/auth/database/login	Auth:Database.Login
AuthApi	auth_database_logout_user_auth_database_logout_post	POST /user/auth/database/logout	Auth:Database.Logout
DatasetApi	dataset_tag_search_neurodata_metadata_dataset_search_post	POST /neurodata/metadata/dataset/search	Dataset Tag Search
DatasetApi	get_dataset_info_neurodata_metadata_dataset_dataset_id_info_get	GET /neurodata/metadata/dataset/{dataset_id}/info	Get Dataset Info
DatasetApi	get_datasets_neurodata_metadata_dataset_get_all_get	GET /neurodata/metadata/dataset/get/all	Get Datasets
DatasetApi	get_modifiable_datasets_neurodata_metadata_dataset_get_incomplete_get	GET /neurodata/metadata/dataset/get/incomplete	Get Modifiable Datasets
DatasetApi	modifiable_datasets_neurodata_metadata_dataset_get_modifiable_get	GET /neurodata/metadata/dataset/get/modifiable	Modifiable Datasets
DatasetApi	new_dataset_collection_neurodata_metadata_dataset_collection_new_post	POST /neurodata/metadata/dataset/collection/new	New Dataset Collection
DatasetApi	register_new_dataset_neurodata_metadata_dataset_new_post	POST /neurodata/metadata/dataset/new	Register New Dataset
DefaultApi	redirect_get	GET /	Redirect
ExternalApi	download_data_neurodata_io_download_url_get	GET /neurodata/io/download_url	Download Data
ExternalApi	upload_dataset_mesh_neurodata_io_dataset_id_upload_url_mesh_get	GET /neurodata/io/{dataset_id}/upload_url/mesh	Upload Dataset Mesh
ExternalApi	upload_dataset_swb_neurodata_io_dataset_id_upload_url_swb_get	GET /neurodata/io/{dataset_id}/upload_url/swb	Upload Dataset Swb
GithubApi	oauth_github_database_authorize_user_auth_github_authorize_get	GET /user/auth/github/authorize	Oauth:Github.Database.Authorize
GithubApi	oauth_github_database_callback_user_auth_github_callback_get	GET /user/auth/github/callback	Oauth:Github.Database.Callback
GoogleApi	oauth_google_database_authorize_user_auth_google_authorize_get	GET /user/auth/google/authorize	Oauth:Google.Database.Authorize
GoogleApi	oauth_google_database_callback_user_auth_google_callback_get	GET /user/auth/google/callback	Oauth:Google.Database.Callback
IoApi	delete_dataset_neurodata_io_dataset_id_delete_dataset_delete	DELETE /neurodata/io/{dataset_id}/delete_dataset	Delete Dataset
IoApi	download_data_neurodata_io_download_url_get	GET /neurodata/io/download_url	Download Data
IoApi	download_dataset_files_neurodata_io_download_dataset_post	POST /neurodata/io/download_dataset	Download Dataset Files
IoApi	upload_dataset_files_neurodata_io_dataset_id_upload_patch	PATCH /neurodata/io/{dataset_id}/upload	Upload Dataset Files
IoApi	upload_dataset_mesh_neurodata_io_dataset_id_upload_url_mesh_get	GET /neurodata/io/{dataset_id}/upload_url/mesh	Upload Dataset Mesh
IoApi	upload_dataset_swb_neurodata_io_dataset_id_upload_url_swb_get	GET /neurodata/io/{dataset_id}/upload_url/swb	Upload Dataset Swb
MetadataApi	create_animal_neurodata_metadata_tag_animal_create_post	POST /neurodata/metadata/tag/animal/create	Create Animal
MetadataApi	create_brain_region_neurodata_metadata_tag_brain_region_create_post	POST /neurodata/metadata/tag/brain_region/create	Create Brain Region
MetadataApi	create_microscopy_neurodata_metadata_tag_microscopy_create_post	POST /neurodata/metadata/tag/microscopy/create	Create Microscopy
MetadataApi	create_mutation_neurodata_metadata_tag_mutation_create_post	POST /neurodata/metadata/tag/mutation/create	Create Mutation
MetadataApi	create_publication_neurodata_metadata_tag_publication_create_post	POST /neurodata/metadata/tag/publication/create	Create Publication
MetadataApi	dataset_tag_search_neurodata_metadata_dataset_search_post	POST /neurodata/metadata/dataset/search	Dataset Tag Search
MetadataApi	get_dataset_info_neurodata_metadata_dataset_dataset_id_info_get	GET /neurodata/metadata/dataset/{dataset_id}/info	Get Dataset Info
MetadataApi	get_datasets_neurodata_metadata_dataset_get_all_get	GET /neurodata/metadata/dataset/get/all	Get Datasets
MetadataApi	get_modifiable_datasets_neurodata_metadata_dataset_get_incomplete_get	GET /neurodata/metadata/dataset/get/incomplete	Get Modifiable Datasets
MetadataApi	modifiable_datasets_neurodata_metadata_dataset_get_modifiable_get	GET /neurodata/metadata/dataset/get/modifiable	Modifiable Datasets
MetadataApi	new_dataset_collection_neurodata_metadata_dataset_collection_new_post	POST /neurodata/metadata/dataset/collection/new	New Dataset Collection
MetadataApi	register_new_dataset_neurodata_metadata_dataset_new_post	POST /neurodata/metadata/dataset/new	Register New Dataset
MetadataApi	universal_metadata_neurodata_metadata_get_universal_get	GET /neurodata/metadata/get/universal	Universal Metadata
MetadataApi	user_metadata_neurodata_metadata_get_user_get	GET /neurodata/metadata/get/user	User Metadata
NeurodataApi	create_animal_neurodata_metadata_tag_animal_create_post	POST /neurodata/metadata/tag/animal/create	Create Animal
NeurodataApi	create_brain_region_neurodata_metadata_tag_brain_region_create_post	POST /neurodata/metadata/tag/brain_region/create	Create Brain Region
NeurodataApi	create_microscopy_neurodata_metadata_tag_microscopy_create_post	POST /neurodata/metadata/tag/microscopy/create	Create Microscopy
NeurodataApi	create_mutation_neurodata_metadata_tag_mutation_create_post	POST /neurodata/metadata/tag/mutation/create	Create Mutation
NeurodataApi	create_publication_neurodata_metadata_tag_publication_create_post	POST /neurodata/metadata/tag/publication/create	Create Publication
NeurodataApi	dataset_tag_search_neurodata_metadata_dataset_search_post	POST /neurodata/metadata/dataset/search	Dataset Tag Search
NeurodataApi	delete_dataset_neurodata_io_dataset_id_delete_dataset_delete	DELETE /neurodata/io/{dataset_id}/delete_dataset	Delete Dataset
NeurodataApi	download_data_neurodata_io_download_url_get	GET /neurodata/io/download_url	Download Data
NeurodataApi	download_dataset_files_neurodata_io_download_dataset_post	POST /neurodata/io/download_dataset	Download Dataset Files
NeurodataApi	get_dataset_info_neurodata_metadata_dataset_dataset_id_info_get	GET /neurodata/metadata/dataset/{dataset_id}/info	Get Dataset Info
NeurodataApi	get_datasets_neurodata_metadata_dataset_get_all_get	GET /neurodata/metadata/dataset/get/all	Get Datasets
NeurodataApi	get_modifiable_datasets_neurodata_metadata_dataset_get_incomplete_get	GET /neurodata/metadata/dataset/get/incomplete	Get Modifiable Datasets
NeurodataApi	modifiable_datasets_neurodata_metadata_dataset_get_modifiable_get	GET /neurodata/metadata/dataset/get/modifiable	Modifiable Datasets
NeurodataApi	new_dataset_collection_neurodata_metadata_dataset_collection_new_post	POST /neurodata/metadata/dataset/collection/new	New Dataset Collection
NeurodataApi	register_new_dataset_neurodata_metadata_dataset_new_post	POST /neurodata/metadata/dataset/new	Register New Dataset
NeurodataApi	universal_metadata_neurodata_metadata_get_universal_get	GET /neurodata/metadata/get/universal	Universal Metadata
NeurodataApi	upload_dataset_files_neurodata_io_dataset_id_upload_patch	PATCH /neurodata/io/{dataset_id}/upload	Upload Dataset Files
NeurodataApi	upload_dataset_mesh_neurodata_io_dataset_id_upload_url_mesh_get	GET /neurodata/io/{dataset_id}/upload_url/mesh	Upload Dataset Mesh
NeurodataApi	upload_dataset_swb_neurodata_io_dataset_id_upload_url_swb_get	GET /neurodata/io/{dataset_id}/upload_url/swb	Upload Dataset Swb
NeurodataApi	user_metadata_neurodata_metadata_get_user_get	GET /neurodata/metadata/get/user	User Metadata
OauthApi	oauth_github_database_authorize_user_auth_github_authorize_get	GET /user/auth/github/authorize	Oauth:Github.Database.Authorize
OauthApi	oauth_github_database_callback_user_auth_github_callback_get	GET /user/auth/github/callback	Oauth:Github.Database.Callback
OauthApi	oauth_google_database_authorize_user_auth_google_authorize_get	GET /user/auth/google/authorize	Oauth:Google.Database.Authorize
OauthApi	oauth_google_database_callback_user_auth_google_callback_get	GET /user/auth/google/callback	Oauth:Google.Database.Callback
TagApi	create_animal_neurodata_metadata_tag_animal_create_post	POST /neurodata/metadata/tag/animal/create	Create Animal
TagApi	create_brain_region_neurodata_metadata_tag_brain_region_create_post	POST /neurodata/metadata/tag/brain_region/create	Create Brain Region
TagApi	create_microscopy_neurodata_metadata_tag_microscopy_create_post	POST /neurodata/metadata/tag/microscopy/create	Create Microscopy
TagApi	create_mutation_neurodata_metadata_tag_mutation_create_post	POST /neurodata/metadata/tag/mutation/create	Create Mutation
TagApi	create_publication_neurodata_metadata_tag_publication_create_post	POST /neurodata/metadata/tag/publication/create	Create Publication
UserApi	auth_database_login_user_auth_database_login_post	POST /user/auth/database/login	Auth:Database.Login
UserApi	auth_database_login_user_auth_database_login_post_0	POST /user/auth/database/login	Auth:Database.Login
UserApi	auth_database_logout_user_auth_database_logout_post	POST /user/auth/database/logout	Auth:Database.Logout
UserApi	auth_database_logout_user_auth_database_logout_post_0	POST /user/auth/database/logout	Auth:Database.Logout
UserApi	current_user_profile_user_profile_current_get	GET /user/profile/current	Current User Profile
UserApi	oauth_github_database_authorize_user_auth_github_authorize_get	GET /user/auth/github/authorize	Oauth:Github.Database.Authorize
UserApi	oauth_github_database_callback_user_auth_github_callback_get	GET /user/auth/github/callback	Oauth:Github.Database.Callback
UserApi	oauth_google_database_authorize_user_auth_google_authorize_get	GET /user/auth/google/authorize	Oauth:Google.Database.Authorize
UserApi	oauth_google_database_callback_user_auth_google_callback_get	GET /user/auth/google/callback	Oauth:Google.Database.Callback
UserApi	profile_from_scientist_tag_user_profile_scientist_tag_get	GET /user/profile/{scientist_tag}	Profile From Scientist Tag
UserApi	register_register_user_auth_register_post	POST /user/auth/register	Register:Register
UserApi	set_profile_picture_user_profile_current_upload_url_profile_picture_post	POST /user/profile/current/upload_url_profile_picture	Set Profile Picture
UserApi	set_scientist_tag_user_profile_current_set_scientist_tag_post	POST /user/profile/current/set_scientist_tag	Set Scientist Tag
UserApi	verify_request_token_user_auth_request_verify_token_post	POST /user/auth/request-verify-token	Verify:Request-Token
UserApi	verify_verify_user_auth_verify_post	POST /user/auth/verify	Verify:Verify

Documentation For Models

• AnimalModelCreateRead
• AnimalModelJustRead
• BearerResponse
• BodyVerifyRequestTokenUserAuthRequestVerifyTokenPost
• BodyVerifyVerifyUserAuthVerifyPost
• BrainRegionCreateRead
• BrainRegionJustRead
• BrainStructure
• CreateReadDatasetCollectionModel
• DatasetErrorDetail
• DatasetErrorModel
• DatasetSearchModel
• Detail
• FastapiUsersRouterCommonErrorModel
• FileErrorDetail
• FileErrorModel
• FilterDatasets
• GeneExpression
• HTTPValidationError
• Id2LabelResponse
• IdResponse
• IdsResponse
• LocationInner
• MicroscopyCreateRead
• MutationModelCreateRead
• MutationModelJustRead
• NeuroanatomicalDirection
• NewDataset
• OAuth2AuthorizeResponse
• PreSignedS3DownloadSchema
• PreSignedS3UploadUrlSchema
• PublicationCreateRead
• S3Instance
• S3PreSignedDownloadRequest
• SearchResultDataDownload
• SyndbApiCommonSchemaErrorModel
• SyndbTable
• UniversalMetadataResponse
• UploadedSingleDataset
• UserCreate
• UserMetadataResponse
• UserProfile
• UserRead
• ValidationError

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2PasswordBearer

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A

Author