Files
onepanel/api/api.swagger.json

4493 lines
106 KiB
JSON

{
"swagger": "2.0",
"info": {
"title": "Onepanel",
"description": "Onepanel API",
"version": "1.0.0",
"contact": {
"name": "Onepanel project",
"url": "https://github.com/onepanelio/core"
}
},
"host": "localhost:8888",
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json",
"application/octet-stream"
],
"paths": {
"/apis/v1beta/service/{name}": {
"get": {
"operationId": "HasService",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/HasServiceResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ServiceService"
]
}
},
"/apis/v1beta/{namespace}/field/workflow_executions/{fieldName}": {
"get": {
"operationId": "ListWorkflowExecutionsField",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListWorkflowExecutionsFieldResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "fieldName",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkflowService"
]
}
},
"/apis/v1beta/{namespace}/field/workflow_templates/{fieldName}": {
"get": {
"operationId": "ListWorkflowTemplatesField",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListWorkflowTemplatesFieldResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "fieldName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "isSystem",
"in": "query",
"required": false,
"type": "boolean"
}
],
"tags": [
"WorkflowTemplateService"
]
}
},
"/apis/v1beta/{namespace}/field/workspace_templates/{fieldName}": {
"get": {
"operationId": "ListWorkspaceTemplatesField",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListWorkspaceTemplatesFieldResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "fieldName",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkspaceTemplateService"
]
}
},
"/apis/v1beta/{namespace}/field/workspaces/{fieldName}": {
"get": {
"operationId": "ListWorkspacesField",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListWorkspacesFieldResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "fieldName",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkspaceService"
]
}
},
"/apis/v1beta1/auth": {
"post": {
"operationId": "IsAuthorized",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/IsAuthorizedResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/IsAuthorized"
}
}
],
"tags": [
"AuthService"
]
}
},
"/apis/v1beta1/auth/get_access_token": {
"post": {
"operationId": "GetAccessToken",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetAccessTokenResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/GetAccessTokenRequest"
}
}
],
"tags": [
"AuthService"
],
"security": []
}
},
"/apis/v1beta1/auth/token": {
"post": {
"operationId": "IsValidToken",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/IsValidTokenResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/IsValidTokenRequest"
}
}
],
"tags": [
"AuthService"
]
}
},
"/apis/v1beta1/config": {
"get": {
"operationId": "GetConfig",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetConfigResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"tags": [
"ConfigService"
]
}
},
"/apis/v1beta1/namespaces": {
"get": {
"operationId": "ListNamespaces",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListNamespacesResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "query",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"NamespaceService"
]
},
"post": {
"operationId": "CreateNamespace",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/Namespace"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Namespace"
}
}
],
"tags": [
"NamespaceService"
]
}
},
"/apis/v1beta1/{namespace}/config": {
"get": {
"operationId": "GetNamespaceConfig",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetNamespaceConfigResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ConfigService"
]
}
},
"/apis/v1beta1/{namespace}/cron_workflow": {
"post": {
"operationId": "CreateCronWorkflow",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/CronWorkflow"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CronWorkflow"
}
}
],
"tags": [
"CronWorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/cron_workflow/{uid}": {
"get": {
"operationId": "GetCronWorkflow",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/CronWorkflow"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"CronWorkflowService"
]
},
"put": {
"operationId": "UpdateCronWorkflow",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/CronWorkflow"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CronWorkflow"
}
}
],
"tags": [
"CronWorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/cron_workflows": {
"get": {
"operationId": "ListCronWorkflows",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListCronWorkflowsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "workflowTemplateName",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"tags": [
"CronWorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/cron_workflows/{uid}": {
"delete": {
"operationId": "DeleteCronWorkflow",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"CronWorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/cron_workflows/{workflowTemplateName}": {
"get": {
"operationId": "ListCronWorkflows2",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListCronWorkflowsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "workflowTemplateName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"tags": [
"CronWorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/files/list/{path}": {
"get": {
"operationId": "ListFiles",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListFilesResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "path",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "perPage",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"tags": [
"FileService"
]
}
},
"/apis/v1beta1/{namespace}/files/presigned-url/{key}": {
"get": {
"operationId": "GetObjectDownloadPresignedUrl",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetPresignedUrlResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "key",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"FileService"
]
}
},
"/apis/v1beta1/{namespace}/secrets": {
"get": {
"operationId": "ListSecrets",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListSecretsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"SecretService"
]
},
"post": {
"operationId": "CreateSecret",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Secret"
}
}
],
"tags": [
"SecretService"
]
}
},
"/apis/v1beta1/{namespace}/secrets/{name}": {
"get": {
"operationId": "GetSecret",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/Secret"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"SecretService"
]
},
"delete": {
"operationId": "DeleteSecret",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/DeleteSecretResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"SecretService"
]
}
},
"/apis/v1beta1/{namespace}/secrets/{name}/exists": {
"get": {
"operationId": "SecretExists",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/SecretExistsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"SecretService"
]
}
},
"/apis/v1beta1/{namespace}/secrets/{secret.name}": {
"post": {
"operationId": "AddSecretKeyValue",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/AddSecretKeyValueResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "secret.name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Secret"
}
}
],
"tags": [
"SecretService"
]
},
"patch": {
"operationId": "UpdateSecretKeyValue",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/UpdateSecretKeyValueResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "secret.name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Secret"
}
}
],
"tags": [
"SecretService"
]
}
},
"/apis/v1beta1/{namespace}/secrets/{secretName}/keys/{key}": {
"delete": {
"operationId": "DeleteSecretKey",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/DeleteSecretKeyResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "secretName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "key",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"SecretService"
]
}
},
"/apis/v1beta1/{namespace}/service": {
"get": {
"operationId": "ListServices",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListServicesResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
}
],
"tags": [
"ServiceService"
]
}
},
"/apis/v1beta1/{namespace}/service/{name}": {
"get": {
"operationId": "GetService",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/Service"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ServiceService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_execution/statistics": {
"get": {
"operationId": "GetWorkflowExecutionStatisticsForNamespace",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetWorkflowExecutionStatisticsForNamespaceResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_executions": {
"get": {
"operationId": "ListWorkflowExecutions",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListWorkflowExecutionsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "workflowTemplateUid",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "workflowTemplateVersion",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "order",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "labels",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "phase",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "includeSystem",
"in": "query",
"required": false,
"type": "boolean"
}
],
"tags": [
"WorkflowService"
]
},
"post": {
"summary": "Creates a Workflow",
"operationId": "CreateWorkflowExecution",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowExecution"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateWorkflowExecutionBody"
}
}
],
"tags": [
"WorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_executions/{uid}": {
"get": {
"operationId": "GetWorkflowExecution",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowExecution"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkflowService"
]
},
"post": {
"summary": "Clone a Workflow. This is the same as running it again.",
"operationId": "CloneWorkflowExecution",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowExecution"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_executions/{uid}/cron_start_statistics": {
"post": {
"operationId": "CronStartWorkflowExecutionStatistic",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Statistics"
}
}
],
"tags": [
"WorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_executions/{uid}/metric": {
"post": {
"operationId": "AddWorkflowExecutionMetrics",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowExecutionsMetricsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AddWorkflowExecutionsMetricsRequest"
}
}
],
"tags": [
"WorkflowService"
]
},
"put": {
"operationId": "UpdateWorkflowExecutionMetrics",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowExecutionsMetricsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateWorkflowExecutionsMetricsRequest"
}
}
],
"tags": [
"WorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_executions/{uid}/pods/{podName}/containers/{containerName}/logs": {
"get": {
"operationId": "GetWorkflowExecutionLogs",
"responses": {
"200": {
"description": "A successful response.(streaming responses)",
"schema": {
"type": "object",
"properties": {
"result": {
"$ref": "#/definitions/LogStreamResponse"
},
"error": {
"$ref": "#/definitions/google.rpc.Status"
}
},
"title": "Stream result of LogStreamResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "podName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "containerName",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_executions/{uid}/pods/{podName}/metrics": {
"get": {
"operationId": "GetWorkflowExecutionMetrics",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetWorkflowExecutionMetricsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "podName",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_executions/{uid}/resubmit": {
"put": {
"operationId": "ResubmitWorkflowExecution",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowExecution"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_executions/{uid}/statistics": {
"post": {
"operationId": "AddWorkflowExecutionStatistics",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Statistics"
}
}
],
"tags": [
"WorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_executions/{uid}/status": {
"put": {
"operationId": "UpdateWorkflowExecutionStatus",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WorkflowExecutionStatus"
}
}
],
"tags": [
"WorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_executions/{uid}/terminate": {
"put": {
"operationId": "TerminateWorkflowExecution",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_executions/{uid}/watch": {
"get": {
"operationId": "WatchWorkflowExecution",
"responses": {
"200": {
"description": "A successful response.(streaming responses)",
"schema": {
"type": "object",
"properties": {
"result": {
"$ref": "#/definitions/WorkflowExecution"
},
"error": {
"$ref": "#/definitions/google.rpc.Status"
}
},
"title": "Stream result of WorkflowExecution"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkflowService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_templates": {
"get": {
"operationId": "ListWorkflowTemplates",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListWorkflowTemplatesResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "labels",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"WorkflowTemplateService"
]
},
"post": {
"operationId": "CreateWorkflowTemplate",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowTemplate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WorkflowTemplate"
}
}
],
"tags": [
"WorkflowTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_templates/{uid}": {
"get": {
"operationId": "GetWorkflowTemplate",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowTemplate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string",
"format": "int64"
}
],
"tags": [
"WorkflowTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_templates/{uid}/archive": {
"put": {
"operationId": "ArchiveWorkflowTemplate",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ArchiveWorkflowTemplateResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkflowTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_templates/{uid}/clone/{name}": {
"get": {
"operationId": "CloneWorkflowTemplate",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowTemplate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string",
"format": "int64"
}
],
"tags": [
"WorkflowTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_templates/{uid}/clone/{name}/{version}": {
"get": {
"operationId": "CloneWorkflowTemplate2",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowTemplate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"required": true,
"type": "string",
"format": "int64"
}
],
"tags": [
"WorkflowTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_templates/{uid}/generate": {
"post": {
"summary": "Get the generated WorkflowTemplate, applying any modifications based on the content",
"operationId": "GenerateWorkflowTemplate",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowTemplate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WorkflowTemplate"
}
}
],
"tags": [
"WorkflowTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_templates/{uid}/versions": {
"get": {
"operationId": "ListWorkflowTemplateVersions",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListWorkflowTemplateVersionsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkflowTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_templates/{uid}/versions/{version}": {
"get": {
"operationId": "GetWorkflowTemplate2",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowTemplate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "path",
"required": true,
"type": "string",
"format": "int64"
}
],
"tags": [
"WorkflowTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workflow_templates/{workflowTemplate.uid}/versions": {
"post": {
"operationId": "CreateWorkflowTemplateVersion",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowTemplate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "workflowTemplate.uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WorkflowTemplate"
}
}
],
"tags": [
"WorkflowTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workspace/statistics": {
"get": {
"operationId": "GetWorkspaceStatisticsForNamespace",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetWorkspaceStatisticsForNamespaceResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkspaceService"
]
}
},
"/apis/v1beta1/{namespace}/workspace_templates": {
"get": {
"operationId": "ListWorkspaceTemplates",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListWorkspaceTemplatesResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "order",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "labels",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "uid",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"WorkspaceTemplateService"
]
},
"post": {
"summary": "Creates a WorkspaceTemplate",
"operationId": "CreateWorkspaceTemplate",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkspaceTemplate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WorkspaceTemplate"
}
}
],
"tags": [
"WorkspaceTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workspace_templates/{uid}": {
"get": {
"summary": "Get a WorkspaceTemplate",
"operationId": "GetWorkspaceTemplate",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkspaceTemplate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "version",
"in": "query",
"required": false,
"type": "string",
"format": "int64"
}
],
"tags": [
"WorkspaceTemplateService"
]
},
"put": {
"summary": "Updates a WorkspaceTemplate",
"operationId": "UpdateWorkspaceTemplate",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkspaceTemplate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WorkspaceTemplate"
}
}
],
"tags": [
"WorkspaceTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workspace_templates/{uid}/archive": {
"put": {
"summary": "Archives a WorkspaceTemplate",
"operationId": "ArchiveWorkspaceTemplate",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkspaceTemplate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkspaceTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workspace_templates/{uid}/versions": {
"get": {
"operationId": "ListWorkspaceTemplateVersions",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListWorkspaceTemplateVersionsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkspaceTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workspace_templates/{uid}/workflow_template": {
"post": {
"summary": "Get the generated WorkflowTemplate for a WorkspaceTemplate",
"operationId": "GenerateWorkspaceTemplateWorkflowTemplate",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/WorkflowTemplate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WorkspaceTemplate"
}
}
],
"tags": [
"WorkspaceTemplateService"
]
}
},
"/apis/v1beta1/{namespace}/workspaces": {
"get": {
"operationId": "ListWorkspaces",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/ListWorkspaceResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "pageSize",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "page",
"in": "query",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "order",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "labels",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "phase",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"WorkspaceService"
]
},
"post": {
"operationId": "CreateWorkspace",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/Workspace"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateWorkspaceBody"
}
}
],
"tags": [
"WorkspaceService"
]
}
},
"/apis/v1beta1/{namespace}/workspaces/{uid}": {
"get": {
"operationId": "GetWorkspace",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/Workspace"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkspaceService"
]
},
"delete": {
"operationId": "DeleteWorkspace",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkspaceService"
]
},
"put": {
"operationId": "UpdateWorkspace",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateWorkspaceBody"
}
}
],
"tags": [
"WorkspaceService"
]
}
},
"/apis/v1beta1/{namespace}/workspaces/{uid}/containers/{containerName}/logs": {
"get": {
"operationId": "GetWorkspaceContainerLogs",
"responses": {
"200": {
"description": "A successful response.(streaming responses)",
"schema": {
"type": "object",
"properties": {
"result": {
"$ref": "#/definitions/LogStreamResponse"
},
"error": {
"$ref": "#/definitions/google.rpc.Status"
}
},
"title": "Stream result of LogStreamResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "containerName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "sinceTime",
"in": "query",
"required": false,
"type": "string",
"format": "int64"
}
],
"tags": [
"WorkspaceService"
]
}
},
"/apis/v1beta1/{namespace}/workspaces/{uid}/pause": {
"put": {
"operationId": "PauseWorkspace",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkspaceService"
]
}
},
"/apis/v1beta1/{namespace}/workspaces/{uid}/resume": {
"put": {
"operationId": "ResumeWorkspace",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/UpdateWorkspaceBody"
}
}
],
"tags": [
"WorkspaceService"
]
}
},
"/apis/v1beta1/{namespace}/workspaces/{uid}/retry": {
"put": {
"operationId": "RetryLastWorkspaceAction",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"WorkspaceService"
]
}
},
"/apis/v1beta1/{namespace}/workspaces/{uid}/status": {
"put": {
"operationId": "UpdateWorkspaceStatus",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WorkspaceStatus"
}
}
],
"tags": [
"WorkspaceService"
]
}
},
"/apis/v1beta1/{namespace}/{resource}/labels": {
"get": {
"operationId": "GetAvailableLabels",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetLabelsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resource",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "keyLike",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "skipKeys",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"LabelService"
]
}
},
"/apis/v1beta1/{namespace}/{resource}/{uid}/labels": {
"get": {
"operationId": "GetLabels",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetLabelsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resource",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"LabelService"
]
},
"post": {
"operationId": "AddLabels",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetLabelsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resource",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Labels"
}
}
],
"tags": [
"LabelService"
]
},
"put": {
"operationId": "ReplaceLabels",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetLabelsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resource",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Labels"
}
}
],
"tags": [
"LabelService"
]
}
},
"/apis/v1beta1/{namespace}/{resource}/{uid}/labels/{key}": {
"delete": {
"operationId": "DeleteLabel",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/GetLabelsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/google.rpc.Status"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "resource",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "uid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "key",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"LabelService"
]
}
}
},
"definitions": {
"AddSecretKeyValueResponse": {
"type": "object",
"properties": {
"inserted": {
"type": "boolean"
}
}
},
"AddWorkflowExecutionsMetricsRequest": {
"type": "object",
"properties": {
"namespace": {
"type": "string"
},
"uid": {
"type": "string"
},
"override": {
"type": "boolean"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/definitions/Metric"
}
}
}
},
"ArchiveWorkflowTemplateResponse": {
"type": "object",
"properties": {
"workflowTemplate": {
"$ref": "#/definitions/WorkflowTemplate"
}
}
},
"CreateWorkflowExecutionBody": {
"type": "object",
"properties": {
"workflowTemplateUid": {
"type": "string"
},
"workflowTemplateVersion": {
"type": "string",
"format": "int64"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/Parameter"
}
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/KeyValue"
}
}
}
},
"CreateWorkspaceBody": {
"type": "object",
"properties": {
"workspaceTemplateUid": {
"type": "string"
},
"workspaceTemplateVersion": {
"type": "string",
"format": "int64"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/Parameter"
}
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/KeyValue"
}
}
}
},
"CronWorkflow": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"uid": {
"type": "string"
},
"manifest": {
"type": "string"
},
"workflowExecution": {
"$ref": "#/definitions/WorkflowExecution"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/KeyValue"
}
},
"namespace": {
"type": "string"
}
}
},
"CronWorkflowStatisticsReport": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
}
}
},
"DeleteSecretKeyResponse": {
"type": "object",
"properties": {
"deleted": {
"type": "boolean"
}
}
},
"DeleteSecretResponse": {
"type": "object",
"properties": {
"deleted": {
"type": "boolean"
}
}
},
"File": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"name": {
"type": "string"
},
"extension": {
"type": "string"
},
"size": {
"type": "string",
"format": "int64"
},
"contentType": {
"type": "string"
},
"lastModified": {
"type": "string"
},
"directory": {
"type": "boolean"
}
}
},
"GetAccessTokenRequest": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"token": {
"type": "string"
}
}
},
"GetAccessTokenResponse": {
"type": "object",
"properties": {
"domain": {
"type": "string"
},
"accessToken": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"GetConfigResponse": {
"type": "object",
"properties": {
"apiUrl": {
"type": "string"
},
"domain": {
"type": "string"
},
"fqdn": {
"type": "string"
},
"nodePool": {
"$ref": "#/definitions/NodePool"
}
}
},
"GetLabelsResponse": {
"type": "object",
"properties": {
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/KeyValue"
}
}
}
},
"GetNamespaceConfigResponse": {
"type": "object",
"properties": {
"bucket": {
"type": "string"
}
}
},
"GetPresignedUrlResponse": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"size": {
"type": "string",
"format": "int64"
}
}
},
"GetWorkflowExecutionMetricsResponse": {
"type": "object",
"properties": {
"metrics": {
"type": "array",
"items": {
"$ref": "#/definitions/Metric"
}
}
}
},
"GetWorkflowExecutionStatisticsForNamespaceResponse": {
"type": "object",
"properties": {
"stats": {
"$ref": "#/definitions/WorkflowExecutionStatisticReport"
}
}
},
"GetWorkspaceStatisticsForNamespaceResponse": {
"type": "object",
"properties": {
"stats": {
"$ref": "#/definitions/WorkspaceStatisticReport"
}
}
},
"HasServiceResponse": {
"type": "object",
"properties": {
"hasService": {
"type": "boolean"
}
}
},
"IsAuthorized": {
"type": "object",
"properties": {
"namespace": {
"type": "string"
},
"verb": {
"type": "string"
},
"group": {
"type": "string"
},
"resource": {
"type": "string"
},
"resourceName": {
"type": "string"
}
}
},
"IsAuthorizedResponse": {
"type": "object",
"properties": {
"authorized": {
"type": "boolean"
}
}
},
"IsValidTokenRequest": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"token": {
"type": "string"
}
}
},
"IsValidTokenResponse": {
"type": "object",
"properties": {
"domain": {
"type": "string"
},
"token": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"KeyValue": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"Labels": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/KeyValue"
}
}
}
},
"ListCronWorkflowsResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"cronWorkflows": {
"type": "array",
"items": {
"$ref": "#/definitions/CronWorkflow"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
}
}
},
"ListFilesResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
},
"files": {
"type": "array",
"items": {
"$ref": "#/definitions/File"
}
},
"parentPath": {
"type": "string"
}
}
},
"ListNamespacesResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"namespaces": {
"type": "array",
"items": {
"$ref": "#/definitions/Namespace"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
}
}
},
"ListSecretsResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"secrets": {
"type": "array",
"items": {
"$ref": "#/definitions/Secret"
}
}
}
},
"ListServicesResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"services": {
"type": "array",
"items": {
"$ref": "#/definitions/Service"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
}
}
},
"ListWorkflowExecutionsFieldResponse": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ListWorkflowExecutionsResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"workflowExecutions": {
"type": "array",
"items": {
"$ref": "#/definitions/WorkflowExecution"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"totalAvailableCount": {
"type": "integer",
"format": "int32"
}
}
},
"ListWorkflowTemplateVersionsResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"workflowTemplates": {
"type": "array",
"items": {
"$ref": "#/definitions/WorkflowTemplate"
}
}
}
},
"ListWorkflowTemplatesFieldResponse": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ListWorkflowTemplatesResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"workflowTemplates": {
"type": "array",
"items": {
"$ref": "#/definitions/WorkflowTemplate"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"totalAvailableCount": {
"type": "integer",
"format": "int32"
}
}
},
"ListWorkspaceResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"workspaces": {
"type": "array",
"items": {
"$ref": "#/definitions/Workspace"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"totalAvailableCount": {
"type": "integer",
"format": "int32"
}
}
},
"ListWorkspaceTemplateVersionsResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"workspaceTemplates": {
"type": "array",
"items": {
"$ref": "#/definitions/WorkspaceTemplate"
}
}
}
},
"ListWorkspaceTemplatesFieldResponse": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ListWorkspaceTemplatesResponse": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int32"
},
"workspaceTemplates": {
"type": "array",
"items": {
"$ref": "#/definitions/WorkspaceTemplate"
}
},
"page": {
"type": "integer",
"format": "int32"
},
"pages": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
}
}
},
"ListWorkspacesFieldResponse": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"LogEntry": {
"type": "object",
"properties": {
"timestamp": {
"type": "string"
},
"content": {
"type": "string"
}
}
},
"LogStreamResponse": {
"type": "object",
"properties": {
"logEntries": {
"type": "array",
"items": {
"$ref": "#/definitions/LogEntry"
}
}
}
},
"MachineType": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"Metric": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "number",
"format": "double"
},
"format": {
"type": "string"
}
}
},
"Namespace": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"NodePool": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"$ref": "#/definitions/NodePoolOption"
}
}
}
},
"NodePoolOption": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"Parameter": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type": {
"type": "string"
},
"displayName": {
"type": "string"
},
"hint": {
"type": "string"
},
"required": {
"type": "boolean"
},
"visibility": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"$ref": "#/definitions/ParameterOption"
}
}
}
},
"ParameterOption": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"Secret": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"data": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"SecretExistsResponse": {
"type": "object",
"properties": {
"exists": {
"type": "boolean"
}
}
},
"Service": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"Statistics": {
"type": "object",
"properties": {
"workflowStatus": {
"type": "string"
},
"workflowTemplateId": {
"type": "string",
"format": "int64"
}
}
},
"UpdateSecretKeyValueResponse": {
"type": "object",
"properties": {
"updated": {
"type": "boolean"
}
}
},
"UpdateWorkflowExecutionsMetricsRequest": {
"type": "object",
"properties": {
"namespace": {
"type": "string"
},
"uid": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/definitions/Metric"
}
}
}
},
"UpdateWorkspaceBody": {
"type": "object",
"properties": {
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/Parameter"
}
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/KeyValue"
}
}
}
},
"WorkflowExecution": {
"type": "object",
"properties": {
"createdAt": {
"type": "string"
},
"uid": {
"type": "string"
},
"name": {
"type": "string"
},
"phase": {
"type": "string"
},
"startedAt": {
"type": "string"
},
"finishedAt": {
"type": "string"
},
"manifest": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/Parameter"
}
},
"workflowTemplate": {
"$ref": "#/definitions/WorkflowTemplate"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/KeyValue"
}
},
"metadata": {
"$ref": "#/definitions/WorkflowExecutionMetadata"
},
"metrics": {
"type": "array",
"items": {
"$ref": "#/definitions/Metric"
}
}
}
},
"WorkflowExecutionMetadata": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
},
"WorkflowExecutionStatisticReport": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"lastExecuted": {
"type": "string"
},
"running": {
"type": "integer",
"format": "int32"
},
"completed": {
"type": "integer",
"format": "int32"
},
"failed": {
"type": "integer",
"format": "int32"
},
"terminated": {
"type": "integer",
"format": "int32"
}
}
},
"WorkflowExecutionStatus": {
"type": "object",
"properties": {
"phase": {
"type": "string"
}
}
},
"WorkflowExecutionsMetricsResponse": {
"type": "object",
"properties": {
"metrics": {
"type": "array",
"items": {
"$ref": "#/definitions/Metric"
}
}
}
},
"WorkflowTemplate": {
"type": "object",
"properties": {
"createdAt": {
"type": "string"
},
"modifiedAt": {
"type": "string"
},
"uid": {
"type": "string"
},
"name": {
"type": "string"
},
"version": {
"type": "string",
"format": "int64"
},
"versions": {
"type": "string",
"format": "int64"
},
"manifest": {
"type": "string"
},
"isLatest": {
"type": "boolean"
},
"isArchived": {
"type": "boolean"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/KeyValue"
}
},
"stats": {
"$ref": "#/definitions/WorkflowExecutionStatisticReport"
},
"cronStats": {
"$ref": "#/definitions/CronWorkflowStatisticsReport"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/Parameter"
}
},
"description": {
"type": "string"
}
}
},
"Workspace": {
"type": "object",
"properties": {
"uid": {
"type": "string"
},
"name": {
"type": "string"
},
"version": {
"type": "string",
"format": "int64"
},
"createdAt": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/Parameter"
}
},
"workspaceTemplate": {
"$ref": "#/definitions/WorkspaceTemplate"
},
"status": {
"$ref": "#/definitions/WorkspaceStatus"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/KeyValue"
}
},
"url": {
"type": "string"
},
"templateParameters": {
"type": "array",
"items": {
"$ref": "#/definitions/Parameter"
}
},
"workspaceComponents": {
"type": "array",
"items": {
"$ref": "#/definitions/WorkspaceComponent"
}
},
"machineType": {
"$ref": "#/definitions/MachineType"
}
}
},
"WorkspaceComponent": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"url": {
"type": "string"
}
}
},
"WorkspaceStatisticReport": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32"
},
"lastCreated": {
"type": "string"
},
"launching": {
"type": "integer",
"format": "int32"
},
"running": {
"type": "integer",
"format": "int32"
},
"updating": {
"type": "integer",
"format": "int32"
},
"pausing": {
"type": "integer",
"format": "int32"
},
"paused": {
"type": "integer",
"format": "int32"
},
"terminating": {
"type": "integer",
"format": "int32"
},
"terminated": {
"type": "integer",
"format": "int32"
},
"failedToPause": {
"type": "integer",
"format": "int32"
},
"failedToResume": {
"type": "integer",
"format": "int32"
},
"failedToTerminate": {
"type": "integer",
"format": "int32"
},
"failedToLaunch": {
"type": "integer",
"format": "int32"
},
"failedToUpdate": {
"type": "integer",
"format": "int32"
},
"failed": {
"type": "integer",
"format": "int32"
}
}
},
"WorkspaceStatus": {
"type": "object",
"properties": {
"phase": {
"type": "string"
},
"startedAt": {
"type": "string"
},
"pausedAt": {
"type": "string"
},
"terminatedAt": {
"type": "string"
}
}
},
"WorkspaceTemplate": {
"type": "object",
"properties": {
"uid": {
"type": "string"
},
"name": {
"type": "string"
},
"version": {
"type": "string",
"format": "int64"
},
"manifest": {
"type": "string"
},
"isLatest": {
"type": "boolean"
},
"createdAt": {
"type": "string"
},
"workflowTemplate": {
"$ref": "#/definitions/WorkflowTemplate"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/definitions/KeyValue"
}
},
"isArchived": {
"type": "boolean"
},
"description": {
"type": "string"
}
}
},
"google.protobuf.Any": {
"type": "object",
"properties": {
"typeUrl": {
"type": "string"
},
"value": {
"type": "string",
"format": "byte"
}
}
},
"google.rpc.Status": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"$ref": "#/definitions/google.protobuf.Any"
}
}
}
}
},
"securityDefinitions": {
"Bearer": {
"type": "apiKey",
"description": "Authentication token, prefixed by Bearer",
"name": "authorization",
"in": "header"
}
},
"security": [
{
"Bearer": []
}
]
}