AI API
Project description
ai-api
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.0
- Package version: 1.0.0
- Generator version: 7.4.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 ai_api
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 ai_api
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import ai_api
from ai_api.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 = ai_api.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.
configuration.access_token = os.environ["ACCESS_TOKEN"]
# Enter a context with an instance of the API client
with ai_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ai_api.DefaultApi(api_client)
cluster_in = ai_api.ClusterIn() # ClusterIn |
try:
# Create Cluster
api_response = api_instance.create_cluster_clusters_post(cluster_in)
print("The response of DefaultApi->create_cluster_clusters_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->create_cluster_clusters_post: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | create_cluster_clusters_post | POST /clusters/ | Create Cluster |
| DefaultApi | create_job_instance_job_instances_post | POST /job_instances/ | Create Job Instance |
| DefaultApi | create_managed_ssh_key_managed_ssh_keys_post | POST /managed_ssh_keys/ | Create Managed Ssh Key |
| DefaultApi | create_provider_providers_post | POST /providers/ | Create Provider |
| DefaultApi | create_repository_repositories_post | POST /repositories/ | Create Repository |
| DefaultApi | create_ssh_key_ssh_keys_post | POST /ssh_keys/ | Create Ssh Key |
| DefaultApi | delete_cluster_clusters_cluster_id_delete | DELETE /clusters/{cluster_id} | Delete Cluster |
| DefaultApi | delete_job_instance_job_instances_job_instance_id_delete | DELETE /job_instances/{job_instance_id} | Delete Job Instance |
| DefaultApi | delete_provider_providers_provider_id_delete | DELETE /providers/{provider_id} | Delete Provider |
| DefaultApi | delete_ssh_key_ssh_keys_key_name_delete | DELETE /ssh_keys/{key_name} | Delete Ssh Key |
| DefaultApi | get_managed_ssh_key_managed_ssh_keys_get | GET /managed_ssh_keys/ | Get Managed Ssh Key |
| DefaultApi | list_clusters_clusters_get | GET /clusters/ | List Clusters |
| DefaultApi | list_job_instances_job_instances_get | GET /job_instances/ | List Job Instances |
| DefaultApi | list_providers_providers_get | GET /providers/ | List Providers |
| DefaultApi | list_providers_types_provider_types_get | GET /provider_types/ | List Providers Types |
| DefaultApi | list_repositories_repositories_get | GET /repositories/ | List Repositories |
| DefaultApi | list_ssh_keys_ssh_keys_get | GET /ssh_keys/ | List Ssh Keys |
| DefaultApi | login_token_post | POST /token | Login |
| DefaultApi | read_cluster_clusters_cluster_id_get | GET /clusters/{cluster_id} | Read Cluster |
| DefaultApi | read_job_instance_by_name_job_instances_by_name_get | GET /job_instances/by_name/ | Read Job Instance By Name |
| DefaultApi | read_job_instance_job_instances_job_instance_id_get | GET /job_instances/{job_instance_id} | Read Job Instance |
| DefaultApi | read_log_logs_job_instance_id_get | GET /logs/{job_instance_id} | Read Log |
| DefaultApi | read_provider_by_name_providers_by_name_get | GET /providers/by_name/ | Read Provider By Name |
| DefaultApi | read_provider_providers_provider_id_get | GET /providers/{provider_id} | Read Provider |
| DefaultApi | read_provider_type_by_name_provider_types_by_name_get | GET /provider_types/by_name | Read Provider Type By Name |
| DefaultApi | read_repository_by_name_repositories_by_name_get | GET /repositories/by_name/ | Read Repository By Name |
| DefaultApi | read_ssh_key_by_name_ssh_keys_by_name_get | GET /ssh_keys/by_name/ | Read Ssh Key By Name |
| DefaultApi | read_users_me_users_me_get | GET /users/me | Read Users Me |
| DefaultApi | update_repository_repositories_by_name_patch | PATCH /repositories/by_name/ | Update Repository |
Documentation For Models
- ClientId
- ClientSecret
- ClusterIn
- ClusterOut
- FinishedAt
- GrantType
- HTTPValidationError
- IdOut
- JobInstanceIn
- JobInstanceOut
- LogOut
- ProviderIn
- ProviderOut
- ProviderTypeOut
- RepositoryIn
- RepositoryOut
- SshKeyIn
- SshKeyOut
- ValidationError
- ValidationErrorLocInner
Documentation For Authorization
Authentication schemes defined for the API:
OAuth2PasswordBearer
- Type: OAuth
- Flow: password
- Authorization URL:
- Scopes: N/A
Author
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file codedepot_ai_api-1.1.0.tar.gz.
File metadata
- Download URL: codedepot_ai_api-1.1.0.tar.gz
- Upload date:
- Size: 35.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.14.0 CPython/3.11.8 Darwin/23.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b0ad998cb9761923b53f47c459c1ca22435800b5e18bedea723588388318cfcf
|
|
| MD5 |
e63041070e1a1e5c55fd70f9f4f5a1ef
|
|
| BLAKE2b-256 |
ba0c48c079be6d9072fd806b483af7dacb9bbe3859c127d637558e952b78143f
|
File details
Details for the file codedepot_ai_api-1.1.0-py3-none-any.whl.
File metadata
- Download URL: codedepot_ai_api-1.1.0-py3-none-any.whl
- Upload date:
- Size: 74.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: pdm/2.14.0 CPython/3.11.8 Darwin/23.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f352c4dc110174ac5166b542b12a7be04afe0830f13684efc8b29da85c68c0e7
|
|
| MD5 |
c44768ea15f4fde0df8323d8a2a52907
|
|
| BLAKE2b-256 |
01ead7a50f7953eaeb42d78eb950e4ef1c9f7fb6f37624a72f216e3f61a33a3b
|