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"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/v1/app_version/package": {
"get": {
"summary": "get the package content of app version",
"operationId": "GetAppVersionPackage",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixGetAppVersionPackageResponse"
}
}
},
"parameters": [
{
"name": "version_id",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"AppManager"
]
}
},
"/v1/app_versions": {
"get": {
"summary": "describe app versions with filter",
"operationId": "DescribeAppVersions",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeAppVersionsResponse"
}
}
},
"parameters": [
{
"name": "version_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "description",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "package_name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"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"
}
],
"tags": [
"AppManager"
]
},
"delete": {
"summary": "delete app version",
"operationId": "DeleteAppVersion",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteAppVersionResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteAppVersionRequest"
}
}
],
"tags": [
"AppManager"
]
},
"post": {
"summary": "create app version",
"operationId": "CreateAppVersion",
"responses": {
"200": {
"description": "",
"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": "",
"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": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeAppsResponse"
}
}
},
"parameters": [
{
"name": "app_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "repo_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "chart_name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"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"
}
],
"tags": [
"AppManager"
]
},
"delete": {
"summary": "delete app",
"operationId": "DeleteApp",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteAppResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteAppRequest"
}
}
],
"tags": [
"AppManager"
]
},
"post": {
"summary": "create app",
"operationId": "CreateApp",
"responses": {
"200": {
"description": "",
"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": "",
"schema": {
"$ref": "#/definitions/openpitrixModifyAppResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyAppRequest"
}
}
],
"tags": [
"AppManager"
]
}
},
"/v1/clusters": {
"get": {
"summary": "describe cluster nodes",
"operationId": "DescribeClusterNodes",
"responses": {
"200": {
"description": "",
"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"
}
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"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"
}
],
"tags": [
"ClusterManager"
]
},
"delete": {
"summary": "cease clusters",
"operationId": "CeaseClusters",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCeaseClustersResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCeaseClustersRequest"
}
}
],
"tags": [
"ClusterManager"
]
},
"post": {
"summary": "recover clusters",
"operationId": "RecoverClusters",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixRecoverClustersResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixRecoverClustersRequest"
}
}
],
"tags": [
"ClusterManager"
]
},
"patch": {
"summary": "update cluster env",
"operationId": "UpdateClusterEnv",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixUpdateClusterEnvResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixUpdateClusterEnvRequest"
}
}
],
"tags": [
"ClusterManager"
]
}
},
"/v1/jobs": {
"get": {
"summary": "describe jobs with filter",
"operationId": "DescribeJobs",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeJobsResponse"
}
}
},
"parameters": [
{
"name": "job_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"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": "runtime",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"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"
}
],
"tags": [
"JobManager"
]
},
"post": {
"summary": "create job",
"operationId": "CreateJob",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCreateJobResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateJobRequest"
}
}
],
"tags": [
"JobManager"
]
}
},
"/v1/pilots": {
"get": {
"summary": "get subtask status",
"operationId": "GetSubtaskStatus",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixGetSubtaskStatusResponse"
}
}
},
"parameters": [
{
"name": "subtask_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
],
"tags": [
"PilotManager"
]
},
"post": {
"summary": "handle subtask",
"operationId": "HandleSubtask",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixHandleSubtaskResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixHandleSubtaskRequest"
}
}
],
"tags": [
"PilotManager"
]
}
},
"/v1/repos": {
"get": {
"summary": "describe repos with filter",
"operationId": "DescribeRepos",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeReposResponse"
}
}
},
"parameters": [
{
"name": "repo_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "name",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "visibility",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "label",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "selector",
"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"
}
],
"tags": [
"RepoManager"
]
},
"delete": {
"summary": "delete repo",
"operationId": "DeleteRepo",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteRepoResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteRepoRequest"
}
}
],
"tags": [
"RepoManager"
]
},
"post": {
"summary": "create repo",
"operationId": "CreateRepo",
"responses": {
"200": {
"description": "",
"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": "",
"schema": {
"$ref": "#/definitions/openpitrixModifyRepoResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyRepoRequest"
}
}
],
"tags": [
"RepoManager"
]
}
},
"/v1/repos/labels": {
"get": {
"summary": "describe repo labels with filter",
"operationId": "DescribeRepoLabels",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRepoLabelsResponse"
}
}
},
"parameters": [
{
"name": "repo_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "repo_label_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
}
],
"tags": [
"RepoManager"
]
},
"delete": {
"summary": "delete repo label",
"operationId": "DeleteRepoLabel",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteRepoLabelResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteRepoLabelRequest"
}
}
],
"tags": [
"RepoManager"
]
},
"post": {
"summary": "create repo label",
"operationId": "CreateRepoLabel",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCreateRepoLabelResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateRepoLabelRequest"
}
}
],
"tags": [
"RepoManager"
]
},
"patch": {
"summary": "modify repo label",
"operationId": "ModifyRepoLabel",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixModifyRepoLabelResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyRepoLabelRequest"
}
}
],
"tags": [
"RepoManager"
]
}
},
"/v1/repos/selectors": {
"get": {
"summary": "describe repo selectors with filter",
"operationId": "DescribeRepoSelectors",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRepoSelectorsResponse"
}
}
},
"parameters": [
{
"name": "repo_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "repo_selector_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
}
],
"tags": [
"RepoManager"
]
},
"delete": {
"summary": "delete repo selectors",
"operationId": "DeleteRepoSelector",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteRepoSelectorResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteRepoSelectorRequest"
}
}
],
"tags": [
"RepoManager"
]
},
"post": {
"summary": "create repo selector",
"operationId": "CreateRepoSelector",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCreateRepoSelectorResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateRepoSelectorRequest"
}
}
],
"tags": [
"RepoManager"
]
},
"patch": {
"summary": "modify repo selectors",
"operationId": "ModifyRepoSelector",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixModifyRepoSelectorResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyRepoSelectorRequest"
}
}
],
"tags": [
"RepoManager"
]
}
},
"/v1/repo_tasks": {
"get": {
"summary": "describe repo tasks",
"operationId": "DescribeRepoTasks",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRepoTasksResponse"
}
}
},
"parameters": [
{
"name": "repo_task_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "repo_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
}
],
"tags": [
"RepoIndexer"
]
}
},
"/v1/repos/index": {
"post": {
"summary": "start a index repo task",
"operationId": "IndexRepo",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixIndexRepoResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixIndexRepoRequest"
}
}
],
"tags": [
"RepoIndexer"
]
}
},
"/v1/credential_runtime_env": {
"delete": {
"summary": "detach runtime env",
"operationId": "DetachCredentialFromRuntimeEnv",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDetachCredentialFromRuntimeEnvResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDetachCredentialFromRuntimeEnvRequset"
}
}
],
"tags": [
"RuntimeEnvManager"
]
},
"post": {
"summary": "create runtime env",
"operationId": "AttachCredentialToRuntimeEnv",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixAttachCredentialToRuntimeEnvResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixAttachCredentialToRuntimeEnvRequset"
}
}
],
"tags": [
"RuntimeEnvManager"
]
}
},
"/v1/runtime_env_credentials": {
"get": {
"summary": "describe runtime env crendentials",
"operationId": "DescribeRuntimeEnvCredentials",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRuntimeEnvCredentialsResponse"
}
}
},
"parameters": [
{
"name": "runtime_env_credential_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
}
],
"tags": [
"RuntimeEnvManager"
]
},
"delete": {
"summary": "modify runtime env credential",
"operationId": "DeleteRuntimeEnvCredential",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteRuntimeEnvCredentialResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteRuntimeEnvCredentialRequset"
}
}
],
"tags": [
"RuntimeEnvManager"
]
},
"post": {
"summary": "create runtime env credential",
"operationId": "CreateRuntimeEnvCredential",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeEnvCredentialResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeEnvCredentialRequset"
}
}
],
"tags": [
"RuntimeEnvManager"
]
},
"patch": {
"summary": "modify runtime env credential",
"operationId": "ModifyRuntimeEnvCredential",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixModifyRuntimeEnvCredentialResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyRuntimeEnvCredentialRequest"
}
}
],
"tags": [
"RuntimeEnvManager"
]
}
},
"/v1/runtime_envs": {
"get": {
"summary": "describe runtime envs",
"operationId": "DescribeRuntimeEnvs",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeRuntimeEnvsResponse"
}
}
},
"parameters": [
{
"name": "runtime_env_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "search_word",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "selector",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "owner",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
},
{
"name": "offset",
"in": "query",
"required": false,
"type": "integer",
"format": "int64"
}
],
"tags": [
"RuntimeEnvManager"
]
},
"delete": {
"summary": "create runtime env",
"operationId": "DeleteRuntimeEnv",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDeleteRuntimeEnvResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixDeleteRuntimeEnvRequest"
}
}
],
"tags": [
"RuntimeEnvManager"
]
},
"post": {
"summary": "create runtime env",
"operationId": "CreateRuntimeEnv",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeEnvResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateRuntimeEnvRequest"
}
}
],
"tags": [
"RuntimeEnvManager"
]
},
"patch": {
"summary": "modify runtime env",
"operationId": "ModifyRuntimeEnv",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixModifyRuntimeEnvResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixModifyRuntimeEnvRequest"
}
}
],
"tags": [
"RuntimeEnvManager"
]
}
},
"/v1/tasks": {
"get": {
"summary": "describe tasks with filter",
"operationId": "DescribeTasks",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixDescribeTasksResponse"
}
}
},
"parameters": [
{
"name": "task_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "job_id",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
}
},
{
"name": "executor",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "status",
"in": "query",
"required": false,
"type": "array",
"items": {
"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"
}
],
"tags": [
"TaskManager"
]
},
"post": {
"summary": "create task",
"operationId": "CreateTask",
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/openpitrixCreateTaskResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/openpitrixCreateTaskRequest"
}
}
],
"tags": [
"TaskManager"
]
}
}
},
"definitions": {
"openpitrixApp": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
},
"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"
},
"sources": {
"type": "string"
},
"readme": {
"type": "string"
},
"chart_name": {
"type": "string"
},
"owner": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixAppVersion": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
},
"app_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"package_name": {
"type": "string"
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixCreateAppRequest": {
"type": "object",
"properties": {
"_": {
"type": "string"
},
"name": {
"type": "string"
},
"repo_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"chart_name": {
"type": "string"
},
"description": {
"type": "string"
},
"home": {
"type": "string"
},
"icon": {
"type": "string"
},
"screenshots": {
"type": "string"
},
"maintainers": {
"type": "string"
},
"sources": {
"type": "string"
},
"readme": {
"type": "string"
}
}
},
"openpitrixCreateAppResponse": {
"type": "object",
"properties": {
"app": {
"$ref": "#/definitions/openpitrixApp"
}
}
},
"openpitrixCreateAppVersionRequest": {
"type": "object",
"properties": {
"_": {
"type": "string"
},
"app_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"name": {
"type": "string"
},
"package_name": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"openpitrixCreateAppVersionResponse": {
"type": "object",
"properties": {
"app_version": {
"$ref": "#/definitions/openpitrixAppVersion"
}
}
},
"openpitrixDeleteAppRequest": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
}
}
},
"openpitrixDeleteAppResponse": {
"type": "object",
"properties": {
"app": {
"$ref": "#/definitions/openpitrixApp"
}
}
},
"openpitrixDeleteAppVersionRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
}
}
},
"openpitrixDeleteAppVersionResponse": {
"type": "object",
"properties": {
"app_version": {
"$ref": "#/definitions/openpitrixAppVersion"
}
}
},
"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"
}
}
}
},
"openpitrixGetAppVersionPackageResponse": {
"type": "object",
"properties": {
"package": {
"type": "string",
"format": "byte"
}
}
},
"openpitrixModifyAppRequest": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
},
"name": {
"type": "string"
},
"repo_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"chart_name": {
"type": "string"
},
"description": {
"type": "string"
},
"home": {
"type": "string"
},
"icon": {
"type": "string"
},
"screenshots": {
"type": "string"
},
"maintainers": {
"type": "string"
},
"sources": {
"type": "string"
},
"readme": {
"type": "string"
}
}
},
"openpitrixModifyAppResponse": {
"type": "object",
"properties": {
"app": {
"$ref": "#/definitions/openpitrixApp"
}
}
},
"openpitrixModifyAppVersionRequest": {
"type": "object",
"properties": {
"version_id": {
"type": "string"
},
"name": {
"type": "string"
},
"package_name": {
"type": "string"
},
"owner": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"openpitrixModifyAppVersionResponse": {
"type": "object",
"properties": {
"app_version": {
"$ref": "#/definitions/openpitrixAppVersion"
}
}
},
"protobufStringValue": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The string value."
}
},
"description": "Wrapper message for ` + "`" + `string` + "`" + `.\n\nThe JSON representation for ` + "`" + `StringValue` + "`" + ` is JSON string."
},
"openpitrixAddClusterNodesRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"role": {
"type": "string"
},
"node_count": {
"$ref": "#/definitions/protobufUInt32Value"
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixAddClusterNodesResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"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"
},
"global_uuid": {
"type": "string"
},
"frontgate_id": {
"type": "string"
},
"app_id": {
"type": "string"
},
"version_id": {
"type": "string"
},
"status": {
"type": "string"
},
"transition_status": {
"type": "string"
},
"runtime_env_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"node_count": {
"$ref": "#/definitions/protobufUInt32Value"
},
"endpoints": {
"type": "string"
},
"metadata_root_access": {
"type": "boolean",
"format": "boolean"
},
"links": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"roles": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"advanced_actions": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"upgrade_status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
},
"cluster_node_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixClusterNode"
}
}
}
},
"openpitrixClusterNode": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"node_id": {
"type": "string"
},
"name": {
"type": "string"
},
"instance_id": {
"type": "string"
},
"vxnet_id": {
"type": "string"
},
"private_ip": {
"type": "string"
},
"status": {
"type": "string"
},
"transition_status": {
"type": "string"
},
"server_id": {
"$ref": "#/definitions/protobufUInt32Value"
},
"server_id_upper_bound": {
"$ref": "#/definitions/protobufUInt32Value"
},
"global_server_id": {
"$ref": "#/definitions/protobufUInt64Value"
},
"health_status": {
"type": "string"
},
"role": {
"type": "string"
},
"owner": {
"type": "string"
},
"cpu": {
"$ref": "#/definitions/protobufUInt32Value"
},
"gpu": {
"$ref": "#/definitions/protobufUInt32Value"
},
"memory": {
"$ref": "#/definitions/protobufUInt32Value"
},
"storage_size": {
"$ref": "#/definitions/protobufUInt32Value"
},
"env": {
"type": "string"
},
"passphraseless": {
"type": "string"
},
"advanced_actions": {
"type": "string"
},
"image_id": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixCreateClusterRequest": {
"type": "object",
"properties": {
"app_id": {
"type": "string"
},
"version_id": {
"type": "string"
},
"runtime_env_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"
}
}
},
"openpitrixDeleteClusterNodesRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"role": {
"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"
}
}
}
},
"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"
}
}
}
},
"openpitrixModifyClusterNodeRequest": {
"type": "object",
"properties": {
"node_id": {
"type": "string"
},
"name": {
"type": "string"
},
"instance_id": {
"type": "string"
},
"volume_id": {
"type": "string"
},
"vxnet_id": {
"type": "string"
},
"private_ip": {
"type": "string"
},
"status": {
"type": "string"
},
"transition_status": {
"type": "string"
},
"health_status": {
"type": "string"
},
"pub_key": {
"type": "string"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixModifyClusterNodeResponse": {
"type": "object",
"properties": {
"node_id": {
"type": "string"
}
}
},
"openpitrixModifyClusterRequest": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"type": "string"
},
"transition_status": {
"type": "string"
},
"upgrade_status": {
"type": "string"
},
"upgrade_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixModifyClusterResponse": {
"type": "object",
"properties": {
"cluster_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": {
"type": "string"
},
"cpu": {
"$ref": "#/definitions/protobufUInt32Value"
},
"memory": {
"$ref": "#/definitions/protobufUInt32Value"
},
"advanced_param": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"openpitrixResizeClusterResponse": {
"type": "object",
"properties": {
"cluster_id": {
"type": "string"
},
"job_id": {
"type": "string"
}
}
},
"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"
}
}
}
},
"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"
}
}
},
"protobufBoolValue": {
"type": "object",
"properties": {
"value": {
"type": "boolean",
"format": "boolean",
"description": "The bool value."
}
},
"description": "Wrapper message for ` + "`" + `bool` + "`" + `.\n\nThe JSON representation for ` + "`" + `BoolValue` + "`" + ` is JSON ` + "`" + `true` + "`" + ` and ` + "`" + `false` + "`" + `."
},
"protobufUInt32Value": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "int64",
"description": "The uint32 value."
}
},
"description": "Wrapper message for ` + "`" + `uint32` + "`" + `.\n\nThe JSON representation for ` + "`" + `UInt32Value` + "`" + ` is JSON number."
},
"protobufUInt64Value": {
"type": "object",
"properties": {
"value": {
"type": "string",
"format": "uint64",
"description": "The uint64 value."
}
},
"description": "Wrapper message for ` + "`" + `uint64` + "`" + `.\n\nThe JSON representation for ` + "`" + `UInt64Value` + "`" + ` is JSON string."
},
"openpitrixCreateJobRequest": {
"type": "object",
"properties": {
"_": {
"type": "string"
},
"cluster_id": {
"type": "string"
},
"app_id": {
"type": "string"
},
"version_id": {
"type": "string"
},
"job_action": {
"type": "string"
},
"runtime": {
"type": "string"
},
"directive": {
"type": "string"
}
}
},
"openpitrixCreateJobResponse": {
"type": "object",
"properties": {
"job_id": {
"type": "string"
},
"cluster_id": {
"type": "string"
},
"app_id": {
"type": "string"
},
"version_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": {
"$ref": "#/definitions/protobufUInt32Value"
},
"directive": {
"type": "string"
},
"executor": {
"type": "string"
},
"task_count": {
"$ref": "#/definitions/protobufUInt32Value"
},
"owner": {
"type": "string"
},
"runtime": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixGetSubtaskStatusResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"subtask_status_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixSubtaskStatus"
}
}
}
},
"openpitrixHandleSubtaskRequest": {
"type": "object",
"properties": {
"subtask_id": {
"type": "string"
},
"subtask_action": {
"type": "string"
},
"directive": {
"type": "string"
}
}
},
"openpitrixHandleSubtaskResponse": {
"type": "object",
"properties": {
"subtask_id": {
"type": "string"
}
}
},
"openpitrixSubtaskStatus": {
"type": "object",
"properties": {
"subtask_id": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"openpitrixCreateRepoLabelRequest": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
},
"_": {
"type": "string"
},
"label_key": {
"type": "string"
},
"label_value": {
"type": "string"
}
}
},
"openpitrixCreateRepoLabelResponse": {
"type": "object",
"properties": {
"repo_label": {
"$ref": "#/definitions/openpitrixRepoLabel"
}
}
},
"openpitrixCreateRepoRequest": {
"type": "object",
"properties": {
"_": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"credential": {
"type": "string"
},
"visibility": {
"type": "string"
}
}
},
"openpitrixCreateRepoResponse": {
"type": "object",
"properties": {
"repo": {
"$ref": "#/definitions/openpitrixRepo"
}
}
},
"openpitrixCreateRepoSelectorRequest": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
},
"_": {
"type": "string"
},
"selector_key": {
"type": "string"
},
"selector_value": {
"type": "string"
}
}
},
"openpitrixCreateRepoSelectorResponse": {
"type": "object",
"properties": {
"repo_selector": {
"$ref": "#/definitions/openpitrixRepoSelector"
}
}
},
"openpitrixDeleteRepoLabelRequest": {
"type": "object",
"properties": {
"repo_label_id": {
"type": "string"
}
}
},
"openpitrixDeleteRepoLabelResponse": {
"type": "object",
"properties": {
"repo_label": {
"$ref": "#/definitions/openpitrixRepoLabel"
}
}
},
"openpitrixDeleteRepoRequest": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
}
}
},
"openpitrixDeleteRepoResponse": {
"type": "object",
"properties": {
"repo": {
"$ref": "#/definitions/openpitrixRepo"
}
}
},
"openpitrixDeleteRepoSelectorRequest": {
"type": "object",
"properties": {
"repo_selector_id": {
"type": "string"
}
}
},
"openpitrixDeleteRepoSelectorResponse": {
"type": "object",
"properties": {
"repo_selector": {
"$ref": "#/definitions/openpitrixRepoSelector"
}
}
},
"openpitrixDescribeRepoLabelsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"repo_label_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepoLabel"
}
}
}
},
"openpitrixDescribeRepoSelectorsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"repo_selector_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepoSelector"
}
}
}
},
"openpitrixDescribeReposResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"repo_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepo"
}
}
}
},
"openpitrixModifyRepoLabelRequest": {
"type": "object",
"properties": {
"_": {
"type": "string"
},
"repo_label_id": {
"type": "string"
},
"label_key": {
"type": "string"
},
"label_value": {
"type": "string"
}
}
},
"openpitrixModifyRepoLabelResponse": {
"type": "object",
"properties": {
"repo_label": {
"$ref": "#/definitions/openpitrixRepoLabel"
}
}
},
"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"
}
}
},
"openpitrixModifyRepoResponse": {
"type": "object",
"properties": {
"repo": {
"$ref": "#/definitions/openpitrixRepo"
}
}
},
"openpitrixModifyRepoSelectorRequest": {
"type": "object",
"properties": {
"_": {
"type": "string"
},
"repo_selector_id": {
"type": "string"
},
"selector_key": {
"type": "string"
},
"selector_value": {
"type": "string"
}
}
},
"openpitrixModifyRepoSelectorResponse": {
"type": "object",
"properties": {
"repo_selector": {
"$ref": "#/definitions/openpitrixRepoSelector"
}
}
},
"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": {
"type": "string"
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixRepoLabel": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
},
"repo_label_id": {
"type": "string"
},
"label_key": {
"type": "string"
},
"label_value": {
"type": "string"
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixRepoSelector": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
},
"repo_selector_id": {
"type": "string"
},
"selector_key": {
"type": "string"
},
"selector_value": {
"type": "string"
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixDescribeRepoTasksResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"repo_task_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRepoTask"
}
}
}
},
"openpitrixIndexRepoRequest": {
"type": "object",
"properties": {
"repo_id": {
"type": "string"
}
}
},
"openpitrixIndexRepoResponse": {
"type": "object",
"properties": {
"repo_task": {
"$ref": "#/definitions/openpitrixRepoTask"
}
}
},
"openpitrixRepoTask": {
"type": "object",
"properties": {
"repo_task_id": {
"type": "string"
},
"repo_id": {
"type": "string"
},
"owner": {
"type": "string"
},
"status": {
"type": "string"
},
"result": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixAttachCredentialToRuntimeEnvRequset": {
"type": "object",
"properties": {
"runtime_env_credential_id": {
"type": "string"
},
"runtime_env_id": {
"type": "string"
}
}
},
"openpitrixAttachCredentialToRuntimeEnvResponse": {
"type": "object",
"properties": {
"runtime_env_credential_id": {
"type": "string"
},
"runtime_env_id": {
"type": "string"
}
}
},
"openpitrixCreateRuntimeEnvCredentialRequset": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"content": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"openpitrixCreateRuntimeEnvCredentialResponse": {
"type": "object",
"properties": {
"runtime_env_credential": {
"$ref": "#/definitions/openpitrixRuntimeEnvCredential"
}
}
},
"openpitrixCreateRuntimeEnvRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"labels": {
"type": "string"
},
"runtime_env_url": {
"type": "string"
}
}
},
"openpitrixCreateRuntimeEnvResponse": {
"type": "object",
"properties": {
"runtime_env": {
"$ref": "#/definitions/openpitrixRuntimeEnv"
}
}
},
"openpitrixDeleteRuntimeEnvCredentialRequset": {
"type": "object",
"properties": {
"runtime_env_credential_id": {
"type": "string"
}
}
},
"openpitrixDeleteRuntimeEnvCredentialResponse": {
"type": "object",
"properties": {
"runtime_env_credential": {
"$ref": "#/definitions/openpitrixRuntimeEnvCredential"
}
}
},
"openpitrixDeleteRuntimeEnvRequest": {
"type": "object",
"properties": {
"runtime_env_id": {
"type": "string"
}
}
},
"openpitrixDeleteRuntimeEnvResponse": {
"type": "object",
"properties": {
"runtime_env": {
"$ref": "#/definitions/openpitrixRuntimeEnv"
}
}
},
"openpitrixDescribeRuntimeEnvCredentialsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"runtime_env_credential_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRuntimeEnvCredential"
}
}
}
},
"openpitrixDescribeRuntimeEnvsResponse": {
"type": "object",
"properties": {
"total_count": {
"type": "integer",
"format": "int64"
},
"runtime_env_set": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRuntimeEnv"
}
}
}
},
"openpitrixDetachCredentialFromRuntimeEnvRequset": {
"type": "object",
"properties": {
"runtime_env_credential_id": {
"type": "string"
},
"runtime_env_id": {
"type": "string"
}
}
},
"openpitrixDetachCredentialFromRuntimeEnvResponse": {
"type": "object",
"properties": {
"runtime_env_credential_id": {
"type": "string"
},
"runtime_env_id": {
"type": "string"
}
}
},
"openpitrixModifyRuntimeEnvCredentialRequest": {
"type": "object",
"properties": {
"runtime_env_credential_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"content": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"openpitrixModifyRuntimeEnvCredentialResponse": {
"type": "object",
"properties": {
"runtime_env_credential": {
"$ref": "#/definitions/openpitrixRuntimeEnvCredential"
}
}
},
"openpitrixModifyRuntimeEnvRequest": {
"type": "object",
"properties": {
"runtime_env_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"labels": {
"type": "string"
}
}
},
"openpitrixModifyRuntimeEnvResponse": {
"type": "object",
"properties": {
"runtime_env": {
"$ref": "#/definitions/openpitrixRuntimeEnv"
}
}
},
"openpitrixRuntimeEnv": {
"type": "object",
"properties": {
"runtime_env_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"runtime_env_url": {
"type": "string"
},
"runtime_env_credential_id": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/openpitrixRuntimeEnvLabel"
}
},
"owner": {
"type": "string"
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixRuntimeEnvCredential": {
"type": "object",
"properties": {
"runtime_env_credential_id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"content": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"owner": {
"type": "string"
},
"runtime_env_id": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
},
"openpitrixRuntimeEnvLabel": {
"type": "object",
"properties": {
"runtime_env_label_id": {
"type": "string"
},
"runtime_env_id": {
"type": "string"
},
"label_key": {
"type": "string"
},
"label_value": {
"type": "string"
}
}
},
"openpitrixCreateTaskRequest": {
"type": "object",
"properties": {
"_": {
"type": "string"
},
"job_id": {
"type": "string"
},
"node_id": {
"type": "string"
},
"target": {
"type": "string"
},
"task_action": {
"type": "string"
},
"directive": {
"type": "string"
}
}
},
"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"
}
}
}
},
"openpitrixTask": {
"type": "object",
"properties": {
"task_id": {
"type": "string"
},
"job_id": {
"type": "string"
},
"task_action": {
"type": "string"
},
"status": {
"type": "string"
},
"error_code": {
"$ref": "#/definitions/protobufUInt32Value"
},
"directive": {
"type": "string"
},
"executor": {
"type": "string"
},
"owner": {
"type": "string"
},
"target": {
"type": "string"
},
"node_id": {
"type": "string"
},
"create_time": {
"type": "string",
"format": "date-time"
},
"status_time": {
"type": "string",
"format": "date-time"
}
}
}
}
}
`,
"index.html": `<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Swagger UI</title>
<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
<link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
<link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
<style>
html
{
box-sizing: border-box;
overflow: -moz-scrollbars-vertical;
overflow-y: scroll;
}
*,
*:before,
*:after
{
box-sizing: inherit;
}
body {
margin:0;
background: #fafafa;
}
</style>
</head>
<body>
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
<defs>
<symbol viewBox="0 0 20 20" id="unlocked">
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
</symbol>
<symbol viewBox="0 0 20 20" id="locked">
<path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
</symbol>
<symbol viewBox="0 0 20 20" id="close">
<path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
</symbol>
<symbol viewBox="0 0 20 20" id="large-arrow">
<path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
</symbol>
<symbol viewBox="0 0 20 20" id="large-arrow-down">
<path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
</symbol>
<symbol viewBox="0 0 24 24" id="jump-to">
<path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
</symbol>
<symbol viewBox="0 0 24 24" id="expand">
<path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
</symbol>
</defs>
</svg>
<div id="swagger-ui"></div>
<script src="./swagger-ui-bundle.js"> </script>
<script src="./swagger-ui-standalone-preset.js"> </script>
<script>
window.onload = function() {
// Build a system
const ui = SwaggerUIBundle({
urls: [
{ name:"Api", url:"/swagger-ui/api.swagger.json" }
],
dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
})
window.ui = ui
}
</script>
</body>
</html>
`,
}
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
Click to show internal directories.
Click to hide internal directories.