fyn-api-client 0.0.14

Fyn-Tech API

fyn-api-client

Schema for the REST API of fyn-api

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

• API version: 0.0.1
• Package version: 0.0.14
• Generator version: 7.18.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

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 fyn_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 fyn_api_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import fyn_api_client
from fyn_api_client.rest import ApiException
from pprint import pprint

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

# 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 = fyn_api_client.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 Bearer authorization (JWT): jwtAuth
configuration = fyn_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

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

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


# Enter a context with an instance of the API client
with fyn_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fyn_api_client.AccountsApi(api_client)
    user_request = fyn_api_client.UserRequest() # UserRequest | 

    try:
        api_response = api_instance.accounts_users_create(user_request)
        print("The response of AccountsApi->accounts_users_create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->accounts_users_create: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8000

Class	Method	HTTP request	Description
AccountsApi	accounts_users_create	POST /accounts/users/
AccountsApi	accounts_users_destroy	DELETE /accounts/users/{id}/
AccountsApi	accounts_users_partial_update	PATCH /accounts/users/{id}/
AccountsApi	accounts_users_retrieve	GET /accounts/users/{id}/
AccountsApi	accounts_users_update	PUT /accounts/users/{id}/
AccountsApi	accounts_users_update_password_create	POST /accounts/users/{id}/update-password/
ApiApi	api_token_create	POST /api/token/
ApiApi	api_token_refresh_create	POST /api/token/refresh/
ApiApi	api_token_verify_create	POST /api/token/verify/
ApplicationRegistryApi	application_registry_list	GET /application_registry/
ApplicationRegistryApi	application_registry_program_retrieve	GET /application_registry/{id}/program/
ApplicationRegistryApi	application_registry_program_schema_retrieve	GET /application_registry/{id}/program_schema/
ApplicationRegistryApi	application_registry_retrieve	GET /application_registry/{id}/
AuthApi	auth_user_login_create	POST /auth/user/login/	User login (DEPRECATED - Use /api/token/ instead)
AuthApi	auth_user_logout_create	POST /auth/user/logout/	User logout
JobManagerApi	job_manager_resources_runner_create	POST /job_manager/resources/runner/
JobManagerApi	job_manager_resources_runner_destroy	DELETE /job_manager/resources/runner/{id}/
JobManagerApi	job_manager_resources_runner_download_retrieve	GET /job_manager/resources/runner/{id}/download/
JobManagerApi	job_manager_resources_runner_list	GET /job_manager/resources/runner/
JobManagerApi	job_manager_resources_runner_partial_update	PATCH /job_manager/resources/runner/{id}/
JobManagerApi	job_manager_resources_runner_retrieve	GET /job_manager/resources/runner/{id}/
JobManagerApi	job_manager_resources_runner_update	PUT /job_manager/resources/runner/{id}/
JobManagerApi	job_manager_resources_users_create	POST /job_manager/resources/users/
JobManagerApi	job_manager_resources_users_destroy	DELETE /job_manager/resources/users/{id}/
JobManagerApi	job_manager_resources_users_list	GET /job_manager/resources/users/
JobManagerApi	job_manager_resources_users_partial_update	PATCH /job_manager/resources/users/{id}/
JobManagerApi	job_manager_resources_users_retrieve	GET /job_manager/resources/users/{id}/
JobManagerApi	job_manager_resources_users_update	PUT /job_manager/resources/users/{id}/
JobManagerApi	job_manager_runner_create	POST /job_manager/runner/
JobManagerApi	job_manager_runner_destroy	DELETE /job_manager/runner/{id}/
JobManagerApi	job_manager_runner_list	GET /job_manager/runner/
JobManagerApi	job_manager_runner_partial_update	PATCH /job_manager/runner/{id}/
JobManagerApi	job_manager_runner_retrieve	GET /job_manager/runner/{id}/
JobManagerApi	job_manager_runner_update	PUT /job_manager/runner/{id}/
JobManagerApi	job_manager_users_create	POST /job_manager/users/
JobManagerApi	job_manager_users_destroy	DELETE /job_manager/users/{id}/
JobManagerApi	job_manager_users_list	GET /job_manager/users/
JobManagerApi	job_manager_users_partial_update	PATCH /job_manager/users/{id}/
JobManagerApi	job_manager_users_retrieve	GET /job_manager/users/{id}/
JobManagerApi	job_manager_users_update	PUT /job_manager/users/{id}/
RunnerManagerApi	runner_manager_runner_create	POST /runner_manager/runner/
RunnerManagerApi	runner_manager_runner_destroy	DELETE /runner_manager/runner/{id}/
RunnerManagerApi	runner_manager_runner_list	GET /runner_manager/runner/
RunnerManagerApi	runner_manager_runner_partial_update	PATCH /runner_manager/runner/{id}/
RunnerManagerApi	runner_manager_runner_retrieve	GET /runner_manager/runner/{id}/
RunnerManagerApi	runner_manager_runner_update	PUT /runner_manager/runner/{id}/
RunnerManagerApi	runner_manager_users_create	POST /runner_manager/users/
RunnerManagerApi	runner_manager_users_destroy	DELETE /runner_manager/users/{id}/
RunnerManagerApi	runner_manager_users_list	GET /runner_manager/users/
RunnerManagerApi	runner_manager_users_partial_update	PATCH /runner_manager/users/{id}/
RunnerManagerApi	runner_manager_users_retrieve	GET /runner_manager/users/{id}/
RunnerManagerApi	runner_manager_users_update	PUT /runner_manager/users/{id}/

Documentation For Models

• App
• AuthUserLoginCreate200Response
• AuthUserLogoutCreate200Response
• JobInfo
• JobInfoRequest
• JobInfoRunner
• JobInfoRunnerRequest
• JobResource
• JobResourceRequest
• JobResourceRunner
• LoginRequest
• PasswordUpdateRequest
• PatchedJobInfoRequest
• PatchedJobInfoRunnerRequest
• PatchedJobResourceRequest
• PatchedRunnerInfoRequest
• PatchedUserRequest
• ResourceTypeEnum
• RunnerInfo
• RunnerInfoRequest
• StateEnum
• StatusEnum
• TokenObtainPair
• TokenObtainPairRequest
• TokenRefresh
• TokenRefreshRequest
• TokenVerifyRequest
• TypeEnum
• User
• UserRequest

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

jwtAuth

• Type: Bearer authentication (JWT)

runnerTokenAuth

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

tokenAuth

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

Author