{ "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.AddonRegistry" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/addon_registries/{name}": { "put": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "addon_registry" ], "summary": "update an addon registry", "operationId": "updateAddonRegistry", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.UpdateAddonRegistryRequest" } }, { "type": "string", "description": "identifier of the addon registry", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.AddonRegistry" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } }, "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.AddonRegistry" } }, "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 }, { "type": "string", "description": "filter addons from given registry", "name": "registry", "in": "query" } ], "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/addons/{name}/update": { "put": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "addon" ], "summary": "update an addon", "operationId": "updateAddon", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.EnableAddonRequest" } }, { "type": "string", "description": "addon name to update", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.AddonStatusResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "list all applications", "operationId": "listApplications", "parameters": [ { "type": "string", "description": "Fuzzy search based on name or description", "name": "query", "in": "query" }, { "type": "string", "description": "The namespace of the managed cluster", "name": "namespace", "in": "query" }, { "type": "string", "description": "Name of the application delivery target", "name": "targetName", "in": "query" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ListApplicationResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } }, "post": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "create one application ", "operationId": "createApplication", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CreateApplicationRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ApplicationBase" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/payload_types": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "list application trigger payload types", "operationId": "ListPayloadTypes", "responses": { "200": {}, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "detail one application ", "operationId": "detailApplication", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.DetailApplicationResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } }, "put": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "update one application ", "operationId": "updateApplication", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.UpdateApplicationRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ApplicationBase" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } }, "delete": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "delete one application", "operationId": "deleteApplication", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.EmptyResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/components": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "gets the list of application components", "operationId": "listApplicationComponents", "parameters": [ { "type": "string", "description": "identifier of the application ", "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.ComponentListResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } }, "post": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "create component for application ", "operationId": "createComponent", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CreateComponentRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ComponentBase" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/components/{compName}": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "detail component for application ", "operationId": "detailComponent", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.DetailComponentResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } }, "put": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "update component config", "operationId": "updateComponent", "parameters": [ { "type": "string", "description": "identifier of the application", "name": "name", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.UpdateApplicationComponentRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ComponentBase" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/components/{compName}/traits": { "post": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "add trait for a component", "operationId": "addApplicationTrait", "parameters": [ { "type": "string", "description": "identifier of the application", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the component", "name": "compName", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CreateApplicationTraitRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.EmptyResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/components/{compName}/traits/{traitType}": { "put": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "update trait from a component", "operationId": "updateApplicationTrait", "parameters": [ { "type": "string", "description": "identifier of the application", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the component", "name": "compName", "in": "path", "required": true }, { "type": "string", "description": "identifier of the type of trait", "name": "traitType", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.UpdateApplicationTraitRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ApplicationTrait" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } }, "delete": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "delete trait from a component", "operationId": "deleteApplicationTrait", "parameters": [ { "type": "string", "description": "identifier of the application", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the component", "name": "compName", "in": "path", "required": true }, { "type": "string", "description": "identifier of the type of trait", "name": "traitType", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ApplicationTrait" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/deploy": { "post": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "deploy or upgrade the application", "operationId": "deployApplication", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ApplicationDeployRequest" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/envs": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "list policy for application", "operationId": "listApplicationEnvs", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ListApplicationEnvBinding" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } }, "post": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "creating an application environment ", "operationId": "createApplicationEnv", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CreateApplicationEnvbindingRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.EnvBinding" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/envs/{envName}": { "put": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "set application differences in the specified environment", "operationId": "updateApplicationEnv", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the envBinding ", "name": "envName", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.PutApplicationEnvBindingRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.EnvBinding" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } }, "delete": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "delete an application environment ", "operationId": "deleteApplicationEnv", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the envBinding ", "name": "envName", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.EmptyResponse" } }, "404": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/envs/{envName}/recycle": { "post": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "get application status", "operationId": "recycleApplicationEnv", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the application envbinding", "name": "envName", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.EmptyResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/envs/{envName}/status": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "get application status", "operationId": "getApplicationStatus", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the application envbinding", "name": "envName", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ApplicationStatusResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/policies": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "list policy for application", "operationId": "listApplicationPolicies", "parameters": [ { "type": "string", "description": "identifier of the application ", "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": [ "application" ], "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/applications/{name}/policies/{policyName}": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "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": [ "application" ], "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": [ "application" ], "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/applications/{name}/records": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "list application records", "operationId": "listApplicationRecords", "parameters": [ { "type": "string", "description": "identifier of the application.", "name": "name", "in": "path", "required": true } ], "responses": { "200": {}, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/revisions": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "list revisions for application", "operationId": "listApplicationRevisions", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "query identifier of the env", "name": "envName", "in": "query" }, { "type": "string", "description": "query identifier of the status", "name": "status", "in": "query" }, { "type": "integer", "description": "query the page number", "name": "page", "in": "query" }, { "type": "integer", "description": "query the page size number", "name": "pageSize", "in": "query" } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ListRevisionsResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/revisions/{revision}": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "detail revision for application", "operationId": "detailApplicationRevision", "parameters": [ { "type": "string", "description": "identifier of the application", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the application revision", "name": "revision", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.DetailRevisionResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/statistics": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "detail one application ", "operationId": "applicationStatistics", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ApplicationStatisticsResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/template": { "post": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "create one application template", "operationId": "publishApplicationTemplate", "parameters": [ { "type": "string", "description": "identifier of the application ", "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/applications/{name}/triggers": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "list application triggers", "operationId": "listApplicationTriggers", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ListApplicationTriggerResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } }, "post": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "create one application trigger", "operationId": "createApplicationTrigger", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CreateApplicationTriggerRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ApplicationTriggerBase" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/triggers/{token}": { "delete": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "delete one application trigger", "operationId": "deleteApplicationTrigger", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the trigger", "name": "token", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.EmptyResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/workflows": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "list application workflow", "operationId": "listApplicationWorkflows", "parameters": [ { "type": "string", "description": "identifier of the application.", "name": "name", "in": "path", "required": true } ], "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": [ "application" ], "summary": "create application workflow", "operationId": "createOrUpdateApplicationWorkflow", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CreateWorkflowRequest" } }, { "type": "string", "description": "identifier of the application.", "name": "name", "in": "path", "required": true } ], "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/applications/{name}/workflows/{workflowName}": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "detail application workflow", "operationId": "detailWorkflow", "parameters": [ { "type": "string", "description": "identifier of the application.", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the workfloc.", "name": "workflowName", "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": [ "application" ], "summary": "update application workflow config", "operationId": "updateWorkflow", "parameters": [ { "type": "string", "description": "identifier of the application.", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the workflow", "name": "workflowName", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.UpdateWorkflowRequest" } } ], "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": [ "application" ], "summary": "deletet workflow", "operationId": "deleteWorkflow", "parameters": [ { "type": "string", "description": "identifier of the application.", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the workflow", "name": "workflowName", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/map[string]string" } }, "500": { "description": "Bummer, something went wrong" } } } }, "/api/v1/applications/{name}/workflows/{workflowName}/records": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "query application workflow execution record", "operationId": "listWorkflowRecords", "parameters": [ { "type": "string", "description": "identifier of the application.", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the workflow", "name": "workflowName", "in": "path", "required": true }, { "type": "integer", "description": "query the page number", "name": "page", "in": "query" }, { "type": "integer", "description": "query the page size number", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/map[string]string" } }, "500": { "description": "Bummer, something went wrong" } } } }, "/api/v1/applications/{name}/workflows/{workflowName}/records/{record}": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "query application workflow execution record detail", "operationId": "detailWorkflowRecord", "parameters": [ { "type": "string", "description": "identifier of the application.", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the workflow", "name": "workflowName", "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" } } } }, "/api/v1/applications/{name}/workflows/{workflowName}/records/{record}/resume": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "resume suspend workflow record", "operationId": "resumeWorkflowRecord", "parameters": [ { "type": "string", "description": "identifier of the application.", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the workflow", "name": "workflowName", "in": "path", "required": true }, { "type": "string", "description": "identifier of the workflow record", "name": "record", "in": "path", "required": true } ], "responses": { "200": {}, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/workflows/{workflowName}/records/{record}/rollback": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "rollback suspend application record", "operationId": "rollbackWorkflowRecord", "parameters": [ { "type": "string", "description": "identifier of the application.", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the workflow", "name": "workflowName", "in": "path", "required": true }, { "type": "string", "description": "identifier of the workflow record", "name": "record", "in": "path", "required": true }, { "type": "string", "description": "identifier of the rollback revision", "name": "rollbackVersion", "in": "query" } ], "responses": { "200": {}, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/applications/{name}/workflows/{workflowName}/records/{record}/terminate": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "application" ], "summary": "terminate suspend workflow record", "operationId": "terminateWorkflowRecord", "parameters": [ { "type": "string", "description": "identifier of the application.", "name": "name", "in": "path", "required": true }, { "type": "string", "description": "identifier of the workflow", "name": "workflowName", "in": "path", "required": true }, { "type": "string", "description": "identifier of the workflow record", "name": "record", "in": "path", "required": true } ], "responses": { "200": {}, "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/clusters/{clusterName}/namespaces": { "post": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "cluster" ], "summary": "create namespace in cluster", "operationId": "createNamespace", "parameters": [ { "type": "string", "description": "name of the target cluster", "name": "clusterName", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CreateClusterNamespaceRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.CreateClusterNamespaceResponse" } }, "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": [ "component", "trait", "workflowstep" ], "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" }, { "type": "string", "description": "if specified, query the trait definition applied to the workload.", "name": "appliedWorkload", "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/enabled_addon": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "addon" ], "summary": "list all addons", "operationId": "list", "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/envs": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "env" ], "summary": "list all envs", "operationId": "list", "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ListEnvResponse" } } } }, "post": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "env" ], "summary": "create an env", "operationId": "create", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CreateEnvRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.Env" } } } } }, "/api/v1/envs/{name}": { "put": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "env" ], "summary": "update an env", "operationId": "update", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CreateEnvRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.Env" } } } }, "delete": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "env" ], "summary": "delete one env", "operationId": "delete", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.EmptyResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/api/v1/policy_definitions": { "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/projects": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "project" ], "summary": "list all projects", "operationId": "listprojects", "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ListProjectResponse" } } } }, "post": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "project" ], "summary": "create a project", "operationId": "createproject", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CreateProjectRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ProjectBase" } } } } }, "/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/targets": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "Target" ], "summary": "list Target", "operationId": "listTargets", "parameters": [ { "type": "integer", "description": "Page for paging", "name": "page", "in": "query" }, { "type": "integer", "description": "PageSize for paging", "name": "pageSize", "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": [ "Target" ], "summary": "create Target", "operationId": "createTarget", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.CreateTargetRequest" } } ], "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/targets/{name}": { "get": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "Target" ], "summary": "detail Target", "operationId": "detailTarget", "parameters": [ { "type": "string", "description": "identifier of the Target.", "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": [ "Target" ], "summary": "update application Target config", "operationId": "updateTarget", "parameters": [ { "type": "string", "description": "identifier of the Target", "name": "name", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.UpdateTargetRequest" } } ], "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": [ "Target" ], "summary": "deletet Target", "operationId": "deleteTarget", "parameters": [ { "type": "string", "description": "identifier of the Target", "name": "name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/map[string]string" } }, "500": { "description": "Bummer, something went wrong" } } } }, "/api/v1/webhook/{token}": { "post": { "consumes": [ "application/xml", "application/json" ], "produces": [ "application/json", "application/xml" ], "tags": [ "webhook" ], "summary": "handle application webhook request", "operationId": "handleApplicationWebhook", "parameters": [ { "type": "string", "description": "identifier of the application ", "name": "name", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1.HandleApplicationTriggerWebhookRequest" } } ], "responses": { "200": { "schema": { "$ref": "#/definitions/v1.ApplicationDeployResponse" } }, "400": { "schema": { "$ref": "#/definitions/bcode.Bcode" } } } } }, "/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": { "*v1.ApplicationTriggerBase": {}, "*v1.EmptyResponse": {}, "addon.Dependency": { "properties": { "name": { "type": "string" } } }, "addon.DeployTo": { "required": [ "runtime_cluster", "disableControlPlane", "runtimeCluster" ], "properties": { "disableControlPlane": { "type": "boolean" }, "runtimeCluster": { "type": "boolean" }, "runtime_cluster": { "type": "boolean" } } }, "addon.GitAddonSource": { "properties": { "path": { "type": "string" }, "token": { "type": "string" }, "url": { "type": "string" } } }, "addon.Meta": { "required": [ "name", "version", "description", "icon", "invisible" ], "properties": { "dependencies": { "type": "array", "items": { "$ref": "#/definitions/addon.Dependency" } }, "deployTo": { "$ref": "#/definitions/addon.DeployTo" }, "description": { "type": "string" }, "icon": { "type": "string" }, "invisible": { "type": "boolean" }, "name": { "type": "string" }, "needNamespace": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "url": { "type": "string" }, "version": { "type": "string" } } }, "addon.OSSAddonSource": { "required": [ "end_point", "bucket", "path" ], "properties": { "bucket": { "type": "string" }, "end_point": { "type": "string" }, "path": { "type": "string" } } }, "bcode.Bcode": { "required": [ "BusinessCode", "Message" ], "properties": { "BusinessCode": { "type": "integer", "format": "int32" }, "Message": { "type": "string" } } }, "cloudprovider.CloudCluster": { "required": [ "provider", "id", "name", "type", "zone", "zoneID", "regionID", "vpcID", "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" }, "regionID": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "vpcID": { "type": "string" }, "zone": { "type": "string" }, "zoneID": { "type": "string" } } }, "common.AppRolloutStatus": { "required": [ "rollingState", "upgradedReadyReplicas", "currentBatch", "upgradedReplicas", "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" }, "policy": { "type": "array", "items": { "$ref": "#/definitions/common.PolicyStatus" } }, "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.PolicyStatus": { "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "type": { "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" }, "message": { "type": "string" }, "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.ApplicationComponent": { "required": [ "createTime", "updateTime", "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.ApplicationTrait" } }, "type": { "type": "string" }, "updateTime": { "type": "string", "format": "date-time" } } }, "model.ApplicationRevision": { "required": [ "createTime", "updateTime", "appPrimaryKey", "version", "status", "reason", "deployUser", "note", "triggerType", "workflowName", "envName" ], "properties": { "appPrimaryKey": { "type": "string" }, "applyAppConfig": { "type": "string" }, "codeInfo": { "$ref": "#/definitions/model.CodeInfo" }, "createTime": { "type": "string", "format": "date-time" }, "deployUser": { "type": "string" }, "envName": { "type": "string" }, "imageInfo": { "$ref": "#/definitions/model.ImageInfo" }, "note": { "type": "string" }, "reason": { "type": "string" }, "rollbackVersion": { "type": "string" }, "status": { "type": "string" }, "triggerType": { "type": "string" }, "updateTime": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "workflowName": { "type": "string" } } }, "model.ApplicationTrait": { "required": [ "alias", "description", "type", "createTime", "updateTime" ], "properties": { "alias": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "properties": { "$ref": "#/definitions/model.JSONStruct" }, "type": { "type": "string" }, "updateTime": { "type": "string", "format": "date-time" } } }, "model.BaseModel": { "required": [ "createTime", "updateTime" ], "properties": { "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" } } }, "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.CodeInfo": { "properties": { "branch": { "type": "string" }, "commit": { "type": "string" }, "user": { "type": "string" } } }, "model.ImageInfo": { "required": [ "type" ], "properties": { "repository": { "$ref": "#/definitions/model.ImageRepository" }, "resource": { "$ref": "#/definitions/model.ImageResource" }, "type": { "type": "string" } } }, "model.ImageRepository": { "required": [ "name", "namespace", "fullName", "type" ], "properties": { "createTime": { "type": "string", "format": "date-time" }, "fullName": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "region": { "type": "string" }, "type": { "type": "string" } } }, "model.ImageResource": { "required": [ "digest", "tag", "url" ], "properties": { "createTime": { "type": "string", "format": "date-time" }, "digest": { "type": "string" }, "tag": { "type": "string" }, "url": { "type": "string" } } }, "model.JSONStruct": { "type": "object" }, "model.ProviderInfo": { "required": [ "provider", "clusterID", "labels" ], "properties": { "clusterID": { "type": "string" }, "clusterName": { "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "provider": { "type": "string" }, "regionID": { "type": "string" }, "vpcID": { "type": "string" }, "zone": { "type": "string" }, "zoneID": { "type": "string" } } }, "model.WorkflowStepStatus": { "required": [ "id", "name", "alias" ], "properties": { "alias": { "type": "string" }, "firstExecuteTime": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "lastExecuteTime": { "type": "string", "format": "date-time" }, "message": { "type": "string" }, "name": { "type": "string" }, "phase": { "type": "string" }, "reason": { "type": "string" }, "type": { "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.GroupOption": { "required": [ "label", "keys" ], "properties": { "keys": { "type": "array", "items": { "type": "string" } }, "label": { "type": "string" } } }, "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": { "additional": { "type": "boolean" }, "additionalParameter": { "$ref": "#/definitions/utils.UIParameter" }, "description": { "type": "string" }, "disable": { "type": "boolean" }, "jsonKey": { "type": "string" }, "label": { "type": "string" }, "sort": { "type": "integer", "format": "integer" }, "subParameterGroupOption": { "type": "array", "items": { "$ref": "#/definitions/utils.GroupOption" } }, "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.AddonBaseStatus": { "required": [ "name", "phase" ], "properties": { "name": { "type": "string" }, "phase": { "type": "string" } } }, "v1.AddonDefinition": { "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } } }, "v1.AddonInfo": { "required": [ "Meta", "registryName" ], "properties": { "Meta": { "$ref": "#/definitions/addon.Meta" }, "registryName": { "type": "string" } } }, "v1.AddonRegistry": { "required": [ "name" ], "properties": { "git": { "$ref": "#/definitions/addon.GitAddonSource" }, "name": { "type": "string" }, "oss": { "$ref": "#/definitions/addon.OSSAddonSource" } } }, "v1.AddonStatusResponse": { "required": [ "name", "phase", "args" ], "properties": { "appStatus": { "$ref": "#/definitions/common.AppStatus" }, "args": { "type": "object", "additionalProperties": { "type": "string" } }, "clusters": { "type": "object", "additionalProperties": { "$ref": "#/definitions/v1.AddonStatusResponse.clusters" } }, "enabling_progress": { "$ref": "#/definitions/v1.EnablingProgress" }, "name": { "type": "string" }, "phase": { "type": "string" } } }, "v1.AddonStatusResponse.clusters": { "type": "object" }, "v1.ApplicationBase": { "required": [ "name", "alias", "project", "description", "createTime", "updateTime", "icon" ], "properties": { "alias": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "icon": { "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "project": { "$ref": "#/definitions/v1.ProjectBase" }, "updateTime": { "type": "string", "format": "date-time" } } }, "v1.ApplicationDeployRequest": { "required": [ "workflowName", "note", "triggerType", "force" ], "properties": { "codeInfo": { "$ref": "#/definitions/model.CodeInfo" }, "force": { "type": "boolean" }, "imageInfo": { "$ref": "#/definitions/model.ImageInfo" }, "note": { "type": "string" }, "triggerType": { "type": "string" }, "workflowName": { "type": "string" } } }, "v1.ApplicationDeployResponse": { "required": [ "status", "note", "envName", "triggerType", "version", "createTime" ], "properties": { "codeInfo": { "$ref": "#/definitions/model.CodeInfo" }, "createTime": { "type": "string", "format": "date-time" }, "deployUser": { "type": "string" }, "envName": { "type": "string" }, "imageInfo": { "$ref": "#/definitions/model.ImageInfo" }, "note": { "type": "string" }, "reason": { "type": "string" }, "status": { "type": "string" }, "triggerType": { "type": "string" }, "version": { "type": "string" } } }, "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": "int64" } } }, "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.ApplicationRevisionBase": { "required": [ "createTime", "version", "status", "note", "envName", "triggerType" ], "properties": { "codeInfo": { "$ref": "#/definitions/model.CodeInfo" }, "createTime": { "type": "string", "format": "date-time" }, "deployUser": { "type": "string" }, "envName": { "type": "string" }, "imageInfo": { "$ref": "#/definitions/model.ImageInfo" }, "note": { "type": "string" }, "reason": { "type": "string" }, "status": { "type": "string" }, "triggerType": { "type": "string" }, "version": { "type": "string" } } }, "v1.ApplicationStatisticsResponse": { "required": [ "envCount", "targetCount", "revisonCount", "workflowCount" ], "properties": { "envCount": { "type": "integer", "format": "int64" }, "revisonCount": { "type": "integer", "format": "int64" }, "targetCount": { "type": "integer", "format": "int64" }, "workflowCount": { "type": "integer", "format": "int64" } } }, "v1.ApplicationStatusResponse": { "required": [ "envName", "status" ], "properties": { "envName": { "type": "string" }, "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.ApplicationTrait": { "required": [ "name", "type", "properties", "createTime", "updateTime" ], "properties": { "alias": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "name": { "type": "string" }, "properties": { "$ref": "#/definitions/model.JSONStruct" }, "type": { "type": "string" }, "updateTime": { "type": "string", "format": "date-time" } } }, "v1.ApplicationTriggerBase": { "required": [ "name", "workflowName", "type", "payloadType", "token", "createTime", "updateTime" ], "properties": { "alias": { "type": "string" }, "componentName": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "name": { "type": "string" }, "payloadType": { "type": "string" }, "token": { "type": "string" }, "type": { "type": "string" }, "updateTime": { "type": "string", "format": "date-time" }, "workflowName": { "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.ClusterTarget": { "required": [ "clusterName" ], "properties": { "clusterName": { "type": "string" }, "namespace": { "type": "string" } } }, "v1.ComponentBase": { "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.ComponentListResponse": { "required": [ "components" ], "properties": { "components": { "type": "array", "items": { "$ref": "#/definitions/v1.ComponentBase" } } } }, "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/addon.GitAddonSource" }, "name": { "type": "string" }, "oss": { "$ref": "#/definitions/addon.OSSAddonSource" } } }, "v1.CreateApplicationEnvbindingRequest": { "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "v1.CreateApplicationRequest": { "required": [ "name", "project", "icon", "component" ], "properties": { "alias": { "type": "string" }, "component": { "$ref": "#/definitions/v1.CreateComponentRequest" }, "description": { "type": "string" }, "envBinding": { "type": "array", "items": { "$ref": "#/definitions/v1.EnvBinding" } }, "icon": { "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "project": { "type": "string" } } }, "v1.CreateApplicationTemplateRequest": { "required": [ "templateName", "version", "description" ], "properties": { "description": { "type": "string" }, "templateName": { "type": "string" }, "version": { "type": "string" } } }, "v1.CreateApplicationTraitRequest": { "required": [ "type", "properties" ], "properties": { "alias": { "type": "string" }, "description": { "type": "string" }, "properties": { "type": "string" }, "type": { "type": "string" } } }, "v1.CreateApplicationTriggerRequest": { "required": [ "name", "workflowName", "type", "payloadType" ], "properties": { "alias": { "type": "string" }, "componentName": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "payloadType": { "type": "string" }, "type": { "type": "string" }, "workflowName": { "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": [ "clusterName", "clusterID", "status" ], "properties": { "clusterID": { "type": "string" }, "clusterName": { "type": "string" }, "status": { "type": "string" } } }, "v1.CreateClusterNamespaceRequest": { "required": [ "namespace" ], "properties": { "namespace": { "type": "string" } } }, "v1.CreateClusterNamespaceResponse": { "required": [ "exists" ], "properties": { "exists": { "type": "boolean" } } }, "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.CreateComponentRequest": { "required": [ "name", "componentType" ], "properties": { "alias": { "type": "string" }, "componentType": { "type": "string" }, "dependsOn": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "icon": { "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "properties": { "type": "string" }, "traits": { "type": "array", "items": { "$ref": "#/definitions/v1.CreateApplicationTraitRequest" } } } }, "v1.CreateEnvRequest": { "required": [ "name", "project", "namespace" ], "properties": { "alias": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "project": { "type": "string" }, "targets": { "type": "array", "items": { "type": "string" } } } }, "v1.CreatePolicyRequest": { "required": [ "name", "description", "type", "properties" ], "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "properties": { "type": "string" }, "type": { "type": "string" } } }, "v1.CreateProjectRequest": { "required": [ "name" ], "properties": { "alias": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" } } }, "v1.CreateTargetRequest": { "required": [ "name" ], "properties": { "alias": { "type": "string" }, "cluster": { "$ref": "#/definitions/v1.ClusterTarget" }, "description": { "type": "string" }, "name": { "type": "string" }, "variable": { "type": "object" } } }, "v1.CreateWorkflowRequest": { "required": [ "name", "default", "envName" ], "properties": { "alias": { "type": "string" }, "default": { "type": "boolean" }, "description": { "type": "string" }, "envName": { "type": "string" }, "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" }, "workloadType": { "type": "string" } } }, "v1.DetailAddonResponse": { "required": [ "name", "version", "description", "icon", "invisible", "schema", "uiSchema", "definitions" ], "properties": { "definitions": { "type": "array", "items": { "$ref": "#/definitions/v1.AddonDefinition" } }, "dependencies": { "type": "array", "items": { "$ref": "#/definitions/addon.Dependency" } }, "deployTo": { "$ref": "#/definitions/addon.DeployTo" }, "description": { "type": "string" }, "detail": { "type": "string" }, "icon": { "type": "string" }, "invisible": { "type": "boolean" }, "name": { "type": "string" }, "needNamespace": { "type": "array", "items": { "type": "string" } }, "registryName": { "type": "string" }, "schema": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "uiSchema": { "type": "array", "items": { "$ref": "#/definitions/utils.UIParameter" } }, "url": { "type": "string" }, "version": { "type": "string" } } }, "v1.DetailApplicationResponse": { "required": [ "alias", "project", "description", "createTime", "updateTime", "icon", "name", "policies", "envBindings", "status", "applicationType", "resourceInfo" ], "properties": { "alias": { "type": "string" }, "applicationType": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "envBindings": { "type": "array", "items": { "type": "string" } }, "icon": { "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } }, "name": { "type": "string" }, "policies": { "type": "array", "items": { "type": "string" } }, "project": { "$ref": "#/definitions/v1.ProjectBase" }, "resourceInfo": { "$ref": "#/definitions/v1.ApplicationResourceInfo" }, "status": { "type": "string" }, "updateTime": { "type": "string", "format": "date-time" } } }, "v1.DetailClusterResponse": { "required": [ "createTime", "status", "provider", "kubeConfig", "updateTime", "kubeConfigSecret", "alias", "icon", "reason", "apiServerURL", "dashboardURL", "name", "description", "labels", "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.DetailComponentResponse": { "required": [ "createTime", "creator", "name", "alias", "updateTime", "appPrimaryKey", "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.ApplicationTrait" } }, "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": [ "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.DetailRevisionResponse": { "required": [ "reason", "status", "workflowName", "triggerType", "createTime", "version", "deployUser", "note", "envName", "updateTime", "appPrimaryKey" ], "properties": { "appPrimaryKey": { "type": "string" }, "applyAppConfig": { "type": "string" }, "codeInfo": { "$ref": "#/definitions/model.CodeInfo" }, "createTime": { "type": "string", "format": "date-time" }, "deployUser": { "type": "string" }, "envName": { "type": "string" }, "imageInfo": { "$ref": "#/definitions/model.ImageInfo" }, "note": { "type": "string" }, "reason": { "type": "string" }, "rollbackVersion": { "type": "string" }, "status": { "type": "string" }, "triggerType": { "type": "string" }, "updateTime": { "type": "string", "format": "date-time" }, "version": { "type": "string" }, "workflowName": { "type": "string" } } }, "v1.DetailTargetResponse": { "required": [ "createTime", "updateTime", "name" ], "properties": { "alias": { "type": "string" }, "appNum": { "type": "integer", "format": "int64" }, "cluster": { "$ref": "#/definitions/v1.ClusterTarget" }, "clusterAlias": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "name": { "type": "string" }, "updateTime": { "type": "string", "format": "date-time" }, "variable": { "type": "object" } } }, "v1.DetailWorkflowRecordResponse": { "required": [ "status", "name", "namespace", "workflowName", "workflowAlias", "applicationRevision", "deployTime", "deployUser", "note", "triggerType" ], "properties": { "applicationRevision": { "type": "string" }, "deployTime": { "type": "string", "format": "date-time" }, "deployUser": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "note": { "type": "string" }, "startTime": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "steps": { "type": "array", "items": { "$ref": "#/definitions/model.WorkflowStepStatus" } }, "triggerType": { "type": "string" }, "workflowAlias": { "type": "string" }, "workflowName": { "type": "string" } } }, "v1.DetailWorkflowResponse": { "required": [ "createTime", "name", "description", "enable", "default", "alias", "envName", "updateTime" ], "properties": { "alias": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "default": { "type": "boolean" }, "description": { "type": "string" }, "enable": { "type": "boolean" }, "envName": { "type": "string" }, "name": { "type": "string" }, "steps": { "type": "array", "items": { "$ref": "#/definitions/v1.WorkflowStep" } }, "updateTime": { "type": "string", "format": "date-time" } } }, "v1.EmptyResponse": {}, "v1.EnableAddonRequest": { "properties": { "args": { "type": "object" } } }, "v1.EnablingProgress": { "required": [ "enabled_components", "total_components" ], "properties": { "enabled_components": { "type": "integer", "format": "int32" }, "total_components": { "type": "integer", "format": "int32" } } }, "v1.Env": { "required": [ "name", "alias", "project", "namespace", "createTime", "updateTime" ], "properties": { "alias": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "project": { "$ref": "#/definitions/v1.NameAlias" }, "targets": { "type": "array", "items": { "$ref": "#/definitions/v1.NameAlias" } }, "updateTime": { "type": "string", "format": "date-time" } } }, "v1.EnvBinding": { "required": [ "name" ], "properties": { "name": { "type": "string" } } }, "v1.EnvBindingBase": { "required": [ "name", "targetNames", "createTime", "updateTime", "appDeployName", "appDeployNamespace" ], "properties": { "alias": { "type": "string" }, "appDeployName": { "type": "string" }, "appDeployNamespace": { "type": "string" }, "componentSelector": { "$ref": "#/definitions/v1.ComponentSelector" }, "createTime": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "name": { "type": "string" }, "targetNames": { "type": "array", "items": { "type": "string" } }, "targets": { "type": "array", "items": { "$ref": "#/definitions/v1.EnvBindingTarget" } }, "updateTime": { "type": "string", "format": "date-time" } } }, "v1.EnvBindingTarget": { "required": [ "name", "alias" ], "properties": { "alias": { "type": "string" }, "cluster": { "$ref": "#/definitions/v1.ClusterTarget" }, "name": { "type": "string" } } }, "v1.HandleApplicationTriggerWebhookRequest": { "properties": { "codeInfo": { "$ref": "#/definitions/model.CodeInfo" }, "upgrade": { "type": "object", "additionalProperties": { "$ref": "#/definitions/model.JSONStruct" } } } }, "v1.ListAddonRegistryResponse": { "required": [ "registries" ], "properties": { "registries": { "type": "array", "items": { "$ref": "#/definitions/v1.AddonRegistry" } } } }, "v1.ListAddonResponse": { "required": [ "addons" ], "properties": { "addons": { "type": "array", "items": { "$ref": "#/definitions/v1.AddonInfo" } }, "message": { "type": "string" } } }, "v1.ListApplicationEnvBinding": { "required": [ "envBindings" ], "properties": { "envBindings": { "type": "array", "items": { "$ref": "#/definitions/v1.EnvBindingBase" } } } }, "v1.ListApplicationPolicy": { "required": [ "policies" ], "properties": { "policies": { "type": "array", "items": { "$ref": "#/definitions/v1.PolicyBase" } } } }, "v1.ListApplicationResponse": { "required": [ "applications" ], "properties": { "applications": { "type": "array", "items": { "$ref": "#/definitions/v1.ApplicationBase" } } } }, "v1.ListApplicationTriggerResponse": { "required": [ "triggers" ], "properties": { "triggers": { "type": "array", "items": { "$ref": "#/definitions/v1.ApplicationTriggerBase" } } } }, "v1.ListCloudClusterCreationResponse": { "required": [ "creations" ], "properties": { "creations": { "type": "array", "items": { "$ref": "#/definitions/v1.CreateCloudClusterResponse" } } } }, "v1.ListCloudClusterResponse": { "required": [ "clusters", "total" ], "properties": { "clusters": { "type": "array", "items": { "$ref": "#/definitions/cloudprovider.CloudCluster" } }, "total": { "type": "integer", "format": "int32" } } }, "v1.ListClusterResponse": { "required": [ "clusters", "total" ], "properties": { "clusters": { "type": "array", "items": { "$ref": "#/definitions/v1.ClusterBase" } }, "total": { "type": "integer", "format": "int64" } } }, "v1.ListDefinitionResponse": { "required": [ "definitions" ], "properties": { "definitions": { "type": "array", "items": { "$ref": "#/definitions/v1.DefinitionBase" } } } }, "v1.ListEnvResponse": { "required": [ "envs" ], "properties": { "envs": { "type": "array", "items": { "$ref": "#/definitions/v1.Env" } } } }, "v1.ListPolicyDefinitionResponse": { "required": [ "policyDefinitions" ], "properties": { "policyDefinitions": { "type": "array", "items": { "$ref": "#/definitions/v1.PolicyDefinition" } } } }, "v1.ListProjectResponse": { "required": [ "projects" ], "properties": { "projects": { "type": "array", "items": { "$ref": "#/definitions/v1.ProjectBase" } } } }, "v1.ListRevisionsResponse": { "required": [ "revisions", "total" ], "properties": { "revisions": { "type": "array", "items": { "$ref": "#/definitions/v1.ApplicationRevisionBase" } }, "total": { "type": "integer", "format": "int64" } } }, "v1.ListTargetResponse": { "required": [ "targets", "total" ], "properties": { "targets": { "type": "array", "items": { "$ref": "#/definitions/v1.TargetBase" } }, "total": { "type": "integer", "format": "int64" } } }, "v1.ListWorkflowRecordsResponse": { "required": [ "records", "total" ], "properties": { "records": { "type": "array", "items": { "$ref": "#/definitions/v1.WorkflowRecord" } }, "total": { "type": "integer", "format": "int64" } } }, "v1.ListWorkflowResponse": { "required": [ "workflows" ], "properties": { "workflows": { "type": "array", "items": { "$ref": "#/definitions/v1.WorkflowBase" } } } }, "v1.NameAlias": { "required": [ "name", "alias" ], "properties": { "alias": { "type": "string" }, "name": { "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.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.ProjectBase": { "required": [ "name", "alias", "description", "createTime", "updateTime" ], "properties": { "alias": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "name": { "type": "string" }, "updateTime": { "type": "string", "format": "date-time" } } }, "v1.PutApplicationEnvBindingRequest": {}, "v1.TargetBase": { "required": [ "name", "createTime", "updateTime" ], "properties": { "alias": { "type": "string" }, "appNum": { "type": "integer", "format": "int64" }, "cluster": { "$ref": "#/definitions/v1.ClusterTarget" }, "clusterAlias": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "name": { "type": "string" }, "updateTime": { "type": "string", "format": "date-time" }, "variable": { "type": "object" } } }, "v1.UpdateAddonRegistryRequest": { "properties": { "git": { "$ref": "#/definitions/addon.GitAddonSource" }, "oss": { "$ref": "#/definitions/addon.OSSAddonSource" } } }, "v1.UpdateApplicationComponentRequest": { "properties": { "alias": { "type": "string" }, "dependsOn": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "icon": { "type": "string" }, "labels": { "$ref": "#/definitions/v1.UpdateApplicationComponentRequest.labels" }, "properties": { "type": "string" } } }, "v1.UpdateApplicationComponentRequest.labels": { "type": "object", "additionalProperties": { "type": "string" } }, "v1.UpdateApplicationRequest": { "properties": { "alias": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "labels": { "type": "object", "additionalProperties": { "type": "string" } } } }, "v1.UpdateApplicationTraitRequest": { "required": [ "properties" ], "properties": { "alias": { "type": "string" }, "description": { "type": "string" }, "properties": { "type": "string" } } }, "v1.UpdatePolicyRequest": { "required": [ "description", "type", "properties" ], "properties": { "description": { "type": "string" }, "properties": { "type": "string" }, "type": { "type": "string" } } }, "v1.UpdateTargetRequest": { "properties": { "alias": { "type": "string" }, "description": { "type": "string" }, "variable": { "type": "object" } } }, "v1.UpdateWorkflowRequest": { "required": [ "default" ], "properties": { "alias": { "type": "string" }, "default": { "type": "boolean" }, "description": { "type": "string" }, "steps": { "type": "array", "items": { "$ref": "#/definitions/v1.WorkflowStep" } } } }, "v1.VelaQLViewResponse": { "type": "object" }, "v1.WorkflowBase": { "required": [ "name", "alias", "description", "enable", "default", "envName", "createTime", "updateTime" ], "properties": { "alias": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "default": { "type": "boolean" }, "description": { "type": "string" }, "enable": { "type": "boolean" }, "envName": { "type": "string" }, "name": { "type": "string" }, "steps": { "type": "array", "items": { "$ref": "#/definitions/v1.WorkflowStep" } }, "updateTime": { "type": "string", "format": "date-time" } } }, "v1.WorkflowRecord": { "required": [ "name", "namespace", "workflowName", "workflowAlias", "applicationRevision", "status" ], "properties": { "applicationRevision": { "type": "string" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "startTime": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "steps": { "type": "array", "items": { "$ref": "#/definitions/model.WorkflowStepStatus" } }, "workflowAlias": { "type": "string" }, "workflowName": { "type": "string" } } }, "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" } } }, "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.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" } } } } }