github/kubevela
1
0
Fork 0
mirror of https://github.com/kubevela/kubevela.git synced 2026-05-26 19:24:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
738b416ec2f63f4e1c07b68bf19024adb7b5949f
kubevela/docs/apidoc/swagger.json
barnettZQG 738b416ec2 Fix: fix can not create first app env plan bug (#2665) 
* Fix: fix can not create first app env plan bug

* Fix: fix test bug

Co-authored-by: barnettZQG <yiyun.pro>
2021-11-09 09:47:41 +08:00

5508 lines
111 KiB
JSON
Raw Blame History

{
"swagger": "2.0",
"info": {
"description": "Kubevela api doc",
"title": "Kubevela api doc",
"contact": {
"name": "kubevela",
"url": "https://kubevela.io/",
"email": "feedback@mail.kubevela.io"
},
"license": {
"name": "Apache License 2.0",
"url": "https://github.com/oam-dev/kubevela/blob/master/LICENSE"
},
"version": "v1beta1"
},
"paths": {
"/api/v1/addon_registries": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"addon_registry"
],
"summary": "list all addon registry",
"operationId": "listAddonRegistry",
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ListAddonRegistryResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
},
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"addon_registry"
],
"summary": "create an addon registry",
"operationId": "createAddonRegistry",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateAddonRegistryRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.AddonRegistryMeta"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/addon_registries/{name}": {
"delete": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"addon_registry"
],
"summary": "delete an addon registry",
"operationId": "deleteAddonRegistry",
"parameters": [
{
"type": "string",
"description": "identifier of the addon registry",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.AddonRegistryMeta"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/addons": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"addon"
],
"summary": "list all addons",
"operationId": "listAddons",
"parameters": [
{
"type": "string",
"description": "filter addons from given registry",
"name": "registry",
"in": "query"
},
{
"type": "string",
"description": "Fuzzy search based on name and description.",
"name": "query",
"in": "query"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ListAddonResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/addons/{name}": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"addon"
],
"summary": "show details of an addon",
"operationId": "detailAddon",
"parameters": [
{
"type": "string",
"description": "addon name to query detail",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.DetailAddonResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/addons/{name}/disable": {
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"addon"
],
"summary": "disable an addon",
"operationId": "disableAddon",
"parameters": [
{
"type": "string",
"description": "addon name to enable",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.AddonStatusResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/addons/{name}/enable": {
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"addon"
],
"summary": "enable an addon",
"operationId": "enableAddon",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.EnableAddonRequest"
}
},
{
"type": "string",
"description": "addon name to enable",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.AddonStatusResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/addons/{name}/status": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"addon"
],
"summary": "show status of an addon",
"operationId": "statusAddon",
"parameters": [
{
"type": "string",
"description": "addon name to query status",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.AddonStatusResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/applicationplans": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "list all application plans",
"operationId": "listApplicationPlans",
"parameters": [
{
"type": "string",
"description": "Fuzzy search based on name or description",
"name": "query",
"in": "query"
},
{
"type": "string",
"description": "Namespace-based search",
"name": "namespace",
"in": "query"
},
{
"type": "string",
"description": "Cluster-based search",
"name": "cluster",
"in": "query"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ListApplicationPlanResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
},
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "create one application plan",
"operationId": "createApplicationPlan",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateApplicationPlanRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ApplicationPlanBase"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/applicationplans/{name}": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "detail one application plan",
"operationId": "detailApplicationPlan",
"parameters": [
{
"type": "string",
"description": "identifier of the application plan",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.DetailApplicationPlanResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
},
"put": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "update one application plan",
"operationId": "updateApplicationPlan",
"parameters": [
{
"type": "string",
"description": "identifier of the application plan",
"name": "name",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UpdateApplicationPlanRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ApplicationPlanBase"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
},
"delete": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "delete one application",
"operationId": "deleteApplicationPlan",
"parameters": [
{
"type": "string",
"description": "identifier of the application plan",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.EmptyResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/applicationplans/{name}/componentplans": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "gets the componentplan topology of the application",
"operationId": "listApplicationComponents",
"parameters": [
{
"type": "string",
"description": "identifier of the application plan",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "list components that deployed in define env",
"name": "envName",
"in": "query"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ComponentPlanListResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
},
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "create component plan for application plan",
"operationId": "createComponent",
"parameters": [
{
"type": "string",
"description": "identifier of the application plan",
"name": "name",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateComponentPlanRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ComponentPlanBase"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/applicationplans/{name}/componentplans/{componentName}": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "detail component plan for application plan",
"operationId": "detailComponent",
"parameters": [
{
"type": "string",
"description": "identifier of the application plan",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.DetailComponentPlanResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/applicationplans/{name}/deploy": {
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "deploy or upgrade the application",
"operationId": "deployApplication",
"parameters": [
{
"type": "string",
"description": "identifier of the application plan",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ApplicationDeployRequest"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/applicationplans/{name}/envs": {
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "creating an application environment plan",
"operationId": "createApplicationEnv",
"parameters": [
{
"type": "string",
"description": "identifier of the application plan",
"name": "name",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateApplicationEnvPlanRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.EnvBind"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/applicationplans/{name}/envs/{envName}": {
"put": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "set application plan differences in the specified environment",
"operationId": "updateApplicationEnvBinding",
"parameters": [
{
"type": "string",
"description": "identifier of the application plan",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "identifier of the application plan",
"name": "envName",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.PutApplicationPlanEnvRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.EnvBind"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
},
"delete": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "delete an application environment plan",
"operationId": "deleteApplicationEnv",
"parameters": [
{
"type": "string",
"description": "identifier of the application plan",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "identifier of the application plan",
"name": "envName",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.EmptyResponse"
}
},
"404": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/applicationplans/{name}/policies": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "list policy for application",
"operationId": "listApplicationPolicies",
"parameters": [
{
"type": "string",
"description": "identifier of the application plan",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ListApplicationPolicy"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
},
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "create policy for application",
"operationId": "createApplicationPolicy",
"parameters": [
{
"type": "string",
"description": "identifier of the application",
"name": "name",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreatePolicyRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.PolicyBase"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/applicationplans/{name}/policies/{policyName}": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "detail policy for application",
"operationId": "detailApplicationPolicy",
"parameters": [
{
"type": "string",
"description": "identifier of the application",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "identifier of the application policy",
"name": "policyName",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.DetailPolicyResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
},
"put": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "update policy for application",
"operationId": "updateApplicationPolicy",
"parameters": [
{
"type": "string",
"description": "identifier of the application",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "identifier of the application policy",
"name": "policyName",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UpdatePolicyRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.DetailPolicyResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
},
"delete": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "detail policy for application",
"operationId": "deleteApplicationPolicy",
"parameters": [
{
"type": "string",
"description": "identifier of the application",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "identifier of the application policy",
"name": "policyName",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.EmptyResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/applicationplans/{name}/template": {
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"applicationplan"
],
"summary": "create one application template",
"operationId": "publishApplicationTemplate",
"parameters": [
{
"type": "string",
"description": "identifier of the application plan",
"name": "name",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateApplicationTemplateRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ApplicationTemplateBase"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/clusters": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"cluster"
],
"summary": "list all clusters",
"operationId": "listKubeClusters",
"parameters": [
{
"type": "string",
"description": "Fuzzy search based on name or description",
"name": "query",
"in": "query"
},
{
"type": "int",
"default": 0,
"description": "Page for paging",
"name": "page",
"in": "query"
},
{
"type": "int",
"default": 20,
"description": "PageSize for paging",
"name": "pageSize",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/map[string]string"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
},
"500": {
"description": "Bummer, something went wrong"
}
}
},
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"cluster"
],
"summary": "create cluster",
"operationId": "createKubeCluster",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/*v1.CreateClusterRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ClusterBase"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/clusters/cloud-clusters/{provider}": {
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"cluster"
],
"summary": "list cloud clusters",
"operationId": "listCloudClusters",
"parameters": [
{
"type": "string",
"description": "identifier of the cloud provider",
"name": "provider",
"in": "path",
"required": true
},
{
"type": "int",
"default": 0,
"description": "Page for paging",
"name": "page",
"in": "query"
},
{
"type": "int",
"default": 20,
"description": "PageSize for paging",
"name": "pageSize",
"in": "query"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.AccessKeyRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ListCloudClusterResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/clusters/cloud-clusters/{provider}/connect": {
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"cluster"
],
"summary": "create cluster from cloud cluster",
"operationId": "connectCloudCluster",
"parameters": [
{
"type": "string",
"description": "identifier of the cloud provider",
"name": "provider",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.ConnectCloudClusterRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ClusterBase"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/clusters/cloud-clusters/{provider}/create": {
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"cluster"
],
"summary": "create cloud cluster",
"operationId": "createCloudCluster",
"parameters": [
{
"type": "string",
"description": "identifier of the cloud provider",
"name": "provider",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateCloudClusterRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.CreateCloudClusterResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/clusters/cloud-clusters/{provider}/creation": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"cluster"
],
"summary": "list cloud cluster creation",
"operationId": "listCloudClusterCreation",
"parameters": [
{
"type": "string",
"description": "identifier of the cloud provider",
"name": "provider",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ListCloudClusterCreationResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/clusters/cloud-clusters/{provider}/creation/{cloudClusterName}": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"cluster"
],
"summary": "check cloud cluster create status",
"operationId": "getCloudClusterCreationStatus",
"parameters": [
{
"type": "string",
"description": "identifier of the cloud provider",
"name": "provider",
"in": "path",
"required": true
},
{
"type": "string",
"description": "identifier for cloud cluster which is creating",
"name": "cloudClusterName",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.CreateCloudClusterResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
},
"delete": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"cluster"
],
"summary": "delete cloud cluster creation",
"operationId": "deleteCloudClusterCreation",
"parameters": [
{
"type": "string",
"description": "identifier of the cloud provider",
"name": "provider",
"in": "path",
"required": true
},
{
"type": "string",
"description": "identifier for cloud cluster which is creating",
"name": "cloudClusterName",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.CreateCloudClusterResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/clusters/{clusterName}": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"cluster"
],
"summary": "detail cluster info",
"operationId": "getKubeCluster",
"parameters": [
{
"type": "string",
"description": "identifier of the cluster",
"name": "clusterName",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.DetailClusterResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
},
"put": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"cluster"
],
"summary": "modify cluster",
"operationId": "modifyKubeCluster",
"parameters": [
{
"type": "string",
"description": "identifier of the cluster",
"name": "clusterName",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateClusterRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ClusterBase"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
},
"delete": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"cluster"
],
"summary": "delete cluster",
"operationId": "deleteKubeCluster",
"parameters": [
{
"type": "string",
"description": "identifier of the cluster",
"name": "clusterName",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ClusterBase"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/definitions": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"definition"
],
"summary": "list all definitions",
"operationId": "listDefinitions",
"parameters": [
{
"enum": [
"trait",
"workflowstep",
"component"
],
"type": "string",
"description": "query the definition type",
"name": "type",
"in": "query",
"required": true
},
{
"type": "string",
"description": "if specified, query the definition supported by the env.",
"name": "envName",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/map[string]string"
}
},
"500": {
"description": "Bummer, something went wrong"
}
}
}
},
"/api/v1/definitions/{name}": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"definition"
],
"summary": "detail definition",
"operationId": "detailDefinition",
"parameters": [
{
"type": "string",
"description": "identifier of the definition",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "query the definition type",
"name": "type",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/map[string]string"
}
},
"500": {
"description": "Bummer, something went wrong"
}
}
}
},
"/api/v1/namespaces": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"namespace"
],
"summary": "list all namespaces",
"operationId": "listNamespaces",
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ListNamespaceResponse"
}
}
}
},
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"namespace"
],
"summary": "create namespace",
"operationId": "createNamespace",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateNamespaceRequest"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.NamespaceDetailResponse"
}
}
}
}
},
"/api/v1/policydefinitions": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"definition"
],
"summary": "list all policydefinition",
"operationId": "noop",
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ListPolicyDefinitionResponse"
}
}
}
}
},
"/api/v1/query": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"velaQL"
],
"summary": "use velaQL to query resource status",
"operationId": "queryView",
"parameters": [
{
"type": "string",
"description": "velaql query statement",
"name": "velaql",
"in": "query"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.VelaQLViewResponse"
}
},
"400": {
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
}
}
}
},
"/api/v1/workflowplans": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"workflowplan"
],
"summary": "list application workflow",
"operationId": "listApplicationWorkflows",
"parameters": [
{
"type": "string",
"description": "identifier of the application.",
"name": "appName",
"in": "query",
"required": true
},
{
"type": "boolean",
"description": "query based on enable status",
"name": "enable",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/map[string]string"
}
},
"500": {
"description": "Bummer, something went wrong"
}
}
},
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"workflowplan"
],
"summary": "create application workflow",
"operationId": "createApplicationWorkflow",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.CreateWorkflowPlanRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/map[string]string"
}
},
"400": {
"description": "create failure",
"schema": {
"$ref": "#/definitions/bcode.Bcode"
}
},
"500": {
"description": "Bummer, something went wrong"
}
}
}
},
"/api/v1/workflowplans/{name}": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"workflowplan"
],
"summary": "detail application workflow",
"operationId": "detailWorkflow",
"parameters": [
{
"type": "string",
"description": "identifier of the workflow.",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/map[string]string"
}
},
"500": {
"description": "Bummer, something went wrong"
}
}
},
"put": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"workflowplan"
],
"summary": "update application workflow config",
"operationId": "updateWorkflow",
"parameters": [
{
"type": "string",
"description": "identifier of the workflow",
"name": "name",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.UpdateWorkflowPlanRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/map[string]string"
}
},
"500": {
"description": "Bummer, something went wrong"
}
}
},
"delete": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"workflowplan"
],
"summary": "deletet workflow",
"operationId": "deleteWorkflow",
"parameters": [
{
"type": "string",
"description": "identifier of the workflow",
"name": "name",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/map[string]string"
}
},
"500": {
"description": "Bummer, something went wrong"
}
}
}
},
"/api/v1/workflowplans/{name}/records": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"workflowplan"
],
"summary": "query application workflow execution record",
"operationId": "listWorkflowRecords",
"parameters": [
{
"type": "string",
"description": "identifier of the workflow",
"name": "name",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Query the page number.",
"name": "page",
"in": "path",
"required": true
},
{
"type": "integer",
"description": "Query the page size number.",
"name": "pageSize",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/map[string]string"
}
},
"500": {
"description": "Bummer, something went wrong"
}
}
}
},
"/api/v1/workflowplans/{name}/records/{record}": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"workflowplan"
],
"summary": "query application workflow execution record detail",
"operationId": "detailWorkflowRecord",
"parameters": [
{
"type": "string",
"description": "identifier of the workflow",
"name": "name",
"in": "path",
"required": true
},
{
"type": "string",
"description": "identifier of the workflow record",
"name": "record",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/map[string]string"
}
},
"500": {
"description": "Bummer, something went wrong"
}
}
}
},
"/v1/namespaces/{namespace}/applications/{appname}": {
"get": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"oam-application"
],
"summary": "get the specified oam application in the specified namespace",
"operationId": "getApplication",
"parameters": [
{
"type": "string",
"description": "identifier of the namespace",
"name": "namespace",
"in": "path",
"required": true
},
{
"type": "string",
"description": "identifier of the oam application",
"name": "appname",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/v1.ApplicationResponse"
}
}
}
},
"post": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"oam-application"
],
"summary": "create or update oam application in the specified namespace",
"operationId": "createOrUpdateApplication",
"parameters": [
{
"type": "string",
"description": "identifier of the namespace",
"name": "namespace",
"in": "path",
"required": true
},
{
"type": "string",
"description": "identifier of the oam application",
"name": "appname",
"in": "path",
"required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1.ApplicationRequest"
}
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"delete": {
"consumes": [
"application/xml",
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"tags": [
"oam-application"
],
"summary": "create or update oam application in the specified namespace",
"operationId": "deleteApplication",
"parameters": [
{
"type": "string",
"description": "identifier of the namespace",
"name": "namespace",
"in": "path",
"required": true
},
{
"type": "string",
"description": "identifier of the oam application",
"name": "appname",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"definitions": {
"bcode.Bcode": {
"required": [
"BusinessCode",
"Message"
],
"properties": {
"BusinessCode": {
"type": "integer",
"format": "int32"
},
"Message": {
"type": "string"
}
}
},
"cloudprovider.CloudCluster": {
"required": [
"provider",
"id",
"name",
"type",
"zone",
"labels",
"status",
"apiServerURL",
"dashboardURL"
],
"properties": {
"apiServerURL": {
"type": "string"
},
"dashboardURL": {
"type": "string"
},
"id": {
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"zone": {
"type": "string"
}
}
},
"common.AppRolloutStatus": {
"required": [
"rollingState",
"currentBatch",
"upgradedReplicas",
"upgradedReadyReplicas",
"batchRollingState",
"lastTargetAppRevision"
],
"properties": {
"LastSourceAppRevision": {
"type": "string"
},
"batchRollingState": {
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/definitions/condition.Condition"
}
},
"currentBatch": {
"type": "integer",
"format": "int32"
},
"lastAppliedPodTemplateIdentifier": {
"type": "string"
},
"lastTargetAppRevision": {
"type": "string"
},
"rollingState": {
"type": "string"
},
"rolloutOriginalSize": {
"type": "integer",
"format": "int32"
},
"rolloutTargetSize": {
"type": "integer",
"format": "int32"
},
"targetGeneration": {
"type": "string"
},
"upgradedReadyReplicas": {
"type": "integer",
"format": "int32"
},
"upgradedReplicas": {
"type": "integer",
"format": "int32"
}
}
},
"common.AppStatus": {
"properties": {
"appliedResources": {
"type": "array",
"items": {
"$ref": "#/definitions/common.ClusterObjectReference"
}
},
"components": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.ObjectReference"
}
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/definitions/condition.Condition"
}
},
"latestRevision": {
"$ref": "#/definitions/common.Revision"
},
"observedGeneration": {
"type": "integer",
"format": "int64"
},
"resourceTracker": {
"$ref": "#/definitions/v1.ObjectReference"
},
"rollout": {
"$ref": "#/definitions/common.AppRolloutStatus"
},
"services": {
"type": "array",
"items": {
"$ref": "#/definitions/common.ApplicationComponentStatus"
}
},
"status": {
"type": "string"
},
"workflow": {
"$ref": "#/definitions/common.WorkflowStatus"
}
}
},
"common.ApplicationComponent": {
"required": [
"name",
"type"
],
"properties": {
"dependsOn": {
"type": "array",
"items": {
"type": "string"
}
},
"externalRevision": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/definitions/common.inputItem"
}
},
"name": {
"type": "string"
},
"outputs": {
"type": "array",
"items": {
"$ref": "#/definitions/common.outputItem"
}
},
"properties": {
"type": "string"
},
"scopes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"traits": {
"type": "array",
"items": {
"$ref": "#/definitions/common.ApplicationTrait"
}
},
"type": {
"type": "string"
}
}
},
"common.ApplicationComponentStatus": {
"required": [
"name",
"healthy"
],
"properties": {
"env": {
"type": "string"
},
"healthy": {
"type": "boolean"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.ObjectReference"
}
},
"traits": {
"type": "array",
"items": {
"$ref": "#/definitions/common.ApplicationTraitStatus"
}
},
"workloadDefinition": {
"$ref": "#/definitions/common.WorkloadGVK"
}
}
},
"common.ApplicationTrait": {
"required": [
"type"
],
"properties": {
"properties": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"common.ApplicationTraitStatus": {
"required": [
"type",
"healthy"
],
"properties": {
"healthy": {
"type": "boolean"
},
"message": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"common.ClusterObjectReference": {
"description": "ObjectReference contains enough information to let you inspect or modify the referred object.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"cluster": {
"type": "string"
},
"creator": {
"type": "string"
},
"fieldPath": {
"description": "If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.",
"type": "string"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"namespace": {
"description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
"type": "string"
},
"resourceVersion": {
"description": "Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids",
"type": "string"
}
}
},
"common.Revision": {
"required": [
"name",
"revision"
],
"properties": {
"name": {
"type": "string"
},
"revision": {
"type": "integer",
"format": "int64"
},
"revisionHash": {
"type": "string"
}
}
},
"common.SubStepsStatus": {
"properties": {
"mode": {
"type": "string"
},
"stepIndex": {
"type": "integer",
"format": "int32"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/definitions/common.WorkflowSubStepStatus"
}
}
}
},
"common.WorkflowStatus": {
"required": [
"mode",
"suspend",
"terminated",
"finished"
],
"properties": {
"appRevision": {
"type": "string"
},
"contextBackend": {
"$ref": "#/definitions/v1.ObjectReference"
},
"finished": {
"type": "boolean"
},
"mode": {
"type": "string"
},
"startTime": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/definitions/common.WorkflowStepStatus"
}
},
"suspend": {
"type": "boolean"
},
"terminated": {
"type": "boolean"
}
}
},
"common.WorkflowStepStatus": {
"required": [
"id"
],
"properties": {
"firstExecuteTime": {
"type": "string"
},
"id": {
"type": "string"
},
"lastExecuteTime": {
"type": "string"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"phase": {
"type": "string"
},
"reason": {
"type": "string"
},
"subSteps": {
"$ref": "#/definitions/common.SubStepsStatus"
},
"type": {
"type": "string"
}
}
},
"common.WorkflowSubStepStatus": {
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"phase": {
"type": "string"
},
"reason": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"common.WorkloadGVK": {
"required": [
"apiVersion",
"kind"
],
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
}
}
},
"common.inputItem": {
"required": [
"parameterKey",
"from"
],
"properties": {
"from": {
"type": "string"
},
"parameterKey": {
"type": "string"
}
}
},
"common.outputItem": {
"required": [
"valueFrom",
"name"
],
"properties": {
"name": {
"type": "string"
},
"valueFrom": {
"type": "string"
}
}
},
"condition.Condition": {
"required": [
"type",
"status",
"lastTransitionTime",
"reason"
],
"properties": {
"lastTransitionTime": {
"type": "string"
},
"message": {
"type": "string"
},
"reason": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"condition.ConditionedStatus": {
"properties": {
"conditions": {
"type": "array",
"items": {
"$ref": "#/definitions/condition.Condition"
}
}
}
},
"map[string]string": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"model.ApplicationComponentPlan": {
"required": [
"updateTime",
"createTime",
"appPrimaryKey",
"creator",
"name",
"alias",
"type"
],
"properties": {
"alias": {
"type": "string"
},
"appPrimaryKey": {
"type": "string"
},
"createTime": {
"type": "string",
"format": "date-time"
},
"creator": {
"type": "string"
},
"dependsOn": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"externalRevision": {
"type": "string"
},
"icon": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/definitions/common.inputItem"
}
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"outputs": {
"type": "array",
"items": {
"$ref": "#/definitions/common.outputItem"
}
},
"properties": {
"$ref": "#/definitions/model.JSONStruct"
},
"scopes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"traits": {
"type": "array",
"items": {
"$ref": "#/definitions/model.ApplicationTraitPlan"
}
},
"type": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
}
},
"model.ApplicationTraitPlan": {
"required": [
"type"
],
"properties": {
"properties": {
"$ref": "#/definitions/model.JSONStruct"
},
"type": {
"type": "string"
}
}
},
"model.Cluster": {
"required": [
"createTime",
"updateTime",
"name",
"alias",
"description",
"icon",
"labels",
"status",
"reason",
"provider",
"apiServerURL",
"dashboardURL",
"kubeConfig",
"kubeConfigSecret"
],
"properties": {
"alias": {
"type": "string"
},
"apiServerURL": {
"type": "string"
},
"createTime": {
"type": "string",
"format": "date-time"
},
"dashboardURL": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"kubeConfig": {
"type": "string"
},
"kubeConfigSecret": {
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"provider": {
"$ref": "#/definitions/model.ProviderInfo"
},
"reason": {
"type": "string"
},
"status": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
}
},
"model.GitAddonSource": {
"properties": {
"path": {
"type": "string"
},
"token": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"model.JSONStruct": {
"type": "object"
},
"model.Model": {
"required": [
"createTime",
"updateTime"
],
"properties": {
"createTime": {
"type": "string",
"format": "date-time"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
}
},
"model.ProviderInfo": {
"required": [
"provider",
"name",
"id",
"zone",
"labels"
],
"properties": {
"id": {
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
},
"zone": {
"type": "string"
}
}
},
"types.Parameter": {
"required": [
"name"
],
"properties": {
"alias": {
"type": "string"
},
"default": {
"$ref": "#/definitions/types.Parameter.default"
},
"ignore": {
"type": "boolean"
},
"jsonType": {
"type": "string"
},
"name": {
"type": "string"
},
"required": {
"type": "boolean"
},
"short": {
"type": "string"
},
"type": {
"type": "integer",
"format": "int32"
},
"usage": {
"type": "string"
}
}
},
"types.Parameter.default": {},
"utils.Option": {
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string"
},
"value": {
"$ref": "#/definitions/utils.Option.value"
}
}
},
"utils.Option.value": {},
"utils.UIParameter": {
"required": [
"sort",
"label",
"description",
"jsonKey",
"uiType"
],
"properties": {
"description": {
"type": "string"
},
"disable": {
"type": "boolean"
},
"jsonKey": {
"type": "string"
},
"label": {
"type": "string"
},
"sort": {
"type": "integer",
"format": "integer"
},
"subParameterGroupOption": {
"type": "array",
"items": {
"$ref": "#/definitions/utils.UIParameter.subParameterGroupOption"
}
},
"subParameters": {
"type": "array",
"items": {
"$ref": "#/definitions/utils.UIParameter"
}
},
"uiType": {
"type": "string"
},
"validate": {
"$ref": "#/definitions/utils.Validate"
}
}
},
"utils.Validate": {
"properties": {
"defaultValue": {
"$ref": "#/definitions/utils.Validate.defaultValue"
},
"max": {
"type": "number",
"format": "double"
},
"maxLength": {
"type": "integer",
"format": "integer"
},
"min": {
"type": "number",
"format": "double"
},
"minLength": {
"type": "integer",
"format": "integer"
},
"options": {
"type": "array",
"items": {
"$ref": "#/definitions/utils.Option"
}
},
"pattern": {
"type": "string"
},
"required": {
"type": "boolean"
}
}
},
"utils.Validate.defaultValue": {},
"v1.AccessKeyRequest": {
"required": [
"accessKeyID",
"accessKeySecret"
],
"properties": {
"accessKeyID": {
"type": "string"
},
"accessKeySecret": {
"type": "string"
}
}
},
"v1.AddonDependency": {
"properties": {
"name": {
"type": "string"
}
}
},
"v1.AddonDeployTo": {
"required": [
"control_plane",
"runtime_cluster"
],
"properties": {
"control_plane": {
"type": "boolean"
},
"runtime_cluster": {
"type": "boolean"
}
}
},
"v1.AddonElementFile": {
"required": [
"Data",
"Name",
"Path"
],
"properties": {
"Data": {
"type": "string"
},
"Name": {
"type": "string"
},
"Path": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1.AddonMeta": {
"required": [
"name",
"version",
"description",
"icon"
],
"properties": {
"dependencies": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.AddonDependency"
}
},
"deploy_to": {
"$ref": "#/definitions/v1.AddonDeployTo"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"v1.AddonRegistryMeta": {
"required": [
"name"
],
"properties": {
"git": {
"$ref": "#/definitions/model.GitAddonSource"
},
"name": {
"type": "string"
}
}
},
"v1.AddonStatusResponse": {
"required": [
"phase"
],
"properties": {
"enabling_progress": {
"$ref": "#/definitions/v1.EnablingProgress"
},
"phase": {
"type": "string"
}
}
},
"v1.ApplicationDeployRequest": {
"required": [
"workflowName",
"commit",
"sourceType",
"force"
],
"properties": {
"commit": {
"type": "string"
},
"force": {
"type": "boolean"
},
"sourceType": {
"type": "string"
},
"workflowName": {
"type": "string"
}
}
},
"v1.ApplicationDeployResponse": {
"required": [
"version",
"status",
"reason",
"deployUser",
"commit",
"sourceType"
],
"properties": {
"commit": {
"type": "string"
},
"deployUser": {
"type": "string"
},
"reason": {
"type": "string"
},
"sourceType": {
"type": "string"
},
"status": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"v1.ApplicationPlanBase": {
"required": [
"name",
"alias",
"namespace",
"description",
"createTime",
"updateTime",
"icon",
"status",
"gatewayRule"
],
"properties": {
"alias": {
"type": "string"
},
"createTime": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"envBind": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.EnvBind"
}
},
"gatewayRule": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.GatewayRule"
}
},
"icon": {
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"status": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
}
},
"v1.ApplicationRequest": {
"required": [
"components"
],
"properties": {
"components": {
"type": "array",
"items": {
"$ref": "#/definitions/common.ApplicationComponent"
}
},
"policies": {
"type": "array",
"items": {
"$ref": "#/definitions/v1beta1.AppPolicy"
}
},
"workflow": {
"$ref": "#/definitions/v1beta1.Workflow"
}
}
},
"v1.ApplicationResourceInfo": {
"required": [
"componentNum"
],
"properties": {
"componentNum": {
"type": "integer",
"format": "int32"
}
}
},
"v1.ApplicationResponse": {
"required": [
"apiVersion",
"kind",
"spec",
"status"
],
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"spec": {
"$ref": "#/definitions/v1beta1.ApplicationSpec"
},
"status": {
"$ref": "#/definitions/common.AppStatus"
}
}
},
"v1.ApplicationTemplateBase": {
"required": [
"templateName",
"createTime",
"updateTime"
],
"properties": {
"createTime": {
"type": "string",
"format": "date-time"
},
"templateName": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.ApplicationTemplateVersion"
}
}
}
},
"v1.ApplicationTemplateVersion": {
"required": [
"version",
"description",
"createUser",
"createTime",
"updateTime"
],
"properties": {
"createTime": {
"type": "string",
"format": "date-time"
},
"createUser": {
"type": "string"
},
"description": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"version": {
"type": "string"
}
}
},
"v1.ClusterBase": {
"required": [
"name",
"providerInfo",
"apiServerURL",
"dashboardURL",
"status",
"reason"
],
"properties": {
"alias": {
"type": "string"
},
"apiServerURL": {
"type": "string"
},
"dashboardURL": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"providerInfo": {
"$ref": "#/definitions/model.ProviderInfo"
},
"reason": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"v1.ClusterResourceInfo": {
"required": [
"workerNumber",
"masterNumber",
"memoryCapacity",
"cpuCapacity",
"podCapacity",
"memoryUsed",
"cpuUsed",
"podUsed"
],
"properties": {
"cpuCapacity": {
"type": "integer",
"format": "int64"
},
"cpuUsed": {
"type": "integer",
"format": "int64"
},
"gpuCapacity": {
"type": "integer",
"format": "int64"
},
"gpuUsed": {
"type": "integer",
"format": "int64"
},
"masterNumber": {
"type": "integer",
"format": "int32"
},
"memoryCapacity": {
"type": "integer",
"format": "int64"
},
"memoryUsed": {
"type": "integer",
"format": "int64"
},
"podCapacity": {
"type": "integer",
"format": "int64"
},
"podUsed": {
"type": "integer",
"format": "int64"
},
"storageClassList": {
"type": "array",
"items": {
"type": "string"
}
},
"workerNumber": {
"type": "integer",
"format": "int32"
}
}
},
"v1.ClusterSelector": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"namespace": {
"type": "string"
}
}
},
"v1.ComponentPlanBase": {
"required": [
"name",
"alias",
"description",
"componentType",
"envNames",
"dependsOn",
"deployVersion",
"createTime",
"updateTime"
],
"properties": {
"alias": {
"type": "string"
},
"componentType": {
"type": "string"
},
"createTime": {
"type": "string",
"format": "date-time"
},
"creator": {
"type": "string"
},
"dependsOn": {
"type": "array",
"items": {
"type": "string"
}
},
"deployVersion": {
"type": "string"
},
"description": {
"type": "string"
},
"envNames": {
"type": "array",
"items": {
"type": "string"
}
},
"icon": {
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
}
},
"v1.ComponentPlanListResponse": {
"required": [
"componentplans"
],
"properties": {
"componentplans": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.ComponentPlanBase"
}
}
}
},
"v1.ComponentSelector": {
"required": [
"components"
],
"properties": {
"components": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1.ConnectCloudClusterRequest": {
"required": [
"accessKeyID",
"accessKeySecret",
"clusterID",
"name",
"icon"
],
"properties": {
"accessKeyID": {
"type": "string"
},
"accessKeySecret": {
"type": "string"
},
"alias": {
"type": "string"
},
"clusterID": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
}
}
},
"v1.CreateAddonRegistryRequest": {
"required": [
"name"
],
"properties": {
"git": {
"$ref": "#/definitions/model.GitAddonSource"
},
"name": {
"type": "string"
}
}
},
"v1.CreateApplicationEnvPlanRequest": {
"required": [
"name",
"clusterSelector"
],
"properties": {
"alias": {
"type": "string"
},
"clusterSelector": {
"$ref": "#/definitions/v1.ClusterSelector"
},
"componentSelector": {
"$ref": "#/definitions/v1.ComponentSelector"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"v1.CreateApplicationPlanRequest": {
"required": [
"name",
"namespace",
"icon"
],
"properties": {
"alias": {
"type": "string"
},
"deploy": {
"type": "boolean"
},
"description": {
"type": "string"
},
"envBind": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.EnvBind"
}
},
"icon": {
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"yamlConfig": {
"type": "string"
}
}
},
"v1.CreateApplicationTemplateRequest": {
"required": [
"templateName",
"version",
"description"
],
"properties": {
"description": {
"type": "string"
},
"templateName": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"v1.CreateCloudClusterRequest": {
"required": [
"accessKeyID",
"accessKeySecret",
"name",
"zone",
"workerNumber",
"cpuCoresPerWorker",
"memoryPerWorker"
],
"properties": {
"accessKeyID": {
"type": "string"
},
"accessKeySecret": {
"type": "string"
},
"cpuCoresPerWorker": {
"type": "integer",
"format": "int64"
},
"memoryPerWorker": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"workerNumber": {
"type": "integer",
"format": "int32"
},
"zone": {
"type": "string"
}
}
},
"v1.CreateCloudClusterResponse": {
"required": [
"clusterID",
"status"
],
"properties": {
"clusterID": {
"type": "string"
},
"status": {
"type": "string"
}
}
},
"v1.CreateClusterRequest": {
"required": [
"name",
"icon"
],
"properties": {
"alias": {
"type": "string"
},
"dashboardURL": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"kubeConfig": {
"type": "string"
},
"kubeConfigSecret": {
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
}
}
},
"v1.CreateComponentPlanRequest": {
"required": [
"name",
"componentType"
],
"properties": {
"alias": {
"type": "string"
},
"componentType": {
"type": "string"
},
"dependsOn": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"envNames": {
"type": "array",
"items": {
"type": "string"
}
},
"icon": {
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"properties": {
"type": "string"
}
}
},
"v1.CreateNamespaceRequest": {
"required": [
"name",
"description"
],
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"v1.CreatePolicyRequest": {
"required": [
"name",
"description",
"type",
"properties"
],
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"properties": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"v1.CreateWorkflowPlanRequest": {
"required": [
"appName",
"name",
"enable",
"default"
],
"properties": {
"alias": {
"type": "string"
},
"appName": {
"type": "string"
},
"default": {
"type": "boolean"
},
"description": {
"type": "string"
},
"enable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.WorkflowStep"
}
}
}
},
"v1.DefinitionBase": {
"required": [
"name",
"description",
"icon"
],
"properties": {
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"v1.DetailAddonResponse": {
"required": [
"name",
"version",
"description",
"icon",
"definitions",
"parameters",
"cue_templates",
"app_template"
],
"properties": {
"app_template": {
"$ref": "#/definitions/v1beta1.Application"
},
"cue_templates": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.AddonElementFile"
}
},
"definitions": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.AddonElementFile"
}
},
"dependencies": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.AddonDependency"
}
},
"deploy_to": {
"$ref": "#/definitions/v1.AddonDeployTo"
},
"description": {
"type": "string"
},
"detail": {
"type": "string"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"version": {
"type": "string"
},
"yaml_templates": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.AddonElementFile"
}
}
}
},
"v1.DetailApplicationPlanResponse": {
"required": [
"alias",
"namespace",
"gatewayRule",
"name",
"description",
"createTime",
"updateTime",
"icon",
"status",
"policies",
"status",
"resourceInfo",
"workflowStatus"
],
"properties": {
"alias": {
"type": "string"
},
"createTime": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"envBind": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.EnvBind"
}
},
"gatewayRule": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.GatewayRule"
}
},
"icon": {
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"policies": {
"type": "array",
"items": {
"type": "string"
}
},
"resourceInfo": {
"$ref": "#/definitions/v1.ApplicationResourceInfo"
},
"status": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"workflowStatus": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.WorkflowStepStatus"
}
}
}
},
"v1.DetailClusterResponse": {
"required": [
"alias",
"kubeConfigSecret",
"createTime",
"description",
"icon",
"labels",
"provider",
"kubeConfig",
"updateTime",
"name",
"status",
"reason",
"apiServerURL",
"dashboardURL",
"resourceInfo"
],
"properties": {
"alias": {
"type": "string"
},
"apiServerURL": {
"type": "string"
},
"createTime": {
"type": "string",
"format": "date-time"
},
"dashboardURL": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"kubeConfig": {
"type": "string"
},
"kubeConfigSecret": {
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"provider": {
"$ref": "#/definitions/model.ProviderInfo"
},
"reason": {
"type": "string"
},
"resourceInfo": {
"$ref": "#/definitions/v1.ClusterResourceInfo"
},
"status": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
}
},
"v1.DetailComponentPlanResponse": {
"required": [
"name",
"type",
"appPrimaryKey",
"creator",
"updateTime",
"createTime",
"alias"
],
"properties": {
"alias": {
"type": "string"
},
"appPrimaryKey": {
"type": "string"
},
"createTime": {
"type": "string",
"format": "date-time"
},
"creator": {
"type": "string"
},
"dependsOn": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"externalRevision": {
"type": "string"
},
"icon": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/definitions/common.inputItem"
}
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"type": "string"
},
"outputs": {
"type": "array",
"items": {
"$ref": "#/definitions/common.outputItem"
}
},
"properties": {
"$ref": "#/definitions/model.JSONStruct"
},
"scopes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"traits": {
"type": "array",
"items": {
"$ref": "#/definitions/model.ApplicationTraitPlan"
}
},
"type": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
}
},
"v1.DetailDefinitionResponse": {
"required": [
"schema",
"uiSchema"
],
"properties": {
"schema": {
"type": "string"
},
"uiSchema": {
"type": "array",
"items": {
"$ref": "#/definitions/utils.UIParameter"
}
}
}
},
"v1.DetailPolicyResponse": {
"required": [
"updateTime",
"name",
"type",
"description",
"creator",
"properties",
"createTime"
],
"properties": {
"createTime": {
"type": "string",
"format": "date-time"
},
"creator": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"properties": {
"$ref": "#/definitions/model.JSONStruct"
},
"type": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
}
},
"v1.DetailWorkflowPlanResponse": {
"required": [
"updateTime",
"name",
"alias",
"description",
"enable",
"default",
"createTime",
"workflowRecord"
],
"properties": {
"alias": {
"type": "string"
},
"createTime": {
"type": "string",
"format": "date-time"
},
"default": {
"type": "boolean"
},
"description": {
"type": "string"
},
"enable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.WorkflowStep"
}
},
"updateTime": {
"type": "string",
"format": "date-time"
},
"workflowRecord": {
"$ref": "#/definitions/v1.WorkflowRecord"
}
}
},
"v1.DetailWorkflowRecordResponse": {
"required": [
"namespace",
"suspend",
"terminated",
"name",
"deployTime",
"deployUser",
"commit",
"sourceType"
],
"properties": {
"commit": {
"type": "string"
},
"deployTime": {
"type": "string",
"format": "date-time"
},
"deployUser": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"sourceType": {
"type": "string"
},
"startTime": {
"type": "string",
"format": "date-time"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/definitions/common.WorkflowStepStatus"
}
},
"suspend": {
"type": "boolean"
},
"terminated": {
"type": "boolean"
}
}
},
"v1.EmptyResponse": {},
"v1.EnableAddonRequest": {
"properties": {
"args": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"v1.EnablingProgress": {
"required": [
"enabled_components",
"total_components"
],
"properties": {
"enabled_components": {
"type": "integer",
"format": "int32"
},
"total_components": {
"type": "integer",
"format": "int32"
}
}
},
"v1.EnvBind": {
"required": [
"name",
"clusterSelector"
],
"properties": {
"alias": {
"type": "string"
},
"clusterSelector": {
"$ref": "#/definitions/v1.ClusterSelector"
},
"componentSelector": {
"$ref": "#/definitions/v1.ComponentSelector"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"v1.GatewayRule": {
"required": [
"ruleType",
"address",
"protocol",
"componentName",
"componentPort"
],
"properties": {
"address": {
"type": "string"
},
"componentName": {
"type": "string"
},
"componentPort": {
"type": "integer",
"format": "int32"
},
"protocol": {
"type": "string"
},
"ruleType": {
"type": "string"
}
}
},
"v1.ListAddonRegistryResponse": {
"required": [
"registrys"
],
"properties": {
"registrys": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.AddonRegistryMeta"
}
}
}
},
"v1.ListAddonResponse": {
"required": [
"addons"
],
"properties": {
"addons": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.AddonMeta"
}
}
}
},
"v1.ListApplicationPlanResponse": {
"required": [
"applicationplans"
],
"properties": {
"applicationplans": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.ApplicationPlanBase"
}
}
}
},
"v1.ListApplicationPolicy": {
"required": [
"policies"
],
"properties": {
"policies": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.PolicyBase"
}
}
}
},
"v1.ListCloudClusterCreationResponse": {
"required": [
"creations"
],
"properties": {
"creations": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1.ListCloudClusterResponse": {
"required": [
"clusters",
"total"
],
"properties": {
"clusters": {
"type": "array",
"items": {
"$ref": "#/definitions/cloudprovider.CloudCluster"
}
},
"total": {
"type": "integer",
"format": "int32"
}
}
},
"v1.ListClusterResponse": {
"required": [
"clusters"
],
"properties": {
"clusters": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.ClusterBase"
}
}
}
},
"v1.ListDefinitionResponse": {
"required": [
"definitions"
],
"properties": {
"definitions": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.DefinitionBase"
}
}
}
},
"v1.ListNamespaceResponse": {
"required": [
"namespaces"
],
"properties": {
"namespaces": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.NamespaceBase"
}
}
}
},
"v1.ListPolicyDefinitionResponse": {
"required": [
"policyDefinitions"
],
"properties": {
"policyDefinitions": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.PolicyDefinition"
}
}
}
},
"v1.ListWorkflowPlanResponse": {
"required": [
"workflowplans"
],
"properties": {
"workflowplans": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.WorkflowPlanBase"
}
}
}
},
"v1.ListWorkflowRecordsResponse": {
"required": [
"records",
"total"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.WorkflowRecord"
}
},
"total": {
"type": "integer",
"format": "int64"
}
}
},
"v1.ManagedFieldsEntry": {
"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
"type": "string"
},
"fieldsType": {
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
"type": "string"
},
"fieldsV1": {
"description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type.",
"type": "string"
},
"manager": {
"description": "Manager is an identifier of the workflow managing these fields.",
"type": "string"
},
"operation": {
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
"type": "string"
},
"subresource": {
"description": "Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.",
"type": "string"
},
"time": {
"description": "Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'",
"type": "string"
}
}
},
"v1.NamespaceBase": {
"required": [
"name",
"description",
"createTime",
"updateTime"
],
"properties": {
"createTime": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
}
},
"v1.NamespaceDetailResponse": {
"required": [
"name",
"description",
"createTime",
"updateTime"
],
"properties": {
"createTime": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
}
},
"v1.ObjectMeta": {
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
"properties": {
"annotations": {
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"clusterName": {
"description": "The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.",
"type": "string"
},
"creationTimestamp": {
"description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"type": "string"
},
"deletionGracePeriodSeconds": {
"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
"type": "integer",
"format": "int64"
},
"deletionTimestamp": {
"description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"type": "string"
},
"finalizers": {
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
"type": "array",
"items": {
"type": "string"
}
},
"generateName": {
"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
"type": "string"
},
"generation": {
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
"type": "integer",
"format": "int64"
},
"labels": {
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"managedFields": {
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
"type": "array",
"items": {
"$ref": "#/definitions/v1.ManagedFieldsEntry"
}
},
"name": {
"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"namespace": {
"description": "Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces",
"type": "string"
},
"ownerReferences": {
"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
"type": "array",
"items": {
"$ref": "#/definitions/v1.OwnerReference"
}
},
"resourceVersion": {
"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"selfLink": {
"description": "SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.",
"type": "string"
},
"uid": {
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
}
},
"v1.ObjectReference": {
"description": "ObjectReference contains enough information to let you inspect or modify the referred object.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"fieldPath": {
"description": "If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: \"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered the event) or if no container name is specified \"spec.containers[2]\" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.",
"type": "string"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string"
},
"namespace": {
"description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
"type": "string"
},
"resourceVersion": {
"description": "Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids",
"type": "string"
}
}
},
"v1.OwnerReference": {
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"blockOwnerDeletion": {
"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
"type": "boolean"
},
"controller": {
"description": "If true, this reference points to the managing controller.",
"type": "boolean"
},
"kind": {
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"name": {
"description": "Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
},
"uid": {
"description": "UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids",
"type": "string"
}
}
},
"v1.PolicyBase": {
"required": [
"name",
"type",
"description",
"creator",
"properties",
"createTime",
"updateTime"
],
"properties": {
"createTime": {
"type": "string",
"format": "date-time"
},
"creator": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"properties": {
"$ref": "#/definitions/model.JSONStruct"
},
"type": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
}
},
"v1.PolicyDefinition": {
"required": [
"name",
"description",
"parameters"
],
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/types.Parameter"
}
}
}
},
"v1.PutApplicationPlanEnvRequest": {
"properties": {
"alias": {
"type": "string"
},
"clusterSelector": {
"$ref": "#/definitions/v1.ClusterSelector"
},
"componentSelector": {
"$ref": "#/definitions/v1.ComponentSelector"
},
"description": {
"type": "string"
}
}
},
"v1.TypeMeta": {
"description": "TypeMeta describes an individual object in an API response or request with strings representing the type of the object and its API schema version. Structures that are versioned or persisted should inline TypeMeta.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
}
}
},
"v1.UpdateApplicationPlanRequest": {
"properties": {
"alias": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"v1.UpdatePolicyRequest": {
"required": [
"description",
"type",
"properties"
],
"properties": {
"description": {
"type": "string"
},
"properties": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"v1.UpdateWorkflowPlanRequest": {
"required": [
"enable",
"default"
],
"properties": {
"alias": {
"type": "string"
},
"default": {
"type": "boolean"
},
"description": {
"type": "string"
},
"enable": {
"type": "boolean"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/definitions/v1.WorkflowStep"
}
}
}
},
"v1.VelaQLViewResponse": {
"type": "object"
},
"v1.WorkflowPlanBase": {
"required": [
"name",
"alias",
"description",
"enable",
"default",
"createTime",
"updateTime"
],
"properties": {
"alias": {
"type": "string"
},
"createTime": {
"type": "string",
"format": "date-time"
},
"default": {
"type": "boolean"
},
"description": {
"type": "string"
},
"enable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"updateTime": {
"type": "string",
"format": "date-time"
}
}
},
"v1.WorkflowRecord": {
"required": [
"name",
"namespace",
"suspend",
"terminated"
],
"properties": {
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"startTime": {
"type": "string",
"format": "date-time"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/definitions/common.WorkflowStepStatus"
}
},
"suspend": {
"type": "boolean"
},
"terminated": {
"type": "boolean"
}
}
},
"v1.WorkflowStep": {
"required": [
"name",
"type"
],
"properties": {
"alias": {
"type": "string"
},
"dependsOn": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/definitions/common.inputItem"
}
},
"name": {
"type": "string"
},
"outputs": {
"type": "array",
"items": {
"$ref": "#/definitions/common.outputItem"
}
},
"properties": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"v1.WorkflowStepStatus": {
"required": [
"name",
"status",
"takeTime"
],
"properties": {
"name": {
"type": "string"
},
"status": {
"type": "string"
},
"takeTime": {
"type": "integer",
"format": "integer"
}
}
},
"v1alpha1.CanaryMetric": {
"required": [
"name"
],
"properties": {
"interval": {
"type": "string"
},
"metricsRange": {
"$ref": "#/definitions/v1alpha1.MetricsExpectedRange"
},
"name": {
"type": "string"
},
"templateRef": {
"$ref": "#/definitions/v1.ObjectReference"
}
}
},
"v1alpha1.MetricsExpectedRange": {
"properties": {
"max": {
"type": "string"
},
"min": {
"type": "string"
}
}
},
"v1alpha1.RolloutBatch": {
"properties": {
"batchRolloutWebhooks": {
"type": "array",
"items": {
"$ref": "#/definitions/v1alpha1.RolloutWebhook"
}
},
"canaryMetric": {
"type": "array",
"items": {
"$ref": "#/definitions/v1alpha1.CanaryMetric"
}
},
"instanceInterval": {
"type": "integer",
"format": "int32"
},
"maxUnavailable": {
"type": "string"
},
"podList": {
"type": "array",
"items": {
"type": "string"
}
},
"replicas": {
"type": "string"
}
}
},
"v1alpha1.RolloutPlan": {
"properties": {
"batchPartition": {
"type": "integer",
"format": "int32"
},
"canaryMetric": {
"type": "array",
"items": {
"$ref": "#/definitions/v1alpha1.CanaryMetric"
}
},
"numBatches": {
"type": "integer",
"format": "int32"
},
"paused": {
"type": "boolean"
},
"rolloutBatches": {
"type": "array",
"items": {
"$ref": "#/definitions/v1alpha1.RolloutBatch"
}
},
"rolloutStrategy": {
"type": "string"
},
"rolloutWebhooks": {
"type": "array",
"items": {
"$ref": "#/definitions/v1alpha1.RolloutWebhook"
}
},
"targetSize": {
"type": "integer",
"format": "int32"
}
}
},
"v1alpha1.RolloutStatus": {
"required": [
"rollingState",
"batchRollingState",
"currentBatch",
"upgradedReplicas",
"upgradedReadyReplicas"
],
"properties": {
"batchRollingState": {
"type": "string"
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/definitions/condition.Condition"
}
},
"currentBatch": {
"type": "integer",
"format": "int32"
},
"lastAppliedPodTemplateIdentifier": {
"type": "string"
},
"rollingState": {
"type": "string"
},
"rolloutOriginalSize": {
"type": "integer",
"format": "int32"
},
"rolloutTargetSize": {
"type": "integer",
"format": "int32"
},
"targetGeneration": {
"type": "string"
},
"upgradedReadyReplicas": {
"type": "integer",
"format": "int32"
},
"upgradedReplicas": {
"type": "integer",
"format": "int32"
}
}
},
"v1alpha1.RolloutWebhook": {
"required": [
"type",
"name",
"url"
],
"properties": {
"expectedStatus": {
"type": "array",
"items": {
"type": "integer"
}
},
"metadata": {
"$ref": "#/definitions/v1alpha1.RolloutWebhook.metadata"
},
"method": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"v1alpha1.RolloutWebhook.metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"v1beta1.AppPolicy": {
"required": [
"name",
"type"
],
"properties": {
"name": {
"type": "string"
},
"properties": {
"type": "string"
},
"type": {
"type": "string"
}
}
},
"v1beta1.Application": {
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/v1.ObjectMeta"
},
"spec": {
"$ref": "#/definitions/v1beta1.ApplicationSpec"
},
"status": {
"$ref": "#/definitions/common.AppStatus"
}
}
},
"v1beta1.ApplicationSpec": {
"required": [
"components"
],
"properties": {
"components": {
"type": "array",
"items": {
"$ref": "#/definitions/common.ApplicationComponent"
}
},
"policies": {
"type": "array",
"items": {
"$ref": "#/definitions/v1beta1.AppPolicy"
}
},
"rolloutPlan": {
"$ref": "#/definitions/v1alpha1.RolloutPlan"
},
"workflow": {
"$ref": "#/definitions/v1beta1.Workflow"
}
}
},
"v1beta1.Workflow": {
"properties": {
"steps": {
"type": "array",
"items": {
"$ref": "#/definitions/v1beta1.WorkflowStep"
}
}
}
},
"v1beta1.WorkflowStep": {
"required": [
"name",
"type"
],
"properties": {
"dependsOn": {
"type": "array",
"items": {
"type": "string"
}
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/definitions/common.inputItem"
}
},
"name": {
"type": "string"
},
"outputs": {
"type": "array",
"items": {
"$ref": "#/definitions/common.outputItem"
}
},
"properties": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink