Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Files = map[string]string{
"api.swagger.json": `{
"swagger": "2.0",
"info": {
"title": "OpenPitrix Project",
"version": "0.0.1",
"contact": {
"name": "OpenPitrix Project",
"url": "https://openpitrix.io"
}
},
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/v1/cando": {
"post": {
"operationId": "CanDo",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCanDoResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCanDoRequest"
}
}
],
"tags": [
"AccessManager"
]
}
},
"/v1/groups": {
"get": {
"operationId": "DescribeGroups",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeGroupsResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "root_group_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "parent_group_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "group_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "group_path",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "group_name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AccountManager"
]
},
"delete": {
"operationId": "DeleteGroups",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDeleteGroupsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteGroupsRequest"
}
}
],
"tags": [
"AccountManager"
]
},
"post": {
"summary": "group",
"operationId": "CreateGroup",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateGroupResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateGroupRequest"
}
}
],
"tags": [
"AccountManager"
]
},
"patch": {
"operationId": "ModifyGroup",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixModifyGroupResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyGroupRequest"
}
}
],
"tags": [
"AccountManager"
]
}
},
"/v1/groups:join": {
"post": {
"operationId": "JoinGroup",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixJoinGroupResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixJoinGroupRequest"
}
}
],
"tags": [
"AccountManager"
]
}
},
"/v1/groups:leave": {
"post": {
"operationId": "LeaveGroup",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixLeaveGroupResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixLeaveGroupRequest"
}
}
],
"tags": [
"AccountManager"
]
}
},
"/v1/groups_detail": {
"get": {
"operationId": "DescribeGroupsDetail",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeGroupsDetailResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "root_group_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "parent_group_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "group_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "group_path",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "group_name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AccountManager"
]
}
},
"/v1/isv_users": {
"post": {
"operationId": "IsvCreateUser",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateUserResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateUserRequest"
}
}
],
"tags": [
"AccountManager"
]
}
},
"/v1/oauth2/client": {
"post": {
"operationId": "CreateClient",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateClientResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateClientRequest"
}
}
],
"tags": [
"TokenManager"
]
}
},
"/v1/oauth2/token": {
"post": {
"operationId": "Token",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixTokenResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixTokenRequest"
}
}
],
"tags": [
"TokenManager"
],
"security": []
}
},
"/v1/role": {
"get": {
"operationId": "GetRole",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixGetRoleResponse"
}
}
},
"parameters": [
{
"name": "role_id",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"AccessManager"
]
}
},
"/v1/roles": {
"get": {
"summary": "admin permission",
"operationId": "DescribeRoles",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRolesResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "role_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "role_name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "portal",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "action_bundle_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AccessManager"
]
},
"delete": {
"operationId": "DeleteRoles",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDeleteRolesResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteRolesRequest"
}
}
],
"tags": [
"AccessManager"
]
},
"post": {
"operationId": "CreateRole",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateRoleResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateRoleRequest"
}
}
],
"tags": [
"AccessManager"
]
},
"patch": {
"operationId": "ModifyRole",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixModifyRoleResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyRoleRequest"
}
}
],
"tags": [
"AccessManager"
]
}
},
"/v1/roles:module": {
"get": {
"operationId": "GetRoleModule",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixGetRoleModuleResponse"
}
}
},
"parameters": [
{
"name": "role_id",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"AccessManager"
]
},
"post": {
"operationId": "ModifyRoleModule",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixModifyRoleModuleResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyRoleModuleRequest"
}
}
],
"tags": [
"AccessManager"
]
}
},
"/v1/user:role": {
"delete": {
"operationId": "UnbindUserRole",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixUnbindUserRoleResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixUnbindUserRoleRequest"
}
}
],
"tags": [
"AccessManager"
]
},
"post": {
"operationId": "BindUserRole",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixBindUserRoleResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixBindUserRoleRequest"
}
}
],
"tags": [
"AccessManager"
]
}
},
"/v1/users": {
"get": {
"operationId": "DescribeUsers",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeUsersResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "root_group_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "group_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "user_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "role_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "username",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "email",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "phone_number",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AccountManager"
]
},
"delete": {
"operationId": "DeleteUsers",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDeleteUsersResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteUsersRequest"
}
}
],
"tags": [
"AccountManager"
]
},
"post": {
"summary": "admin permission",
"operationId": "CreateUser",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateUserResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateUserRequest"
}
}
],
"tags": [
"AccountManager"
]
},
"patch": {
"operationId": "ModifyUser",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixModifyUserResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyUserRequest"
}
}
],
"tags": [
"AccountManager"
]
}
},
"/v1/users/password:change": {
"post": {
"operationId": "ChangePassword",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixChangePasswordResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixChangePasswordRequest"
}
}
],
"tags": [
"AccountManager"
]
}
},
"/v1/users/password:reset": {
"get": {
"operationId": "GetPasswordReset",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixGetPasswordResetResponse"
}
}
},
"parameters": [
{
"name": "reset_id",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"AccountManager"
]
},
"post": {
"operationId": "CreatePasswordReset",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreatePasswordResetResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreatePasswordResetRequest"
}
}
],
"tags": [
"AccountManager"
]
}
},
"/v1/users/password:validate": {
"post": {
"operationId": "ValidateUserPassword",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixValidateUserPasswordResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixValidateUserPasswordRequest"
}
}
],
"tags": [
"AccountManager"
]
}
},
"/v1/users_detail": {
"get": {
"operationId": "DescribeUsersDetail",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeUsersDetailResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "root_group_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "group_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "user_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "role_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "username",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "email",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "phone_number",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AccountManager"
]
}
},
"/v1/active_app_versions": {
"get": {
"summary": "describe app versions with filter",
"operationId": "DescribeActiveAppVersions",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeAppVersionsResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "version_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "description",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "package_name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "type",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AppManager"
]
}
},
"/v1/active_apps": {
"get": {
"summary": "describe apps with filter",
"operationId": "DescribeActiveApps",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeAppsResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "repo_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "chart_name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "category_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app/attachment": {
"patch": {
"summary": "UploadAppAttachment",
"operationId": "UploadAppAttachment",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixUploadAppAttachmentResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixUploadAppAttachmentRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/cancel": {
"post": {
"summary": "cancel app version",
"operationId": "CancelAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCancelAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCancelAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/delete": {
"post": {
"summary": "delete app version",
"operationId": "DeleteAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDeleteAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/pass/business": {
"post": {
"summary": "operator type business pass app version",
"operationId": "BusinessPassAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixPassAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixPassAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/pass/isv": {
"post": {
"summary": "operator type isv pass app version",
"operationId": "IsvPassAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixPassAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixPassAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/pass/technical": {
"post": {
"summary": "operator type technical pass app version",
"operationId": "TechnicalPassAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixPassAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixPassAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/recover": {
"post": {
"summary": "recover app version",
"operationId": "RecoverAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixRecoverAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixRecoverAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/reject/business": {
"post": {
"summary": "operator type business reject app version",
"operationId": "BusinessRejectAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixRejectAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixRejectAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/reject/isv": {
"post": {
"summary": "operator type isv reject app version",
"operationId": "IsvRejectAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixRejectAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixRejectAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/reject/technical": {
"post": {
"summary": "operator type reject app version",
"operationId": "TechnicalRejectAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixRejectAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixRejectAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/release": {
"post": {
"summary": "release app version",
"operationId": "ReleaseAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixReleaseAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixReleaseAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/review/business": {
"post": {
"summary": "operator type business start review app version",
"operationId": "BusinessReviewAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixReviewAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixReviewAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/review/isv": {
"post": {
"summary": "operator type isv start review app version",
"operationId": "IsvReviewAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixReviewAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixReviewAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/review/technical": {
"post": {
"summary": "operator type technical start review app version",
"operationId": "TechnicalReviewAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixReviewAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixReviewAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/submit": {
"post": {
"summary": "submit app version",
"operationId": "SubmitAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixSubmitAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixSubmitAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/action/suspend": {
"post": {
"summary": "suspend app version",
"operationId": "SuspendAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixSuspendAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixSuspendAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/package": {
"get": {
"summary": "get the package content of app version",
"operationId": "GetAppVersionPackage",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixGetAppVersionPackageResponse"
}
}
},
"parameters": [
{
"name": "version_id",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version/package/files": {
"get": {
"summary": "get the package files content of app version",
"operationId": "GetAppVersionPackageFiles",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixGetAppVersionPackageFilesResponse"
}
}
},
"parameters": [
{
"name": "version_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "files",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version_audits": {
"get": {
"summary": "DescribeAppVersionAudits",
"operationId": "DescribeAppVersionAudits",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeAppVersionAuditsResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "version_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "operator",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "operator_type",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_version_reviews": {
"get": {
"summary": "DescribeAppVersionReviews",
"operationId": "DescribeAppVersionReviews",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeAppVersionReviewsResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "version_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "review_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "reviewer",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_versions": {
"get": {
"summary": "describe app versions with filter",
"operationId": "DescribeAppVersions",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeAppVersionsResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "version_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "description",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "package_name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "type",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AppManager"
]
},
"post": {
"summary": "create app version",
"operationId": "CreateAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
},
"patch": {
"summary": "modify app version",
"operationId": "ModifyAppVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixModifyAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/apps": {
"get": {
"summary": "describe apps with filter",
"operationId": "DescribeApps",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeAppsResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "repo_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "chart_name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "category_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"AppManager"
]
},
"delete": {
"summary": "delete apps",
"operationId": "DeleteApps",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDeleteAppsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteAppsRequest"
}
}
],
"tags": [
"AppManager"
]
},
"post": {
"summary": "create app",
"operationId": "CreateApp",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateAppResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateAppRequest"
}
}
],
"tags": [
"AppManager"
]
},
"patch": {
"summary": "modify app",
"operationId": "ModifyApp",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixModifyAppResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyAppRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/apps/statistics": {
"get": {
"summary": "get app statistics",
"operationId": "GetAppStatistics",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixGetAppStatisticsResponse"
}
}
},
"tags": [
"AppManager"
]
}
},
"/v1/apps/validate_package": {
"post": {
"summary": "ValidatePackage",
"operationId": "ValidatePackage",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixValidatePackageResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixValidatePackageRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/attachments": {
"get": {
"summary": "get attachment",
"operationId": "GetAttachment",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixGetAttachmentResponse"
}
}
},
"parameters": [
{
"name": "attachment_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "filename",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"AttachmentService"
]
}
},
"/v1/categories": {
"get": {
"summary": "describe categories with filter",
"operationId": "DescribeCategories",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeCategoriesResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "category_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"CategoryManager"
]
},
"delete": {
"summary": "delete categories",
"operationId": "DeleteCategories",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDeleteCategoriesResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteCategoriesRequest"
}
}
],
"tags": [
"CategoryManager"
]
},
"post": {
"summary": "create category",
"operationId": "CreateCategory",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateCategoryResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateCategoryRequest"
}
}
],
"tags": [
"CategoryManager"
]
},
"patch": {
"summary": "modify category",
"operationId": "ModifyCategory",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixModifyCategoryResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyCategoryRequest"
}
}
],
"tags": [
"CategoryManager"
]
}
},
"/v1/clusters": {
"get": {
"summary": "describe clusters",
"operationId": "DescribeClusters",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeClustersResponse"
}
}
},
"parameters": [
{
"name": "cluster_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "version_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "runtime_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "frontgate_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "external_cluster_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "cluster_type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "with_detail",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "created_date",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/add_nodes": {
"post": {
"summary": "add cluster nodes",
"operationId": "AddClusterNodes",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixAddClusterNodesResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixAddClusterNodesRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/apps": {
"get": {
"summary": "describe app clusters",
"operationId": "DescribeAppClusters",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeAppClustersResponse"
}
}
},
"parameters": [
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "with_detail",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "created_date",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/cease": {
"post": {
"summary": "cease clusters",
"operationId": "CeaseClusters",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCeaseClustersResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCeaseClustersRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/create": {
"post": {
"summary": "create cluster",
"operationId": "CreateCluster",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateClusterResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateClusterRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/delete": {
"post": {
"summary": "delete clusters",
"operationId": "DeleteClusters",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDeleteClustersResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteClustersRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/delete_nodes": {
"post": {
"summary": "delete cluster nodes",
"operationId": "DeleteClusterNodes",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDeleteClusterNodesResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteClusterNodesRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/key_pair/attach": {
"post": {
"summary": "attach key pairs",
"operationId": "AttachKeyPairs",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixAttachKeyPairsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixAttachKeyPairsRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/key_pair/detach": {
"post": {
"summary": "detach key pairs",
"operationId": "DetachKeyPairs",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDetachKeyPairsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDetachKeyPairsRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/key_pairs": {
"get": {
"summary": "describe key pairs",
"operationId": "DescribeKeyPairs",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeKeyPairsResponse"
}
}
},
"parameters": [
{
"name": "key_pair_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "description",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "pub_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"ClusterManager"
]
},
"delete": {
"summary": "delete key pairs",
"operationId": "DeleteKeyPairs",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDeleteKeyPairsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteKeyPairsRequest"
}
}
],
"tags": [
"ClusterManager"
]
},
"post": {
"summary": "create key pair",
"operationId": "CreateKeyPair",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateKeyPairResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateKeyPairRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/modify": {
"post": {
"summary": "modify cluster attributes",
"operationId": "ModifyClusterAttributes",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixModifyClusterAttributesResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyClusterAttributesRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/modify_nodes": {
"post": {
"summary": "modify cluster node attributes",
"operationId": "ModifyClusterNodeAttributes",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixModifyClusterNodeAttributesResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyClusterNodeAttributesRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/nodes": {
"get": {
"summary": "describe cluster nodes",
"operationId": "DescribeClusterNodes",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeClusterNodesResponse"
}
}
},
"parameters": [
{
"name": "cluster_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "node_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/recover": {
"post": {
"summary": "recover clusters",
"operationId": "RecoverClusters",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixRecoverClustersResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixRecoverClustersRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/resize": {
"post": {
"summary": "resize cluster",
"operationId": "ResizeCluster",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixResizeClusterResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixResizeClusterRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/rollback": {
"post": {
"summary": "rollback cluster",
"operationId": "RollbackCluster",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixRollbackClusterResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixRollbackClusterRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/start": {
"post": {
"summary": "start clusters",
"operationId": "StartClusters",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixStartClustersResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixStartClustersRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/statistics": {
"get": {
"summary": "get cluster statistics",
"operationId": "GetClusterStatistics",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixGetClusterStatisticsResponse"
}
}
},
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/stop": {
"post": {
"summary": "stop clusters",
"operationId": "StopClusters",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixStopClustersResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixStopClustersRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/subnets": {
"get": {
"summary": "describe subnets",
"operationId": "DescribeSubnets",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeSubnetsResponse"
}
}
},
"parameters": [
{
"name": "runtime_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "subnet_type",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "subnet_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "zone",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "advanced_param",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/update_env": {
"patch": {
"summary": "update cluster env",
"operationId": "UpdateClusterEnv",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixUpdateClusterEnvResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixUpdateClusterEnvRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/clusters/upgrade": {
"post": {
"summary": "upgrade cluster",
"operationId": "UpgradeCluster",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixUpgradeClusterResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixUpgradeClusterRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/debug_clusters": {
"get": {
"summary": "describe debug clusters",
"operationId": "DescribeDebugClusters",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeClustersResponse"
}
}
},
"parameters": [
{
"name": "cluster_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "version_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "runtime_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "frontgate_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "external_cluster_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "cluster_type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "with_detail",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "created_date",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/debug_clusters/apps": {
"get": {
"summary": "describe debug app clusters",
"operationId": "DescribeDebugAppClusters",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeAppClustersResponse"
}
}
},
"parameters": [
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "with_detail",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "created_date",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/debug_clusters/create": {
"post": {
"summary": "create debug cluster",
"operationId": "CreateDebugCluster",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateClusterResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateClusterRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/app_vendors": {
"get": {
"summary": "DescribeVendorVerifyInfos",
"operationId": "DescribeVendorVerifyInfos",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeVendorVerifyInfosResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "user_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"IsvManager"
]
},
"post": {
"summary": "SubmitVendorVerifyInfo",
"operationId": "SubmitVendorVerifyInfo",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixSubmitVendorVerifyInfoResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixSubmitVendorVerifyInfoRequest"
}
}
],
"tags": [
"IsvManager"
]
}
},
"/v1/app_vendors/app_vendor": {
"get": {
"summary": "get isv by isv user Id",
"operationId": "GetVendorVerifyInfo",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixGetVendorVerifyInfoResponse"
}
}
},
"parameters": [
{
"name": "user_id",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"IsvManager"
]
}
},
"/v1/app_vendors/app_vendor_statistics": {
"get": {
"summary": "DescribeAppVendorStatistics",
"operationId": "DescribeAppVendorStatistics",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeVendorStatisticsResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "user_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"IsvManager"
]
}
},
"/v1/app_vendors/pass": {
"post": {
"summary": "PassVendorVerifyInfo",
"operationId": "PassVendorVerifyInfo",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixPassVendorVerifyInfoResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixPassVendorVerifyInfoRequest"
}
}
],
"tags": [
"IsvManager"
]
}
},
"/v1/app_vendors/reject": {
"post": {
"summary": "RejectVendorVerifyInfo",
"operationId": "RejectVendorVerifyInfo",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixRejectVendorVerifyInfoResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixRejectVendorVerifyInfoRequest"
}
}
],
"tags": [
"IsvManager"
]
}
},
"/v1/jobs": {
"get": {
"summary": "describe jobs with filter",
"operationId": "DescribeJobs",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeJobsResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "job_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "cluster_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "version_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "executor",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "provider",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "runtime_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"JobManager"
]
}
},
"/v1/market_users": {
"get": {
"summary": "describe users with filter",
"operationId": "DescribeMarketUsers",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeMarketUsersResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "market_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "user_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"MarketManager"
]
}
},
"/v1/markets": {
"get": {
"summary": "describe markets with filter",
"operationId": "DescribeMarkets",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeMarketsResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "market_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "visibility",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "user_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"MarketManager"
]
},
"delete": {
"summary": "delete markets",
"operationId": "DeleteMarkets",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDeleteMarketsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteMarketsRequest"
}
}
],
"tags": [
"MarketManager"
]
},
"post": {
"summary": "create market",
"operationId": "CreateMarket",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateMarketResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateMarketRequest"
}
}
],
"tags": [
"MarketManager"
]
},
"patch": {
"summary": "modify market",
"operationId": "ModifyMarket",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixModifyMarketResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyMarketRequest"
}
}
],
"tags": [
"MarketManager"
]
}
},
"/v1/markets:join": {
"post": {
"summary": "user join market",
"operationId": "UserJoinMarket",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixUserJoinMarketResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixUserJoinMarketRequest"
}
}
],
"tags": [
"MarketManager"
]
}
},
"/v1/markets:leave": {
"post": {
"summary": "user leave market",
"operationId": "UserLeaveMarket",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixUserLeaveMarketResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixUserLeaveMarketRequest"
}
}
],
"tags": [
"MarketManager"
]
}
},
"/v1/repos": {
"get": {
"summary": "describe repos with filter",
"operationId": "DescribeRepos",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeReposResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "repo_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "type",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "visibility",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "provider",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "label",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "selector",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "category_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "app_default_status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "user_id",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "controller",
"description": "0 for self resource; 1 for openpitrix resource.",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"tags": [
"RepoManager"
]
},
"delete": {
"summary": "delete repos",
"operationId": "DeleteRepos",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDeleteReposResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteReposRequest"
}
}
],
"tags": [
"RepoManager"
]
},
"post": {
"summary": "create repo",
"operationId": "CreateRepo",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateRepoResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateRepoRequest"
}
}
],
"tags": [
"RepoManager"
]
},
"patch": {
"summary": "modify repo",
"operationId": "ModifyRepo",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixModifyRepoResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyRepoRequest"
}
}
],
"tags": [
"RepoManager"
]
}
},
"/v1/repos/validate": {
"get": {
"summary": "validate repo",
"operationId": "ValidateRepo",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixValidateRepoResponse"
}
}
},
"parameters": [
{
"name": "type",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "url",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "credential",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"RepoManager"
]
}
},
"/v1/repo_events": {
"get": {
"summary": "describe repo events",
"operationId": "DescribeRepoEvents",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRepoEventsResponse"
}
}
},
"parameters": [
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "repo_event_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "repo_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"RepoIndexer"
]
}
},
"/v1/repos/index": {
"post": {
"summary": "start a index repo event",
"operationId": "IndexRepo",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixIndexRepoResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixIndexRepoRequest"
}
}
],
"tags": [
"RepoIndexer"
]
}
},
"/v1/debug_runtimes": {
"get": {
"summary": "describe debug runtime",
"operationId": "DescribeDebugRuntimes",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRuntimesResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "runtime_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "provider",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"RuntimeManager"
]
},
"post": {
"summary": "create debug runtime",
"operationId": "CreateDebugRuntime",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeRequest"
}
}
],
"tags": [
"RuntimeManager"
]
}
},
"/v1/debug_runtimes/credentials": {
"get": {
"summary": "describe debug runtime credentials",
"operationId": "DescribeDebugRuntimeCredentials",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRuntimeCredentialsResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "runtime_credential_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "provider",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"RuntimeManager"
]
},
"post": {
"summary": "create debug runtime credential",
"operationId": "CreateDebugRuntimeCredential",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeCredentialResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeCredentialRequest"
}
}
],
"tags": [
"RuntimeManager"
]
}
},
"/v1/runtimes": {
"get": {
"summary": "describe runtime",
"operationId": "DescribeRuntimes",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRuntimesResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "runtime_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "provider",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"RuntimeManager"
]
},
"delete": {
"summary": "delete runtimes",
"operationId": "DeleteRuntimes",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDeleteRuntimesResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteRuntimesRequest"
}
}
],
"tags": [
"RuntimeManager"
]
},
"post": {
"summary": "create runtime",
"operationId": "CreateRuntime",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeRequest"
}
}
],
"tags": [
"RuntimeManager"
]
},
"patch": {
"summary": "modify runtime",
"operationId": "ModifyRuntime",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixModifyRuntimeResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyRuntimeRequest"
}
}
],
"tags": [
"RuntimeManager"
]
}
},
"/v1/runtimes/credentials": {
"get": {
"summary": "describe runtime credentials",
"operationId": "DescribeRuntimeCredentials",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRuntimeCredentialsResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "runtime_credential_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "provider",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"RuntimeManager"
]
},
"delete": {
"summary": "delete runtime credentials",
"operationId": "DeleteRuntimeCredentials",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDeleteRuntimeCredentialsResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteRuntimeCredentialsRequest"
}
}
],
"tags": [
"RuntimeManager"
]
},
"post": {
"summary": "create runtime credential",
"operationId": "CreateRuntimeCredential",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeCredentialResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeCredentialRequest"
}
}
],
"tags": [
"RuntimeManager"
]
},
"patch": {
"summary": "modify runtime credential",
"operationId": "ModifyRuntimeCredential",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixModifyRuntimeCredentialResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyRuntimeCredentialRequest"
}
}
],
"tags": [
"RuntimeManager"
]
}
},
"/v1/runtimes/credentials:validate": {
"post": {
"summary": "validate runtime credential",
"operationId": "ValidateRuntimeCredential",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixValidateRuntimeCredentialResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixValidateRuntimeCredentialRequest"
}
}
],
"tags": [
"RuntimeManager"
]
}
},
"/v1/runtimes/statistics": {
"get": {
"summary": "get runtime statistics",
"operationId": "GetRuntimeStatistics",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixGetRuntimeStatisticsResponse"
}
}
},
"tags": [
"RuntimeManager"
]
}
},
"/v1/runtimes/zones": {
"get": {
"summary": "describe runtime provider zones",
"operationId": "DescribeRuntimeProviderZones",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRuntimeProviderZonesResponse"
}
}
},
"parameters": [
{
"name": "runtime_credential_id",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"RuntimeManager"
]
}
},
"/v1/service_configs/get": {
"post": {
"summary": "get service configration",
"operationId": "GetServiceConfig",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixGetServiceConfigResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixGetServiceConfigRequest"
}
}
],
"tags": [
"ServiceConfig"
]
}
},
"/v1/service_configs/set": {
"post": {
"summary": "set service configration",
"operationId": "SetServiceConfig",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixSetServiceConfigResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixSetServiceConfigRequest"
}
}
],
"tags": [
"ServiceConfig"
]
}
},
"/v1/service_configs/validate_email_service": {
"post": {
"summary": "validate email service",
"operationId": "ValidateEmailService",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixValidateEmailServiceResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixValidateEmailServiceRequest"
}
}
],
"tags": [
"ServiceConfig"
]
}
},
"/v1/tasks": {
"get": {
"summary": "describe tasks with filter",
"operationId": "DescribeTasks",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixDescribeTasksResponse"
}
}
},
"parameters": [
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "sort_key",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "reverse",
"in": "query",
"required": false,
"type": "boolean",
"format": "boolean"
},
{
"name": "limit",
"description": "default is 20, max value is 200.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"description": "default is 0.",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "display_columns",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "task_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "job_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "executor",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "target",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "multi"
}
],
"tags": [
"TaskManager"
]
}
},
"/v1/tasks/retry": {
"post": {
"summary": "retry tasks",
"operationId": "RetryTasks",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/openpitrixRetryTasksResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixRetryTasksRequest"
}
}
],
"tags": [
"TaskManager"
]
}
}
},
"definitions": {
"openpitrixActionBundle": {
"type": "object",
"properties": {
"action_bundle_id": {
"type": "string"
},
"action_bundle_name": {
"type": "string"
},
"api_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixApi"
}
}
}
},
"openpitrixApi": {
"type": "object",
"properties": {
"api_id": {
"type": "string"
},
"api_method": {
"type": "string"
},
"url_method": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"openpitrixBindUserRoleRequest": {
"type": "object",
"properties": {
"user_id": {
"type": "array",
"items": {
"type": "string"
}
},
"role_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixBindUserRoleResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "array",
"items": {
"type": "string"
}
},
"role_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixCanDoRequest": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"url": {
"type": "string"
},
"url_method": {
"type": "string"
},
"api_method": {
"type": "string"
}
}
},
"openpitrixCanDoResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"access_path": {
"type": "string"
},
"owner_path": {
"type": "string"
}
}
},
"openpitrixChangePasswordRequest": {
"type": "object",
"properties": {
"new_password": {
"type": "string"
},
"reset_id": {
"type": "string"
}
}
},
"openpitrixChangePasswordResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
}
}
},
"openpitrixCreateClientRequest": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
}
}
},
"openpitrixCreateClientResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
}
}
},
"openpitrixCreateGroupRequest": {
"type": "object",
"properties": {
"parent_group_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"openpitrixCreateGroupResponse": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
}
}
},
"openpitrixCreatePasswordResetRequest": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"openpitrixCreatePasswordResetResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"reset_id": {
"type": "string"
}
}
},
"openpitrixCreateRoleRequest": {
"type": "object",
"properties": {
"role_name": {
"type": "string"
},
"description": {
"type": "string"
},
"portal": {
"type": "string"
}
}
},
"openpitrixCreateRoleResponse": {
"type": "object",
"properties": {
"role_id": {
"type": "string"
}
}
},
"openpitrixCreateUserRequest": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"password": {
"type": "string"
},
"role_id": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"openpitrixCreateUserResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
}
}
},
"openpitrixDeleteGroupsRequest": {
"type": "object",
"properties": {
"group_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteGroupsResponse": {
"type": "object",
"properties": {
"group_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteRolesRequest": {
"type": "object",
"properties": {
"role_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteRolesResponse": {
"type": "object",
"properties": {
"role_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteUsersRequest": {
"type": "object",
"properties": {
"user_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteUsersResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDescribeGroupsDetailResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"group_detail_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixGroupDetail"
}
}
}
},
"openpitrixDescribeGroupsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"group_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixGroup"
}
}
}
},
"openpitrixDescribeRolesResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"role_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRole"
}
}
}
},
"openpitrixDescribeUsersDetailResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"user_detail_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixUserDetail"
}
}
}
},
"openpitrixDescribeUsersResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"user_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixUser"
}
}
}
},
"openpitrixFeature": {
"type": "object",
"properties": {
"feature_id": {
"type": "string"
},
"feature_name": {
"type": "string"
},
"action_bundle_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixActionBundle"
}
},
"checked_action_bundle_id_set": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixGetPasswordResetResponse": {
"type": "object",
"properties": {
"reset_id": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
},
"openpitrixGetRoleModuleResponse": {
"type": "object",
"properties": {
"role_id": {
"type": "string"
},
"module": {
"$ref": "#/definitions/openpitrixModule"
}
}
},
"openpitrixGetRoleResponse": {
"type": "object",
"properties": {
"role": {
"$ref": "#/definitions/openpitrixRole"
}
}
},
"openpitrixGroup": {
"type": "object",
"properties": {
"parent_group_id": {
"type": "string"
},
"group_id": {
"type": "string"
},
"group_path": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"description": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"update_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixGroupDetail": {
"type": "object",
"properties": {
"group": {
"$ref": "#/definitions/openpitrixGroup"
},
"user_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixUser"
}
}
}
},
"openpitrixJoinGroupRequest": {
"type": "object",
"properties": {
"group_id": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixJoinGroupResponse": {
"type": "object",
"properties": {
"group_id": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixLeaveGroupRequest": {
"type": "object",
"properties": {
"group_id": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixLeaveGroupResponse": {
"type": "object",
"properties": {
"group_id": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixModifyGroupRequest": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"parent_group_id": {
"type": "string"
}
}
},
"openpitrixModifyGroupResponse": {
"type": "object",
"properties": {
"group_id": {
"type": "string"
}
}
},
"openpitrixModifyRoleModuleRequest": {
"type": "object",
"properties": {
"role_id": {
"type": "string"
},
"module": {
"$ref": "#/definitions/openpitrixModule"
}
}
},
"openpitrixModifyRoleModuleResponse": {
"type": "object",
"properties": {
"role_id": {
"type": "string"
}
}
},
"openpitrixModifyRoleRequest": {
"type": "object",
"properties": {
"role_id": {
"type": "string"
},
"role_name": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"openpitrixModifyRoleResponse": {
"type": "object",
"properties": {
"role_id": {
"type": "string"
}
}
},
"openpitrixModifyUserRequest": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
},
"description": {
"type": "string"
},
"password": {
"type": "string"
},
"phone_number": {
"type": "string"
}
}
},
"openpitrixModifyUserResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
}
}
},
"openpitrixModule": {
"type": "object",
"properties": {
"module_elem_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixModuleElem"
}
}
}
},
"openpitrixModuleElem": {
"type": "object",
"properties": {
"module_id": {
"type": "string"
},
"module_name": {
"type": "string"
},
"feature_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixFeature"
}
},
"data_level": {
"type": "string"
},
"is_check_all": {
"type": "boolean",
"format": "boolean"
}
}
},
"openpitrixRole": {
"type": "object",
"properties": {
"role_id": {
"type": "string"
},
"role_name": {
"type": "string"
},
"description": {
"type": "string"
},
"portal": {
"type": "string"
},
"owner": {
"type": "string"
},
"owner_path": {
"type": "string"
},
"status": {
"type": "string"
},
"controller": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"update_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixTokenRequest": {
"type": "object",
"properties": {
"grant_type": {
"type": "string"
},
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"scope": {
"type": "string"
},
"username": {
"type": "string"
},
"password": {
"type": "string"
},
"refresh_token": {
"type": "string"
}
}
},
"openpitrixTokenResponse": {
"type": "object",
"properties": {
"token_type": {
"type": "string"
},
"expires_in": {
"type": "integer",
"format": "int32"
},
"access_token": {
"type": "string"
},
"refresh_token": {
"type": "string"
},
"id_token": {
"type": "string"
}
}
},
"openpitrixUnbindUserRoleRequest": {
"type": "object",
"properties": {
"user_id": {
"type": "array",
"items": {
"type": "string"
}
},
"role_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixUnbindUserRoleResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "array",
"items": {
"type": "string"
}
},
"role_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixUser": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"update_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixUserDetail": {
"type": "object",
"properties": {
"user": {
"$ref": "#/definitions/openpitrixUser"
},
"role_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRole"
}
},
"group_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixGroup"
}
}
}
},
"openpitrixValidateUserPasswordRequest": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"openpitrixValidateUserPasswordResponse": {
"type": "object",
"properties": {
"validated": {
"type": "boolean",
"format": "boolean"
}
}
},
"openpitrixApp": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
},
"active": {
"type": "boolean",
"format": "boolean"
},
"name": {
"type": "string"
},
"repo_id": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"type": "string"
},
"home": {
"type": "string"
},
"icon": {
"type": "string"
},
"screenshots": {
"type": "string"
},
"maintainers": {
"type": "string"
},
"keywords": {
"type": "string"
},
"sources": {
"type": "string"
},
"readme": {
"type": "string"
},
"chart_name": {
"type": "string"
},
"abstraction": {
"type": "string"
},
"tos": {
"type": "string"
},
"owner": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"update_time": {
"type": "string",
"format": "date-time"
},
"category_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixResourceCategory"
}
},
"latest_app_version": {
"$ref": "#/definitions/openpitrixAppVersion"
},
"app_version_types": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_website": {
"type": "string"
},
"company_profile": {
"type": "string"
},
"company_join_time": {
"type": "string",
"format": "date-time"
},
"owner_path": {
"type": "string"
},
"isv": {
"type": "string"
}
}
},
"openpitrixAppVersion": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
},
"active": {
"type": "boolean",
"format": "boolean"
},
"app_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"home": {
"type": "string"
},
"icon": {
"type": "string"
},
"screenshots": {
"type": "string"
},
"maintainers": {
"type": "string"
},
"keywords": {
"type": "string"
},
"sources": {
"type": "string"
},
"readme": {
"type": "string"
},
"package_name": {
"type": "string"
},
"status": {
"type": "string"
},
"review_id": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"update_time": {
"type": "string",
"format": "date-time"
},
"sequence": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string"
},
"type": {
"type": "string"
},
"owner_path": {
"type": "string"
}
}
},
"openpitrixAppVersionAudit": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
},
"app_id": {
"type": "string"
},
"status": {
"type": "string"
},
"version_name": {
"type": "string"
},
"app_name": {
"type": "string"
},
"operator": {
"type": "string"
},
"operator_type": {
"type": "string"
},
"message": {
"type": "string"
},
"review_id": {
"type": "string"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"version_type": {
"type": "string"
}
}
},
"openpitrixAppVersionReview": {
"type": "object",
"properties": {
"review_id": {
"type": "string"
},
"version_id": {
"type": "string"
},
"app_id": {
"type": "string"
},
"version_name": {
"type": "string"
},
"app_name": {
"type": "string"
},
"status": {
"type": "string"
},
"phase": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/openpitrixAppVersionReviewPhase"
}
},
"status_time": {
"type": "string",
"format": "date-time"
},
"reviewer": {
"type": "string"
},
"version_type": {
"type": "string"
}
}
},
"openpitrixAppVersionReviewPhase": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"operator": {
"type": "string"
},
"operator_type": {
"type": "string"
},
"message": {
"type": "string"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"review_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixCancelAppVersionRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixCancelAppVersionResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixCreateAppRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version_type": {
"type": "string",
"title": "optional: vmbased/helm"
},
"version_package": {
"type": "string",
"format": "byte",
"title": "create app version with specify package"
},
"version_name": {
"type": "string",
"title": "create app version with specify name"
},
"icon": {
"type": "string",
"format": "byte",
"title": "set the app icon"
}
}
},
"openpitrixCreateAppResponse": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
},
"version_id": {
"type": "string"
}
}
},
"openpitrixCreateAppVersionRequest": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string",
"title": "optional: vmbased/helm"
},
"package": {
"type": "string",
"format": "byte"
}
}
},
"openpitrixCreateAppVersionResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixDeleteAppVersionRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixDeleteAppVersionResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixDeleteAppsRequest": {
"type": "object",
"properties": {
"app_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteAppsResponse": {
"type": "object",
"properties": {
"app_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDescribeAppVersionAuditsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"app_version_audit_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixAppVersionAudit"
}
}
}
},
"openpitrixDescribeAppVersionReviewsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"app_version_review_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixAppVersionReview"
}
}
}
},
"openpitrixDescribeAppVersionsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"app_version_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixAppVersion"
}
}
}
},
"openpitrixDescribeAppsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"app_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixApp"
}
}
}
},
"openpitrixGetAppStatisticsResponse": {
"type": "object",
"properties": {
"last_two_week_created": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
},
"title": "app create time range -> app count, max length is 14"
},
"top_ten_repos": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
},
"title": "repo id -> app count, max length is 10"
},
"app_count": {
"type": "integer",
"format": "int64"
},
"repo_count": {
"type": "integer",
"format": "int64"
}
}
},
"openpitrixGetAppVersionPackageFilesResponse": {
"type": "object",
"properties": {
"files": {
"type": "object",
"additionalProperties": {
"type": "string",
"format": "byte"
}
},
"version_id": {
"type": "string"
}
}
},
"openpitrixGetAppVersionPackageResponse": {
"type": "object",
"properties": {
"package": {
"type": "string",
"format": "byte"
},
"app_id": {
"type": "string"
},
"version_id": {
"type": "string"
}
}
},
"openpitrixModifyAppRequest": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"home": {
"type": "string"
},
"maintainers": {
"type": "string"
},
"sources": {
"type": "string"
},
"readme": {
"type": "string"
},
"abstraction": {
"type": "string"
},
"tos": {
"type": "string"
},
"category_id": {
"type": "string"
},
"keywords": {
"type": "string"
}
}
},
"openpitrixModifyAppResponse": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
}
}
},
"openpitrixModifyAppVersionRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"package": {
"type": "string",
"format": "byte"
},
"package_files": {
"type": "object",
"additionalProperties": {
"type": "string",
"format": "byte"
},
"title": "filename => file_content"
}
}
},
"openpitrixModifyAppVersionResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixPassAppVersionRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixPassAppVersionResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixRecoverAppVersionRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixRecoverAppVersionResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixRejectAppVersionRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"openpitrixRejectAppVersionResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixReleaseAppVersionRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixReleaseAppVersionResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixResourceCategory": {
"type": "object",
"properties": {
"category_id": {
"type": "string"
},
"name": {
"type": "string"
},
"locale": {
"type": "string"
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixReviewAppVersionRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixReviewAppVersionResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixSubmitAppVersionRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixSubmitAppVersionResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixSuspendAppVersionRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixSuspendAppVersionResponse": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixSyncRepoResponse": {
"type": "object",
"properties": {
"failed": {
"type": "boolean",
"format": "boolean"
},
"result": {
"type": "string"
}
}
},
"openpitrixUploadAppAttachmentRequest": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
},
"type": {
"$ref": "#/definitions/openpitrixUploadAppAttachmentRequestType",
"title": "optional: icon/screenshot"
},
"attachment_content": {
"type": "string",
"format": "byte"
},
"sequence": {
"type": "integer",
"format": "int64",
"title": "only for screenshot, range: [0, 5]"
}
}
},
"openpitrixUploadAppAttachmentRequestType": {
"type": "string",
"enum": [
"icon",
"screenshot"
],
"default": "icon"
},
"openpitrixUploadAppAttachmentResponse": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
}
}
},
"openpitrixValidatePackageRequest": {
"type": "object",
"properties": {
"version_type": {
"type": "string",
"title": "optional: vmbased/helm"
},
"version_package": {
"type": "string",
"format": "byte"
}
}
},
"openpitrixValidatePackageResponse": {
"type": "object",
"properties": {
"error_details": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"title": "filename => detail"
},
"error": {
"type": "string"
},
"name": {
"type": "string"
},
"version_name": {
"type": "string"
}
}
},
"openpitrixAppendAttachmentResponse": {
"type": "object",
"properties": {
"attachment_id": {
"type": "string"
},
"filename": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixAttachment": {
"type": "object",
"properties": {
"attachment_id": {
"type": "string"
},
"attachment_content": {
"type": "object",
"additionalProperties": {
"type": "string",
"format": "byte"
},
"title": "filename => content"
},
"create_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixCreateAttachmentResponse": {
"type": "object",
"properties": {
"attachment_id": {
"type": "string"
},
"filename": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteAttachmentsResponse": {
"type": "object",
"properties": {
"attachment_id": {
"type": "array",
"items": {
"type": "string"
}
},
"filename": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixGetAttachmentResponse": {
"type": "object",
"properties": {
"content": {
"type": "string",
"format": "byte"
},
"etag": {
"type": "string"
}
}
},
"openpitrixGetAttachmentsResponse": {
"type": "object",
"properties": {
"attachments": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/openpitrixAttachment"
},
"title": "attachment_id => Attachment"
}
}
},
"openpitrixReplaceAttachmentResponse": {
"type": "object",
"properties": {
"attachment_id": {
"type": "string"
},
"filename": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixCategory": {
"type": "object",
"properties": {
"category_id": {
"type": "string"
},
"name": {
"type": "string"
},
"locale": {
"type": "string"
},
"owner_path": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"update_time": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"owner": {
"type": "string"
}
}
},
"openpitrixCreateCategoryRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"locale": {
"type": "string",
"title": "the i18n of this category, json format, sample: {\"zh_cn\": \"数据库\", \"en\": \"database\"}"
},
"description": {
"type": "string"
},
"icon": {
"type": "string",
"format": "byte"
}
}
},
"openpitrixCreateCategoryResponse": {
"type": "object",
"properties": {
"category_id": {
"type": "string"
}
}
},
"openpitrixDeleteCategoriesRequest": {
"type": "object",
"properties": {
"category_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteCategoriesResponse": {
"type": "object",
"properties": {
"category_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDescribeCategoriesResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"category_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixCategory"
}
}
}
},
"openpitrixModifyCategoryRequest": {
"type": "object",
"properties": {
"category_id": {
"type": "string"
},
"name": {
"type": "string"
},
"locale": {
"type": "string",
"title": "the i18n of this category, json format, sample: {\"zh_cn\": \"数据库\", \"en\": \"database\"}"
},
"description": {
"type": "string"
},
"icon": {
"type": "string",
"format": "byte"
}
}
},
"openpitrixModifyCategoryResponse": {
"type": "object",
"properties": {
"category_id": {
"type": "string"
}
}
},
"openpitrixAddClusterNodesRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"role": {
"type": "string"
},
"node_count": {
"type": "integer",
"format": "int64"
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixAddClusterNodesResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixAddNodeKeyPairsResponse": {
"type": "object"
},
"openpitrixAttachKeyPairsRequest": {
"type": "object",
"properties": {
"key_pair_id": {
"type": "array",
"items": {
"type": "string"
}
},
"node_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixAttachKeyPairsResponse": {
"type": "object",
"properties": {
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixCeaseClustersRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixCeaseClustersResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixCluster": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"app_id": {
"type": "string"
},
"version_id": {
"type": "string"
},
"subnet_id": {
"type": "string"
},
"vpc_id": {
"type": "string"
},
"frontgate_id": {
"type": "string"
},
"cluster_type": {
"type": "integer",
"format": "int64"
},
"endpoints": {
"type": "string"
},
"status": {
"type": "string"
},
"transition_status": {
"type": "string"
},
"metadata_root_access": {
"type": "boolean",
"format": "boolean"
},
"owner_path": {
"type": "string"
},
"global_uuid": {
"type": "string"
},
"upgrade_status": {
"type": "string"
},
"upgrade_time": {
"type": "string",
"format": "date-time"
},
"runtime_id": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"additional_info": {
"type": "string"
},
"env": {
"type": "string"
},
"debug": {
"type": "boolean",
"format": "boolean"
},
"zone": {
"type": "string"
},
"cluster_node_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixClusterNode"
}
},
"cluster_role_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixClusterRole"
}
},
"cluster_link_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixClusterLink"
}
},
"cluster_common_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixClusterCommon"
}
},
"cluster_loadbalancer_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixClusterLoadbalancer"
}
},
"owner": {
"type": "string"
}
}
},
"openpitrixClusterCommon": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"role": {
"type": "string"
},
"server_id_upper_bound": {
"type": "integer",
"format": "int64"
},
"advanced_actions": {
"type": "string"
},
"init_service": {
"type": "string"
},
"start_service": {
"type": "string"
},
"stop_service": {
"type": "string"
},
"scale_out_service": {
"type": "string"
},
"scale_in_service": {
"type": "string"
},
"restart_service": {
"type": "string"
},
"destroy_service": {
"type": "string"
},
"upgrade_service": {
"type": "string"
},
"custom_service": {
"type": "string"
},
"backup_service": {
"type": "string"
},
"restore_service": {
"type": "string"
},
"delete_snapshot_service": {
"type": "string"
},
"health_check": {
"type": "string"
},
"monitor": {
"type": "string"
},
"passphraseless": {
"type": "string"
},
"vertical_scaling_policy": {
"type": "string"
},
"agent_installed": {
"type": "boolean",
"format": "boolean"
},
"custom_metadata_script": {
"type": "string"
},
"image_id": {
"type": "string"
},
"backup_policy": {
"type": "string"
},
"incremental_backup_supported": {
"type": "boolean",
"format": "boolean"
},
"hypervisor": {
"type": "string"
}
}
},
"openpitrixClusterLink": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"name": {
"type": "string"
},
"external_cluster_id": {
"type": "string"
},
"owner_path": {
"type": "string"
},
"owner": {
"type": "string"
}
}
},
"openpitrixClusterLoadbalancer": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"role": {
"type": "string"
},
"loadbalancer_listener_id": {
"type": "string"
},
"loadbalancer_port": {
"type": "integer",
"format": "int64"
},
"loadbalancer_policy_id": {
"type": "string"
}
}
},
"openpitrixClusterNode": {
"type": "object",
"properties": {
"node_id": {
"type": "string"
},
"cluster_id": {
"type": "string"
},
"name": {
"type": "string"
},
"instance_id": {
"type": "string"
},
"volume_id": {
"type": "string"
},
"device": {
"type": "string"
},
"subnet_id": {
"type": "string"
},
"private_ip": {
"type": "string"
},
"eip": {
"type": "string"
},
"server_id": {
"type": "integer",
"format": "int64"
},
"role": {
"type": "string"
},
"status": {
"type": "string"
},
"transition_status": {
"type": "string"
},
"group_id": {
"type": "integer",
"format": "int64"
},
"owner_path": {
"type": "string"
},
"global_server_id": {
"type": "integer",
"format": "int64"
},
"custom_metadata": {
"type": "string"
},
"pub_key": {
"type": "string"
},
"health_status": {
"type": "string"
},
"is_backup": {
"type": "boolean",
"format": "boolean"
},
"auto_backup": {
"type": "boolean",
"format": "boolean"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"host_id": {
"type": "string"
},
"host_ip": {
"type": "string"
},
"cluster_role": {
"$ref": "#/definitions/openpitrixClusterRole"
},
"cluster_common": {
"$ref": "#/definitions/openpitrixClusterCommon"
},
"key_pair_id": {
"type": "array",
"items": {
"type": "string"
}
},
"owner": {
"type": "string"
}
}
},
"openpitrixClusterRole": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"role": {
"type": "string"
},
"cpu": {
"type": "integer",
"format": "int64"
},
"gpu": {
"type": "integer",
"format": "int64"
},
"memory": {
"type": "integer",
"format": "int64"
},
"instance_size": {
"type": "integer",
"format": "int64"
},
"storage_size": {
"type": "integer",
"format": "int64"
},
"mount_point": {
"type": "string"
},
"mount_options": {
"type": "string"
},
"file_system": {
"type": "string"
},
"env": {
"type": "string"
},
"replicas": {
"type": "integer",
"format": "int64"
},
"ready_replicas": {
"type": "integer",
"format": "int64"
},
"api_version": {
"type": "string"
}
}
},
"openpitrixCreateClusterRequest": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
},
"version_id": {
"type": "string"
},
"runtime_id": {
"type": "string"
},
"conf": {
"type": "string"
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixCreateClusterResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixCreateKeyPairRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"pub_key": {
"type": "string"
}
}
},
"openpitrixCreateKeyPairResponse": {
"type": "object",
"properties": {
"key_pair_id": {
"type": "string"
}
}
},
"openpitrixDeleteClusterNodesRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"node_id": {
"type": "array",
"items": {
"type": "string"
}
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteClusterNodesResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixDeleteClustersRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteClustersResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteKeyPairsRequest": {
"type": "object",
"properties": {
"key_pair_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteKeyPairsResponse": {
"type": "object",
"properties": {
"key_pair_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteNodeKeyPairsResponse": {
"type": "object"
},
"openpitrixDescribeAppClustersResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"cluster_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixCluster"
}
}
}
},
"openpitrixDescribeClusterNodesResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"cluster_node_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixClusterNode"
}
}
}
},
"openpitrixDescribeClustersResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"cluster_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixCluster"
}
}
}
},
"openpitrixDescribeKeyPairsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"key_pair_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixKeyPair"
}
}
}
},
"openpitrixDescribeSubnetsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"subnet_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixSubnet"
}
}
}
},
"openpitrixDetachKeyPairsRequest": {
"type": "object",
"properties": {
"key_pair_id": {
"type": "array",
"items": {
"type": "string"
}
},
"node_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDetachKeyPairsResponse": {
"type": "object",
"properties": {
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixGetClusterStatisticsResponse": {
"type": "object",
"properties": {
"last_two_week_created": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
},
"title": "cluster create time range -> cluster count, max length is 14"
},
"top_ten_runtimes": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
},
"title": "runtime id -> cluster count, max length is 10"
},
"cluster_count": {
"type": "integer",
"format": "int64"
},
"runtime_count": {
"type": "integer",
"format": "int64"
},
"top_ten_apps": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
},
"title": "app id -> cluster count, max length is 10"
}
}
},
"openpitrixKeyPair": {
"type": "object",
"properties": {
"key_pair_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"pub_key": {
"type": "string"
},
"owner_path": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"node_id": {
"type": "array",
"items": {
"type": "string"
}
},
"owner": {
"type": "string"
}
}
},
"openpitrixModifyClusterAttributesRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"openpitrixModifyClusterAttributesResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
}
}
},
"openpitrixModifyClusterNodeAttributesRequest": {
"type": "object",
"properties": {
"node_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"openpitrixModifyClusterNodeAttributesResponse": {
"type": "object",
"properties": {
"node_id": {
"type": "string"
}
}
},
"openpitrixModifyClusterNodeResponse": {
"type": "object",
"properties": {
"node_id": {
"type": "string"
}
}
},
"openpitrixModifyClusterResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
}
}
},
"openpitrixNodeKeyPair": {
"type": "object",
"properties": {
"node_id": {
"type": "string"
},
"key_pair_id": {
"type": "string"
}
}
},
"openpitrixRecoverClustersRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixRecoverClustersResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixResizeClusterRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"role_resource": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRoleResource"
}
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixResizeClusterResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixRoleResource": {
"type": "object",
"properties": {
"role": {
"type": "string"
},
"cpu": {
"type": "integer",
"format": "int64"
},
"gpu": {
"type": "integer",
"format": "int64"
},
"memory": {
"type": "integer",
"format": "int64"
},
"instance_size": {
"type": "integer",
"format": "int64"
},
"storage_size": {
"type": "integer",
"format": "int64"
}
}
},
"openpitrixRollbackClusterRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixRollbackClusterResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixStartClustersRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixStartClustersResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixStopClustersRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixStopClustersResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "array",
"items": {
"type": "string"
}
},
"job_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixSubnet": {
"type": "object",
"properties": {
"subnet_id": {
"type": "string"
},
"name": {
"type": "string"
},
"zone": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"instance_id": {
"type": "array",
"items": {
"type": "string"
}
},
"vpc_id": {
"type": "string"
},
"subnet_type": {
"type": "integer",
"format": "int64"
}
}
},
"openpitrixUpdateClusterEnvRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"env": {
"type": "string"
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixUpdateClusterEnvResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixUpgradeClusterRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"version_id": {
"type": "string"
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixUpgradeClusterResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"protobufEmpty": {
"type": "object",
"description": "service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for ` + "`" + `Empty` + "`" + ` is empty JSON object ` + "`" + `{}` + "`" + `.",
"title": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:"
},
"openpitrixDescribeVendorStatisticsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"vendor_verify_statistics_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixVendorStatistics"
}
}
}
},
"openpitrixDescribeVendorVerifyInfosResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"vendor_verify_info_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixVendorVerifyInfo"
}
}
}
},
"openpitrixGetVendorVerifyInfoResponse": {
"type": "object",
"properties": {
"vendor_verify_info": {
"$ref": "#/definitions/openpitrixVendorVerifyInfo"
}
}
},
"openpitrixPassVendorVerifyInfoRequest": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
}
}
},
"openpitrixPassVendorVerifyInfoResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
}
}
},
"openpitrixRejectVendorVerifyInfoRequest": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"reject_message": {
"type": "string"
}
}
},
"openpitrixRejectVendorVerifyInfoResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
}
}
},
"openpitrixSubmitVendorVerifyInfoRequest": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_website": {
"type": "string"
},
"company_profile": {
"type": "string"
},
"authorizer_name": {
"type": "string"
},
"authorizer_email": {
"type": "string"
},
"authorizer_phone": {
"type": "string"
},
"bank_name": {
"type": "string"
},
"bank_account_name": {
"type": "string"
},
"bank_account_number": {
"type": "string"
}
}
},
"openpitrixSubmitVendorVerifyInfoResponse": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
}
}
},
"openpitrixVendorStatistics": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"active_app_count": {
"type": "integer",
"format": "int64"
},
"cluster_count_month": {
"type": "integer",
"format": "int64"
},
"cluster_count_total": {
"type": "integer",
"format": "int64"
}
}
},
"openpitrixVendorVerifyInfo": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_website": {
"type": "string"
},
"company_profile": {
"type": "string"
},
"authorizer_name": {
"type": "string"
},
"authorizer_email": {
"type": "string"
},
"authorizer_phone": {
"type": "string"
},
"bank_name": {
"type": "string"
},
"bank_account_name": {
"type": "string"
},
"bank_account_number": {
"type": "string"
},
"status": {
"type": "string"
},
"reject_message": {
"type": "string"
},
"approver": {
"type": "string"
},
"owner": {
"type": "string"
},
"owner_path": {
"type": "string"
},
"submit_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixCreateJobResponse": {
"type": "object",
"properties": {
"job_id": {
"type": "string"
},
"cluster_id": {
"type": "string"
},
"app_id": {
"type": "string"
},
"version_id": {
"type": "string"
},
"runtime_id": {
"type": "string"
}
}
},
"openpitrixDescribeJobsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"job_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixJob"
}
}
}
},
"openpitrixJob": {
"type": "object",
"properties": {
"job_id": {
"type": "string"
},
"cluster_id": {
"type": "string"
},
"app_id": {
"type": "string"
},
"version_id": {
"type": "string"
},
"job_action": {
"type": "string"
},
"status": {
"type": "string"
},
"error_code": {
"type": "integer",
"format": "int64"
},
"directive": {
"type": "string"
},
"executor": {
"type": "string"
},
"task_count": {
"type": "integer",
"format": "int64"
},
"owner_path": {
"type": "string"
},
"provider": {
"type": "string"
},
"runtime_id": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"owner": {
"type": "string"
}
}
},
"openpitrixCreateMarketRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"visibility": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"openpitrixCreateMarketResponse": {
"type": "object",
"properties": {
"market_id": {
"type": "string"
}
}
},
"openpitrixDeleteMarketsRequest": {
"type": "object",
"properties": {
"market_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteMarketsResponse": {
"type": "object",
"properties": {
"market_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDescribeMarketUsersResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"market_user_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixMarketUser"
}
}
}
},
"openpitrixDescribeMarketsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"market_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixMarket"
}
}
}
},
"openpitrixMarket": {
"type": "object",
"properties": {
"market_id": {
"type": "string"
},
"name": {
"type": "string"
},
"visibility": {
"type": "string"
},
"status": {
"type": "string"
},
"owner_path": {
"type": "string"
},
"description": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"owner": {
"type": "string"
}
}
},
"openpitrixMarketUser": {
"type": "object",
"properties": {
"market_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"owner_path": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"owner": {
"type": "string"
}
}
},
"openpitrixModifyMarketRequest": {
"type": "object",
"properties": {
"market_id": {
"type": "string"
},
"name": {
"type": "string"
},
"visibility": {
"type": "string"
},
"status": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"openpitrixModifyMarketResponse": {
"type": "object",
"properties": {
"market_id": {
"type": "string"
}
}
},
"openpitrixUserJoinMarketRequest": {
"type": "object",
"properties": {
"market_id": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixUserJoinMarketResponse": {
"type": "object",
"properties": {
"market_id": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixUserLeaveMarketRequest": {
"type": "object",
"properties": {
"market_id": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixUserLeaveMarketResponse": {
"type": "object",
"properties": {
"market_id": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixCreateRepoRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"credential": {
"type": "string"
},
"visibility": {
"type": "string"
},
"providers": {
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"type": "string"
},
"selectors": {
"type": "string"
},
"category_id": {
"type": "string"
},
"app_default_status": {
"type": "string"
}
}
},
"openpitrixCreateRepoResponse": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
}
}
},
"openpitrixDeleteReposRequest": {
"type": "object",
"properties": {
"repo_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteReposResponse": {
"type": "object",
"properties": {
"repo_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDescribeReposResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"repo_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepo"
}
}
}
},
"openpitrixModifyRepoRequest": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"credential": {
"type": "string"
},
"visibility": {
"type": "string"
},
"providers": {
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"type": "string"
},
"selectors": {
"type": "string"
},
"category_id": {
"type": "string"
},
"app_default_status": {
"type": "string"
}
}
},
"openpitrixModifyRepoResponse": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
}
}
},
"openpitrixRepo": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"credential": {
"type": "string"
},
"visibility": {
"type": "string"
},
"owner_path": {
"type": "string"
},
"providers": {
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepoLabel"
}
},
"selectors": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepoSelector"
}
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"category_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixResourceCategory"
}
},
"app_default_status": {
"type": "string"
},
"controller": {
"type": "integer",
"format": "int32",
"title": "0 for self resource; 1 for openpitrix resource"
},
"owner": {
"type": "string"
}
}
},
"openpitrixRepoLabel": {
"type": "object",
"properties": {
"label_key": {
"type": "string"
},
"label_value": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixRepoSelector": {
"type": "object",
"properties": {
"selector_key": {
"type": "string"
},
"selector_value": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixValidateRepoResponse": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"format": "boolean"
},
"errorCode": {
"type": "integer",
"format": "int64"
}
}
},
"openpitrixDescribeRepoEventsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"repo_event_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepoEvent"
}
}
}
},
"openpitrixIndexRepoRequest": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
}
}
},
"openpitrixIndexRepoResponse": {
"type": "object",
"properties": {
"repo_event": {
"$ref": "#/definitions/openpitrixRepoEvent"
},
"repo_id": {
"type": "string"
}
}
},
"openpitrixRepoEvent": {
"type": "object",
"properties": {
"repo_event_id": {
"type": "string"
},
"repo_id": {
"type": "string"
},
"owner_path": {
"type": "string"
},
"status": {
"type": "string"
},
"result": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"owner": {
"type": "string"
}
}
},
"openpitrixCreateRuntimeCredentialRequest": {
"type": "object",
"properties": {
"runtime_url": {
"type": "string"
},
"runtime_credential_content": {
"type": "string"
},
"provider": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"openpitrixCreateRuntimeCredentialResponse": {
"type": "object",
"properties": {
"runtime_credential_id": {
"type": "string"
}
}
},
"openpitrixCreateRuntimeRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"provider": {
"type": "string"
},
"runtime_credential_id": {
"type": "string"
},
"zone": {
"type": "string"
}
}
},
"openpitrixCreateRuntimeResponse": {
"type": "object",
"properties": {
"runtime_id": {
"type": "string"
}
}
},
"openpitrixDeleteRuntimeCredentialsRequest": {
"type": "object",
"properties": {
"runtime_credential_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteRuntimeCredentialsResponse": {
"type": "object",
"properties": {
"runtime_credential_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteRuntimesRequest": {
"type": "object",
"properties": {
"runtime_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDeleteRuntimesResponse": {
"type": "object",
"properties": {
"runtime_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDescribeRuntimeCredentialsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"runtime_credential_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRuntimeCredential"
}
}
}
},
"openpitrixDescribeRuntimeDetailsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"runtime_detail_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRuntimeDetail"
}
}
}
},
"openpitrixDescribeRuntimeProviderZonesResponse": {
"type": "object",
"properties": {
"runtime_credential_id": {
"type": "string"
},
"zone": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixDescribeRuntimesResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"runtime_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRuntime"
}
}
}
},
"openpitrixGetRuntimeStatisticsResponse": {
"type": "object",
"properties": {
"last_two_week_created": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
},
"title": "runtime create time range -> runtime count, max length is 14"
},
"top_ten_providers": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
},
"title": "provider id -> runtime count, max length is 10"
},
"runtime_count": {
"type": "integer",
"format": "int64"
},
"provider_count": {
"type": "integer",
"format": "int64"
}
}
},
"openpitrixModifyRuntimeCredentialRequest": {
"type": "object",
"properties": {
"runtime_credential_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"runtime_credential_content": {
"type": "string"
}
}
},
"openpitrixModifyRuntimeCredentialResponse": {
"type": "object",
"properties": {
"runtime_credential_id": {
"type": "string"
}
}
},
"openpitrixModifyRuntimeRequest": {
"type": "object",
"properties": {
"runtime_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"runtime_credential_id": {
"type": "string"
}
}
},
"openpitrixModifyRuntimeResponse": {
"type": "object",
"properties": {
"runtime_id": {
"type": "string"
}
}
},
"openpitrixRuntime": {
"type": "object",
"properties": {
"runtime_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"provider": {
"type": "string"
},
"runtime_credential_id": {
"type": "string"
},
"zone": {
"type": "string"
},
"owner_path": {
"type": "string"
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"debug": {
"type": "boolean",
"format": "boolean"
},
"owner": {
"type": "string"
}
}
},
"openpitrixRuntimeCredential": {
"type": "object",
"properties": {
"runtime_credential_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"runtime_url": {
"type": "string"
},
"runtime_credential_content": {
"type": "string"
},
"owner_path": {
"type": "string"
},
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"debug": {
"type": "boolean",
"format": "boolean"
},
"owner": {
"type": "string"
}
}
},
"openpitrixRuntimeDetail": {
"type": "object",
"properties": {
"runtime": {
"$ref": "#/definitions/openpitrixRuntime"
},
"runtime_credential": {
"$ref": "#/definitions/openpitrixRuntimeCredential"
}
}
},
"openpitrixValidateRuntimeCredentialRequest": {
"type": "object",
"properties": {
"runtime_url": {
"type": "string"
},
"runtime_credential_content": {
"type": "string"
},
"provider": {
"type": "string"
}
}
},
"openpitrixValidateRuntimeCredentialResponse": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"format": "boolean"
}
}
},
"openpitrixCheckResourceResponse": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"format": "boolean"
}
}
},
"openpitrixDescribeClusterDetailsResponse": {
"type": "object",
"properties": {
"cluster": {
"$ref": "#/definitions/openpitrixCluster"
}
}
},
"openpitrixDescribeVpcResponse": {
"type": "object",
"properties": {
"vpc": {
"$ref": "#/definitions/openpitrixVpc"
}
}
},
"openpitrixDescribeZonesResponse": {
"type": "object",
"properties": {
"zones": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixEip": {
"type": "object",
"properties": {
"eip_id": {
"type": "string"
},
"name": {
"type": "string"
},
"addr": {
"type": "string"
}
}
},
"openpitrixHandleSubtaskResponse": {
"type": "object",
"properties": {
"task": {
"$ref": "#/definitions/openpitrixTask"
}
}
},
"openpitrixParseClusterConfResponse": {
"type": "object",
"properties": {
"cluster": {
"$ref": "#/definitions/openpitrixCluster"
}
}
},
"openpitrixRegisterRuntimeProviderResponse": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"format": "boolean"
}
}
},
"openpitrixSplitJobIntoTasksResponse": {
"type": "object",
"properties": {
"taskLayer": {
"$ref": "#/definitions/openpitrixTaskLayer"
}
}
},
"openpitrixTask": {
"type": "object",
"properties": {
"task_id": {
"type": "string"
},
"job_id": {
"type": "string"
},
"task_action": {
"type": "string"
},
"status": {
"type": "string"
},
"error_code": {
"type": "integer",
"format": "int64"
},
"directive": {
"type": "string"
},
"executor": {
"type": "string"
},
"owner_path": {
"type": "string"
},
"target": {
"type": "string"
},
"node_id": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"failure_allowed": {
"type": "boolean",
"format": "boolean"
},
"owner": {
"type": "string"
}
}
},
"openpitrixTaskLayer": {
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixTask"
}
},
"child": {
"$ref": "#/definitions/openpitrixTaskLayer"
}
}
},
"openpitrixValidateRuntimeResponse": {
"type": "object",
"properties": {
"ok": {
"type": "boolean",
"format": "boolean"
}
}
},
"openpitrixVpc": {
"type": "object",
"properties": {
"vpc_id": {
"type": "string"
},
"name": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"status": {
"type": "string"
},
"transition_status": {
"type": "string"
},
"subnets": {
"type": "array",
"items": {
"type": "string"
}
},
"eip": {
"$ref": "#/definitions/openpitrixEip"
}
}
},
"openpitrixWaitSubtaskResponse": {
"type": "object",
"properties": {
"task": {
"$ref": "#/definitions/openpitrixTask"
}
}
},
"openpitrixBasicConfig": {
"type": "object",
"properties": {
"platform_name": {
"type": "string"
},
"platform_url": {
"type": "string"
}
}
},
"openpitrixEmailServiceConfig": {
"type": "object",
"properties": {
"protocol": {
"type": "string"
},
"email_host": {
"type": "string"
},
"port": {
"type": "integer",
"format": "int64"
},
"display_sender": {
"type": "string"
},
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"ssl_enable": {
"type": "boolean",
"format": "boolean"
}
}
},
"openpitrixGetServiceConfigRequest": {
"type": "object",
"properties": {
"service_type": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixGetServiceConfigResponse": {
"type": "object",
"properties": {
"notification_config": {
"$ref": "#/definitions/openpitrixNotificationConfig"
},
"runtime_config": {
"$ref": "#/definitions/openpitrixRuntimeConfig"
},
"basic_config": {
"$ref": "#/definitions/openpitrixBasicConfig"
}
}
},
"openpitrixNotificationConfig": {
"type": "object",
"properties": {
"email_service_config": {
"$ref": "#/definitions/openpitrixEmailServiceConfig"
}
}
},
"openpitrixRuntimeConfig": {
"type": "object",
"properties": {
"config_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRuntimeItemConfig"
}
}
}
},
"openpitrixRuntimeItemConfig": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"enable": {
"type": "boolean",
"format": "boolean"
}
}
},
"openpitrixSetServiceConfigRequest": {
"type": "object",
"properties": {
"notification_config": {
"$ref": "#/definitions/openpitrixNotificationConfig"
},
"runtime_config": {
"$ref": "#/definitions/openpitrixRuntimeConfig"
},
"basic_config": {
"$ref": "#/definitions/openpitrixBasicConfig"
}
}
},
"openpitrixSetServiceConfigResponse": {
"type": "object",
"properties": {
"is_succ": {
"type": "boolean",
"format": "boolean"
}
}
},
"openpitrixValidateEmailServiceRequest": {
"type": "object",
"properties": {
"email_service_config": {
"$ref": "#/definitions/openpitrixEmailServiceConfig"
}
}
},
"openpitrixValidateEmailServiceResponse": {
"type": "object",
"properties": {
"is_succ": {
"type": "boolean",
"format": "boolean"
}
}
},
"openpitrixCreateTaskResponse": {
"type": "object",
"properties": {
"task_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"openpitrixDescribeTasksResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"task_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixTask"
}
}
}
},
"openpitrixRetryTasksRequest": {
"type": "object",
"properties": {
"task_id": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixRetryTasksResponse": {
"type": "object",
"properties": {
"task_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixTask"
}
}
}
}
},
"securityDefinitions": {
"BearerAuth": {
"type": "apiKey",
"description": "The Authorization header must be set to Bearer followed by a space and a token. For example, 'Bearer vHUabiBEIKi8n1RdvWOjGFulGSM6zunb'.",
"name": "Authorization",
"in": "header"
}
},
"security": [
{
"BearerAuth": []
}
]
}
`,
}
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.