Skip to content

Latest commit

 

History

History
481 lines (430 loc) · 39.5 KB

README.md

File metadata and controls

481 lines (430 loc) · 39.5 KB

aiochris-oag

The ChRIS Ultron BackEnd (CUBE) is the core backend API of ChRIS. It manages ChRIS users, plugins, pipelines, and the provenance of data analyses as ChRIS feeds.

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

  • API version: ${GITHUB_REF_NAME:1}
  • Package version: 0.0.1
  • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://chrisproject.org

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/FNNDSC/openapi-clients.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/FNNDSC/openapi-clients.git)

Then import the package:

import aiochris_oag

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 aiochris_oag

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import aiochris_oag
from aiochris_oag.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 = aiochris_oag.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = aiochris_oag.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'


# Enter a context with an instance of the API client
async with aiochris_oag.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = aiochris_oag.AuthTokenApi(api_client)
    username = 'username_example' # str | 
    password = 'password_example' # str | 

    try:
        api_response = await api_instance.auth_token_create(username, password)
        print("The response of AuthTokenApi->auth_token_create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthTokenApi->auth_token_create: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AuthTokenApi auth_token_create POST /api/v1/auth-token/
ChrisAdminApi chris_admin_api_v1_computeresources_create POST /chris-admin/api/v1/computeresources/
ChrisAdminApi chris_admin_api_v1_computeresources_destroy DELETE /chris-admin/api/v1/computeresources/{id}/
ChrisAdminApi chris_admin_api_v1_computeresources_list GET /chris-admin/api/v1/computeresources/
ChrisAdminApi chris_admin_api_v1_computeresources_retrieve GET /chris-admin/api/v1/computeresources/{id}/
ChrisAdminApi chris_admin_api_v1_create POST /chris-admin/api/v1/
ChrisAdminApi chris_admin_api_v1_destroy DELETE /chris-admin/api/v1/{id}/
ChrisAdminApi chris_admin_api_v1_list GET /chris-admin/api/v1/
ChrisAdminApi chris_admin_api_v1_retrieve GET /chris-admin/api/v1/{id}/
ChrisAdminApi chris_admin_api_v1_update PUT /chris-admin/api/v1/{id}/
ChrisinstanceApi chrisinstance_retrieve GET /api/v1/chrisinstance/{id}/
CommentsApi comments_create POST /api/v1/{id}/comments/
CommentsApi comments_destroy DELETE /api/v1/comments/{id}/
CommentsApi comments_list GET /api/v1/{id}/comments/
CommentsApi comments_retrieve GET /api/v1/comments/{id}/
CommentsApi comments_search_list GET /api/v1/{id}/comments/search/
CommentsApi comments_update PUT /api/v1/comments/{id}/
ComputeresourcesApi computeresources_list GET /api/v1/computeresources/
ComputeresourcesApi computeresources_retrieve GET /api/v1/computeresources/{id}/
ComputeresourcesApi computeresources_search_list GET /api/v1/computeresources/search/
DefaultApi root_destroy DELETE /api/v1/{id}/
DefaultApi root_list GET /api/v1/
DefaultApi root_retrieve GET /api/v1/{id}/
DefaultApi root_update PUT /api/v1/{id}/
DownloadtokensApi downloadtokens_create POST /api/v1/downloadtokens/
DownloadtokensApi downloadtokens_list GET /api/v1/downloadtokens/
DownloadtokensApi downloadtokens_retrieve GET /api/v1/downloadtokens/{id}/
DownloadtokensApi downloadtokens_search_list GET /api/v1/downloadtokens/search/
FilebrowserApi filebrowser_children_list GET /api/v1/filebrowser/{id}/children/
FilebrowserApi filebrowser_create POST /api/v1/filebrowser/
FilebrowserApi filebrowser_destroy DELETE /api/v1/filebrowser/{id}/
FilebrowserApi filebrowser_files_destroy DELETE /api/v1/filebrowser/files/{id}/
FilebrowserApi filebrowser_files_grouppermissions_create POST /api/v1/filebrowser/files/{id}/grouppermissions/
FilebrowserApi filebrowser_files_grouppermissions_destroy DELETE /api/v1/filebrowser/files/grouppermissions/{id}/
FilebrowserApi filebrowser_files_grouppermissions_list GET /api/v1/filebrowser/files/{id}/grouppermissions/
FilebrowserApi filebrowser_files_grouppermissions_retrieve GET /api/v1/filebrowser/files/grouppermissions/{id}/
FilebrowserApi filebrowser_files_grouppermissions_search_list GET /api/v1/filebrowser/files/{id}/grouppermissions/search/
FilebrowserApi filebrowser_files_grouppermissions_update PUT /api/v1/filebrowser/files/grouppermissions/{id}/
FilebrowserApi filebrowser_files_list GET /api/v1/filebrowser/{id}/files/
FilebrowserApi filebrowser_files_retrieve GET /api/v1/filebrowser/files/{id}/
FilebrowserApi filebrowser_files_retrieve_0 GET /api/v1/filebrowser/files/{id}/.
FilebrowserApi filebrowser_files_update PUT /api/v1/filebrowser/files/{id}/
FilebrowserApi filebrowser_files_userpermissions_create POST /api/v1/filebrowser/files/{id}/userpermissions/
FilebrowserApi filebrowser_files_userpermissions_destroy DELETE /api/v1/filebrowser/files/userpermissions/{id}/
FilebrowserApi filebrowser_files_userpermissions_list GET /api/v1/filebrowser/files/{id}/userpermissions/
FilebrowserApi filebrowser_files_userpermissions_retrieve GET /api/v1/filebrowser/files/userpermissions/{id}/
FilebrowserApi filebrowser_files_userpermissions_search_list GET /api/v1/filebrowser/files/{id}/userpermissions/search/
FilebrowserApi filebrowser_files_userpermissions_update PUT /api/v1/filebrowser/files/userpermissions/{id}/
FilebrowserApi filebrowser_grouppermissions_create POST /api/v1/filebrowser/{id}/grouppermissions/
FilebrowserApi filebrowser_grouppermissions_destroy DELETE /api/v1/filebrowser/grouppermissions/{id}/
FilebrowserApi filebrowser_grouppermissions_list GET /api/v1/filebrowser/{id}/grouppermissions/
FilebrowserApi filebrowser_grouppermissions_retrieve GET /api/v1/filebrowser/grouppermissions/{id}/
FilebrowserApi filebrowser_grouppermissions_search_list GET /api/v1/filebrowser/{id}/grouppermissions/search/
FilebrowserApi filebrowser_grouppermissions_update PUT /api/v1/filebrowser/grouppermissions/{id}/
FilebrowserApi filebrowser_linkfiles_destroy DELETE /api/v1/filebrowser/linkfiles/{id}/
FilebrowserApi filebrowser_linkfiles_grouppermissions_create POST /api/v1/filebrowser/linkfiles/{id}/grouppermissions/
FilebrowserApi filebrowser_linkfiles_grouppermissions_destroy DELETE /api/v1/filebrowser/linkfiles/grouppermissions/{id}/
FilebrowserApi filebrowser_linkfiles_grouppermissions_list GET /api/v1/filebrowser/linkfiles/{id}/grouppermissions/
FilebrowserApi filebrowser_linkfiles_grouppermissions_retrieve GET /api/v1/filebrowser/linkfiles/grouppermissions/{id}/
FilebrowserApi filebrowser_linkfiles_grouppermissions_search_list GET /api/v1/filebrowser/linkfiles/{id}/grouppermissions/search/
FilebrowserApi filebrowser_linkfiles_grouppermissions_update PUT /api/v1/filebrowser/linkfiles/grouppermissions/{id}/
FilebrowserApi filebrowser_linkfiles_list GET /api/v1/filebrowser/{id}/linkfiles/
FilebrowserApi filebrowser_linkfiles_retrieve GET /api/v1/filebrowser/linkfiles/{id}/
FilebrowserApi filebrowser_linkfiles_retrieve_0 GET /api/v1/filebrowser/linkfiles/{id}/.
FilebrowserApi filebrowser_linkfiles_update PUT /api/v1/filebrowser/linkfiles/{id}/
FilebrowserApi filebrowser_linkfiles_userpermissions_create POST /api/v1/filebrowser/linkfiles/{id}/userpermissions/
FilebrowserApi filebrowser_linkfiles_userpermissions_destroy DELETE /api/v1/filebrowser/linkfiles/userpermissions/{id}/
FilebrowserApi filebrowser_linkfiles_userpermissions_list GET /api/v1/filebrowser/linkfiles/{id}/userpermissions/
FilebrowserApi filebrowser_linkfiles_userpermissions_retrieve GET /api/v1/filebrowser/linkfiles/userpermissions/{id}/
FilebrowserApi filebrowser_linkfiles_userpermissions_search_list GET /api/v1/filebrowser/linkfiles/{id}/userpermissions/search/
FilebrowserApi filebrowser_linkfiles_userpermissions_update PUT /api/v1/filebrowser/linkfiles/userpermissions/{id}/
FilebrowserApi filebrowser_list GET /api/v1/filebrowser/
FilebrowserApi filebrowser_retrieve GET /api/v1/filebrowser/{id}/
FilebrowserApi filebrowser_search_list GET /api/v1/filebrowser/search/
FilebrowserApi filebrowser_update PUT /api/v1/filebrowser/{id}/
FilebrowserApi filebrowser_userpermissions_create POST /api/v1/filebrowser/{id}/userpermissions/
FilebrowserApi filebrowser_userpermissions_destroy DELETE /api/v1/filebrowser/userpermissions/{id}/
FilebrowserApi filebrowser_userpermissions_list GET /api/v1/filebrowser/{id}/userpermissions/
FilebrowserApi filebrowser_userpermissions_retrieve GET /api/v1/filebrowser/userpermissions/{id}/
FilebrowserApi filebrowser_userpermissions_search_list GET /api/v1/filebrowser/{id}/userpermissions/search/
FilebrowserApi filebrowser_userpermissions_update PUT /api/v1/filebrowser/userpermissions/{id}/
GrouppermissionsApi grouppermissions_create POST /api/v1/{id}/grouppermissions/
GrouppermissionsApi grouppermissions_destroy DELETE /api/v1/grouppermissions/{id}/
GrouppermissionsApi grouppermissions_list GET /api/v1/{id}/grouppermissions/
GrouppermissionsApi grouppermissions_retrieve GET /api/v1/grouppermissions/{id}/
GrouppermissionsApi grouppermissions_search_list GET /api/v1/{id}/grouppermissions/search/
GroupsApi groups_create POST /api/v1/groups/
GroupsApi groups_destroy DELETE /api/v1/groups/{id}/
GroupsApi groups_list GET /api/v1/groups/
GroupsApi groups_retrieve GET /api/v1/groups/{id}/
GroupsApi groups_search_list GET /api/v1/groups/search/
GroupsApi groups_users_create POST /api/v1/groups/{id}/users/
GroupsApi groups_users_destroy DELETE /api/v1/groups/users/{id}/
GroupsApi groups_users_list GET /api/v1/groups/{id}/users/
GroupsApi groups_users_retrieve GET /api/v1/groups/users/{id}/
GroupsApi groups_users_search_list GET /api/v1/groups/{id}/users/search/
NoteApi note_retrieve GET /api/v1/note{id}/
NoteApi note_update PUT /api/v1/note{id}/
PacsApi pacs_files_list GET /api/v1/pacs/files/
PacsApi pacs_files_retrieve GET /api/v1/pacs/files/{id}/
PacsApi pacs_files_retrieve_0 GET /api/v1/pacs/files/{id}/.
PacsApi pacs_files_search_list GET /api/v1/pacs/files/search/
PacsApi pacs_series_list GET /api/v1/pacs/series/
PacsApi pacs_series_retrieve GET /api/v1/pacs/series/{id}/
PacsApi pacs_series_search_list GET /api/v1/pacs/series/search/
PipelinesApi all_workflows_list GET /api/v1/pipelines/workflows/
PipelinesApi pipelines_boolean_parameter_retrieve GET /api/v1/pipelines/boolean-parameter/{id}/
PipelinesApi pipelines_boolean_parameter_update PUT /api/v1/pipelines/boolean-parameter/{id}/
PipelinesApi pipelines_create POST /api/v1/pipelines/
PipelinesApi pipelines_destroy DELETE /api/v1/pipelines/{id}/
PipelinesApi pipelines_float_parameter_retrieve GET /api/v1/pipelines/float-parameter/{id}/
PipelinesApi pipelines_float_parameter_update PUT /api/v1/pipelines/float-parameter/{id}/
PipelinesApi pipelines_integer_parameter_retrieve GET /api/v1/pipelines/integer-parameter/{id}/
PipelinesApi pipelines_integer_parameter_update PUT /api/v1/pipelines/integer-parameter/{id}/
PipelinesApi pipelines_json_retrieve GET /api/v1/pipelines/{id}/json/
PipelinesApi pipelines_list GET /api/v1/pipelines/
PipelinesApi pipelines_parameters_list GET /api/v1/pipelines/{id}/parameters/
PipelinesApi pipelines_pipings_list GET /api/v1/pipelines/{id}/pipings/
PipelinesApi pipelines_pipings_retrieve GET /api/v1/pipelines/pipings/{id}/
PipelinesApi pipelines_plugins_list GET /api/v1/pipelines/{id}/plugins/
PipelinesApi pipelines_retrieve GET /api/v1/pipelines/{id}/
PipelinesApi pipelines_search_list GET /api/v1/pipelines/search/
PipelinesApi pipelines_sourcefiles_create POST /api/v1/pipelines/sourcefiles/
PipelinesApi pipelines_sourcefiles_list GET /api/v1/pipelines/sourcefiles/
PipelinesApi pipelines_sourcefiles_retrieve GET /api/v1/pipelines/sourcefiles/{id}/
PipelinesApi pipelines_sourcefiles_retrieve_0 GET /api/v1/pipelines/sourcefiles/{id}/.
PipelinesApi pipelines_sourcefiles_search_list GET /api/v1/pipelines/sourcefiles/search/
PipelinesApi pipelines_string_parameter_retrieve GET /api/v1/pipelines/string-parameter/{id}/
PipelinesApi pipelines_string_parameter_update PUT /api/v1/pipelines/string-parameter/{id}/
PipelinesApi pipelines_update PUT /api/v1/pipelines/{id}/
PipelinesApi pipelines_workflows_create POST /api/v1/pipelines/{id}/workflows/
PipelinesApi pipelines_workflows_destroy DELETE /api/v1/pipelines/workflows/{id}/
PipelinesApi pipelines_workflows_plugininstances_list GET /api/v1/pipelines/workflows/{id}/plugininstances/
PipelinesApi pipelines_workflows_retrieve GET /api/v1/pipelines/workflows/{id}/
PipelinesApi pipelines_workflows_search_list GET /api/v1/pipelines/workflows/search/
PipelinesApi pipelines_workflows_update PUT /api/v1/pipelines/workflows/{id}/
PipelinesApi workflows_list GET /api/v1/pipelines/{id}/workflows/
PlugininstancesApi plugininstances_list GET /api/v1/{id}/plugininstances/
PluginsApi all_plugins_instances_list GET /api/v1/plugins/instances/
PluginsApi plugins_boolean_parameter_retrieve GET /api/v1/plugins/boolean-parameter/{id}/
PluginsApi plugins_computeresources_list GET /api/v1/plugins/{id}/computeresources/
PluginsApi plugins_float_parameter_retrieve GET /api/v1/plugins/float-parameter/{id}/
PluginsApi plugins_instances_create POST /api/v1/plugins/{id}/instances/
PluginsApi plugins_instances_descendants_list GET /api/v1/plugins/instances/{id}/descendants/
PluginsApi plugins_instances_destroy DELETE /api/v1/plugins/instances/{id}/
PluginsApi plugins_instances_list GET /api/v1/plugins/{id}/instances/
PluginsApi plugins_instances_parameters_list GET /api/v1/plugins/instances/{id}/parameters/
PluginsApi plugins_instances_retrieve GET /api/v1/plugins/instances/{id}/
PluginsApi plugins_instances_search_list GET /api/v1/plugins/instances/search/
PluginsApi plugins_instances_splits_create POST /api/v1/plugins/instances/{id}/splits/
PluginsApi plugins_instances_splits_list GET /api/v1/plugins/instances/{id}/splits/
PluginsApi plugins_instances_splits_retrieve GET /api/v1/plugins/instances/splits/{id}/
PluginsApi plugins_instances_update PUT /api/v1/plugins/instances/{id}/
PluginsApi plugins_integer_parameter_retrieve GET /api/v1/plugins/integer-parameter/{id}/
PluginsApi plugins_list GET /api/v1/plugins/
PluginsApi plugins_metas_list GET /api/v1/plugins/metas/
PluginsApi plugins_metas_plugins_list GET /api/v1/plugins/metas/{id}/plugins/
PluginsApi plugins_metas_retrieve GET /api/v1/plugins/metas/{id}/
PluginsApi plugins_metas_search_list GET /api/v1/plugins/metas/search/
PluginsApi plugins_parameters_list GET /api/v1/plugins/{id}/parameters/
PluginsApi plugins_parameters_retrieve GET /api/v1/plugins/parameters/{id}/
PluginsApi plugins_path_parameter_retrieve GET /api/v1/plugins/path-parameter/{id}/
PluginsApi plugins_retrieve GET /api/v1/plugins/{id}/
PluginsApi plugins_search_list GET /api/v1/plugins/search/
PluginsApi plugins_string_parameter_retrieve GET /api/v1/plugins/string-parameter/{id}/
PluginsApi plugins_unextpath_parameter_retrieve GET /api/v1/plugins/unextpath-parameter/{id}/
PublicfeedsApi publicfeeds_list GET /api/v1/publicfeeds/
PublicfeedsApi publicfeeds_search_list GET /api/v1/publicfeeds/search/
SchemaApi schema_retrieve GET /schema/
SearchApi search_list GET /api/v1/search/
TaggingsApi taggings_create POST /api/v1/{id}/taggings/
TaggingsApi taggings_destroy DELETE /api/v1/taggings/{id}/
TaggingsApi taggings_list GET /api/v1/{id}/taggings/
TaggingsApi taggings_retrieve GET /api/v1/taggings/{id}/
TagsApi feed_tags_list GET /api/v1/{id}/tags/
TagsApi tags_create POST /api/v1/tags/
TagsApi tags_destroy DELETE /api/v1/tags/{id}/
TagsApi tags_feeds_list GET /api/v1/tags/{id}/feeds/
TagsApi tags_list GET /api/v1/tags/
TagsApi tags_retrieve GET /api/v1/tags/{id}/
TagsApi tags_search_list GET /api/v1/tags/search/
TagsApi tags_taggings_create POST /api/v1/tags/{id}/taggings/
TagsApi tags_taggings_list GET /api/v1/tags/{id}/taggings/
TagsApi tags_update PUT /api/v1/tags/{id}/
UserfilesApi userfiles_create POST /api/v1/userfiles/
UserfilesApi userfiles_destroy DELETE /api/v1/userfiles/{id}/
UserfilesApi userfiles_list GET /api/v1/userfiles/
UserfilesApi userfiles_retrieve GET /api/v1/userfiles/{id}/
UserfilesApi userfiles_retrieve_0 GET /api/v1/userfiles/{id}/.
UserfilesApi userfiles_search_list GET /api/v1/userfiles/search/
UserfilesApi userfiles_update PUT /api/v1/userfiles/{id}/
UserpermissionsApi userpermissions_create POST /api/v1/{id}/userpermissions/
UserpermissionsApi userpermissions_destroy DELETE /api/v1/userpermissions/{id}/
UserpermissionsApi userpermissions_list GET /api/v1/{id}/userpermissions/
UserpermissionsApi userpermissions_retrieve GET /api/v1/userpermissions/{id}/
UserpermissionsApi userpermissions_search_list GET /api/v1/{id}/userpermissions/search/
UsersApi users_create POST /api/v1/users/
UsersApi users_groups_list GET /api/v1/users/{id}/groups/
UsersApi users_list GET /api/v1/users/
UsersApi users_retrieve GET /api/v1/users/{id}/
UsersApi users_update PUT /api/v1/users/{id}/

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

DownloadTokenInQueryString

  • Type: API key
  • API key parameter name: download_token
  • Location: HTTP header

basicAuth

  • Type: HTTP basic authentication

cookieAuth

  • Type: API key
  • API key parameter name: sessionid
  • Location:

tokenAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

dev@babymri.org