tickforge-client

与Uptick内部资源交互的API

此Python包由OpenAPI Generator项目自动生成

• API版本：1.0.0
• 包版本：1.6.0
• 构建包：org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen

需求。

Python 3.7+

安装 & 使用

pip安装

如果Python包托管在仓库中，您可以直接使用以下方式安装

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

(您可能需要以root权限运行pip：sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

然后导入包

import tickforge_client

Setuptools

通过Setuptools安装。

python setup.py install --user

(或使用sudo python setup.py install为所有用户安装包)

然后导入包

import tickforge_client

测试

执行pytest来运行测试。

入门

请按照安装过程进行操作，然后运行以下命令

import time
import tickforge_client
from tickforge_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://tickforge.onuptick.com
# See configuration.py for a list of all supported configuration parameters.
configuration = tickforge_client.Configuration(
    host = "https://tickforge.onuptick.com"
)



# Enter a context with an instance of the API client
with tickforge_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = tickforge_client.AuthApi(api_client)
    code = 'code_example' # str | 
    state = 'state_example' # str | 

    try:
        # Cognito Callback
        api_response = api_instance.cognito_callback_api_auth_cognito_callback_get(code, state)
        print("The response of AuthApi->cognito_callback_api_auth_cognito_callback_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthApi->cognito_callback_api_auth_cognito_callback_get: %s\n" % e)

API端点文档

所有URI相对于https://tickforge.onuptick.com

Qadestroy

• suspend_workspace_api_workspaces_workspace_name_suspend_post
• POST /api/workspaces/{workspace_name}/suspend
• 挂起工作空间
• Documentation For Models
• AlwaysActive
• Backup
• BaseUser
• BatchId
• BodyBumpApiWorkspacesBumpPost
• BodyBumpAppApiWorkspacesAppNameBumpPost
• BodyQadeployApiWorkspacesQadeployPost
• BodyQadestroyApiWorkspacesQadestroyPost
• Branch
• BuildSchema
• Cluster
• CodeMetricBlobPayload
• CodeMetricBlobResponse
• CopyDBPayload
• CreateBackupResponse
• CreateBuildPayload
• CreateMetricPayload
• CreateWorkspacePayload
• Deleted
• DisplayName
• Email
• Error
• FirstName
• HTTPValidationError
• Image32
• IsAdmin
• IsAppUser
• IsBot
• IsEmailConfirmed
• IsOwner
• IsPrimaryOwner
• IsRestricted
• 用户列表响应
• 指标
• 指标名称
• 命名空间
• 偏移量
• 配置文件
• 真实姓名
• 响应元数据
• 服务器时区
• 服务器类型
• 大小
• Slack成员
• 团队
• 团队ID
• 标题
• 令牌响应
• Tz
• Tz标签
• Tz偏移量
• 更新时间
• 验证错误
• 内部验证错误位置
• 版本配置
• 工作区
• 工作区集群
• XHub签名256

授权说明文档

API定义的认证方案：

HTTPBearer

• 类型：Bearer认证

作者