{
"openapi": "3.1.0",
"info": {
"title": "FastAPI",
"version": "0.1.0"
},
"paths": {
"/api/configs/service": {
"get": {
"tags": [
"Config API"
],
"summary": "Read Service Configs",
"description": "Read all the service configurations",
"operationId": "read_service_configs_api_configs_service_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Service Configs",
"description": "Put service configurations",
"operationId": "put_service_configs_api_configs_service_put",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutServiceRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Response Put Service Configs Api Configs Service Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Config API"
],
"summary": "Patch Service Configs",
"description": "Patch service configurations",
"operationId": "patch_service_configs_api_configs_service_patch",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchConfigRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Response Patch Service Configs Api Configs Service Patch"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/workflow": {
"get": {
"tags": [
"Config API"
],
"summary": "Read Workflow Configs",
"description": "Read all the workflow configurations",
"operationId": "read_workflow_configs_api_configs_workflow_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Workflow Configs",
"description": "Put workflow configurations",
"operationId": "put_workflow_configs_api_configs_workflow_put",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutWorkflowRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Response Put Workflow Configs Api Configs Workflow Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Config API"
],
"summary": "Patch Workflow Configs",
"description": "Patch workflow configurations",
"operationId": "patch_workflow_configs_api_configs_workflow_patch",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchConfigRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Response Patch Workflow Configs Api Configs Workflow Patch"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/dataset": {
"get": {
"tags": [
"Config API"
],
"summary": "Read Dataset Configs",
"description": "Read all the dataset configurations",
"operationId": "read_dataset_configs_api_configs_dataset_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Dataset Configs",
"description": "Put dataset configurations",
"operationId": "put_dataset_configs_api_configs_dataset_put",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutDatasetRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Response Put Dataset Configs Api Configs Dataset Put"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Config API"
],
"summary": "Patch Dataset Configs",
"description": "Patch dataset configurations",
"operationId": "patch_dataset_configs_api_configs_dataset_patch",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchConfigRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Response Patch Dataset Configs Api Configs Dataset Patch"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/dataset/{name}": {
"delete": {
"tags": [
"Config API"
],
"summary": "Delete Dataset",
"description": "Delete dataset configuration for a specific bucket",
"operationId": "delete_dataset_api_configs_dataset__name__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Config API"
],
"summary": "Patch Dataset",
"description": "Patch dataset configuration for a specific bucket",
"operationId": "patch_dataset_api_configs_dataset__name__patch",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchDatasetRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Response Patch Dataset Api Configs Dataset Name Patch"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/backend": {
"get": {
"tags": [
"Config API"
],
"summary": "List Backends",
"description": "List all backends.",
"operationId": "list_backends_api_configs_backend_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/configs/backend/{name}": {
"get": {
"tags": [
"Config API"
],
"summary": "Get Backend",
"description": "Get info for a specific backend.",
"operationId": "get_backend_api_configs_backend__name__get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Config API"
],
"summary": "Update Backend",
"description": "Override the config for a specific backend.",
"operationId": "update_backend_api_configs_backend__name__post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostBackendRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Config API"
],
"summary": "Delete Backend",
"description": "Remove a backend.",
"operationId": "delete_backend_api_configs_backend__name__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteBackendRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/pool": {
"get": {
"tags": [
"Config API"
],
"summary": "List Pools",
"description": "List all Pools",
"operationId": "list_pools_api_configs_pool_get",
"parameters": [
{
"required": false,
"schema": {
"type": "boolean",
"title": "Verbose",
"default": false
},
"name": "verbose",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Backend"
},
"name": "backend",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Pools",
"description": "Put Pool configurations",
"operationId": "put_pools_api_configs_pool_put",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutPoolsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/pool/{name}": {
"get": {
"tags": [
"Config API"
],
"summary": "Read Pool",
"description": "Read Pool configuration\n\nReturn type Any to prevent unwanted artifacts between Pool and PoolEditable outputs\nShould return Pool or PoolEditable objects",
"operationId": "read_pool_api_configs_pool__name__get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Verbose",
"default": false
},
"name": "verbose",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Pool",
"description": "Put Pool configurations",
"operationId": "put_pool_api_configs_pool__name__put",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutPoolRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Config API"
],
"summary": "Delete Pool",
"description": "Delete Pool configurations",
"operationId": "delete_pool_api_configs_pool__name__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Config API"
],
"summary": "Patch Pool",
"description": "Patch Pool configurations",
"operationId": "patch_pool_api_configs_pool__name__patch",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchPoolRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/pool/{name}/rename": {
"put": {
"tags": [
"Config API"
],
"summary": "Rename Pool",
"description": "Rename Pool",
"operationId": "rename_pool_api_configs_pool__name__rename_put",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RenamePoolRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/pool/{name}/platform": {
"get": {
"tags": [
"Config API"
],
"summary": "List Platforms In Pool",
"description": "List all Platforms\n\nReturn type Any to prevent unwanted artifacts between verbose and editable outputs\nShould return Dict[str, Platform] or Dict[str, PlatformEditable] objects",
"operationId": "list_platforms_in_pool_api_configs_pool__name__platform_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Verbose",
"default": false
},
"name": "verbose",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/pool/{name}/platform/{platform_name}": {
"get": {
"tags": [
"Config API"
],
"summary": "Read Platform In Pool",
"description": "Read Platform\n\nReturn type Any to prevent unwanted artifacts between verbose and editable outputs\nShould return Platform or PlatformEditable objects",
"operationId": "read_platform_in_pool_api_configs_pool__name__platform__platform_name__get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Platform Name"
},
"name": "platform_name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Verbose",
"default": false
},
"name": "verbose",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Platform In Pool",
"description": "Put Platform configurations",
"operationId": "put_platform_in_pool_api_configs_pool__name__platform__platform_name__put",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Platform Name"
},
"name": "platform_name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutPoolPlatformRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/pool/{name}/platform/{platform_name}/rename": {
"put": {
"tags": [
"Config API"
],
"summary": "Rename Platform In Pool",
"description": "Rename Platform",
"operationId": "rename_platform_in_pool_api_configs_pool__name__platform__platform_name__rename_put",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Platform Name"
},
"name": "platform_name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RenamePoolPlatformRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/pod_template": {
"get": {
"tags": [
"Config API"
],
"summary": "List Pod Templates",
"description": "List all Pod Template configurations",
"operationId": "list_pod_templates_api_configs_pod_template_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Pod Templates",
"description": "Set Dict of Pod Templates configurations",
"operationId": "put_pod_templates_api_configs_pod_template_put",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutPodTemplatesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/pod_template/{name}": {
"get": {
"tags": [
"Config API"
],
"summary": "Read Pod Template",
"description": "Read Pod Template configurations",
"operationId": "read_pod_template_api_configs_pod_template__name__get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Pod Template",
"description": "Put Pod Template configurations",
"operationId": "put_pod_template_api_configs_pod_template__name__put",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutPodTemplateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Config API"
],
"summary": "Delete Pod Template",
"description": "Delete Pod Template configurations",
"operationId": "delete_pod_template_api_configs_pod_template__name__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/resource_validation": {
"get": {
"tags": [
"Config API"
],
"summary": "List Resource Validations",
"description": "List all Resource Validation configurations",
"operationId": "list_resource_validations_api_configs_resource_validation_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Resource Validations",
"description": "Put Resource Validation configurations",
"operationId": "put_resource_validations_api_configs_resource_validation_put",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutResourceValidationsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/resource_validation/{name}": {
"get": {
"tags": [
"Config API"
],
"summary": "Read Resource Validation",
"description": "Read Resource Validation configurations",
"operationId": "read_resource_validation_api_configs_resource_validation__name__get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Resource Validation",
"description": "Put Resource Validation configurations",
"operationId": "put_resource_validation_api_configs_resource_validation__name__put",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutResourceValidationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Config API"
],
"summary": "Delete Resource Validation",
"description": "Delete Resource Validation configurations",
"operationId": "delete_resource_validation_api_configs_resource_validation__name__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/role": {
"get": {
"tags": [
"Config API"
],
"summary": "List Roles",
"description": "List all Roles",
"operationId": "list_roles_api_configs_role_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Roles",
"description": "Put Roles",
"operationId": "put_roles_api_configs_role_put",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutRolesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/role/{name}": {
"get": {
"tags": [
"Config API"
],
"summary": "Read Role",
"description": "Read Role",
"operationId": "read_role_api_configs_role__name__get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Role",
"description": "Patch Role configurations",
"operationId": "put_role_api_configs_role__name__put",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutRoleRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Config API"
],
"summary": "Delete Role",
"description": "Delete Role",
"operationId": "delete_role_api_configs_role__name__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/backend_test": {
"get": {
"tags": [
"Config API"
],
"summary": "List Backend Tests",
"description": "List all backend test configurations",
"operationId": "list_backend_tests_api_configs_backend_test_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Backend Tests",
"description": "Put backend test configurations",
"operationId": "put_backend_tests_api_configs_backend_test_put",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutBackendTestsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/backend_test/{name}": {
"get": {
"tags": [
"Config API"
],
"summary": "Read Backend Test",
"description": "Read backend test configuration",
"operationId": "read_backend_test_api_configs_backend_test__name__get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"put": {
"tags": [
"Config API"
],
"summary": "Put Backend Test",
"description": "Put backend test configuration",
"operationId": "put_backend_test_api_configs_backend_test__name__put",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PutBackendTestRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Config API"
],
"summary": "Delete Backend Test",
"description": "Delete test configuration",
"operationId": "delete_backend_test_api_configs_backend_test__name__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConfigsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Config API"
],
"summary": "Patch Backend Test",
"description": "Patch backend test configuration",
"operationId": "patch_backend_test_api_configs_backend_test__name__patch",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchBackendTestRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/history": {
"get": {
"tags": [
"Config API"
],
"summary": "Get Configs History",
"description": "List history of all configs",
"operationId": "get_configs_history_api_configs_history_get",
"parameters": [
{
"description": "Number of records to skip",
"required": false,
"schema": {
"type": "integer",
"minimum": 0.0,
"title": "Offset",
"description": "Number of records to skip",
"default": 0
},
"name": "offset",
"in": "query"
},
{
"description": "Maximum number of records to return",
"required": false,
"schema": {
"type": "integer",
"maximum": 1000.0,
"exclusiveMinimum": 0.0,
"title": "Limit",
"description": "Maximum number of records to return",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"description": "Sort order by creation time",
"required": false,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ListOrder"
}
],
"description": "Sort order by creation time",
"default": "ASC"
},
"name": "order",
"in": "query"
},
{
"description": "Filter by config types",
"required": false,
"schema": {
"items": {
"$ref": "#/components/schemas/src__lib__utils__config_history__ConfigHistoryType"
},
"type": "array",
"description": "Filter by config types"
},
"name": "config_types",
"in": "query"
},
{
"description": "Filter by config name",
"required": false,
"schema": {
"type": "string",
"title": "Name",
"description": "Filter by config name"
},
"name": "name",
"in": "query"
},
{
"description": "Filter by revision",
"required": false,
"schema": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Revision",
"description": "Filter by revision"
},
"name": "revision",
"in": "query"
},
{
"description": "Filter by tags",
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"description": "Filter by tags"
},
"name": "tags",
"in": "query"
},
{
"description": "Filter by creation time before",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"title": "Created Before",
"description": "Filter by creation time before"
},
"name": "created_before",
"in": "query"
},
{
"description": "Filter by creation time after",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"title": "Created After",
"description": "Filter by creation time after"
},
"name": "created_after",
"in": "query"
},
{
"description": "Get config state at specific timestamp",
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"title": "At Timestamp",
"description": "Get config state at specific timestamp"
},
"name": "at_timestamp",
"in": "query"
},
{
"description": "Whether to omit data from the response",
"required": false,
"schema": {
"type": "boolean",
"title": "Omit Data",
"description": "Whether to omit data from the response",
"default": false
},
"name": "omit_data",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetConfigsHistoryResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/history/rollback": {
"post": {
"tags": [
"Config API"
],
"summary": "Rollback Config",
"description": "Roll back a config to a particular revision.",
"operationId": "rollback_config_api_configs_history_rollback_post",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RollbackConfigRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/history/{config_type}/revision/{revision}": {
"delete": {
"tags": [
"Config API"
],
"summary": "Delete Config History Revision",
"description": "Delete a specific config history revision. This performs a soft delete of the revision.\n\nArgs:\n config_type: Type of config to delete\n revision: Revision number to delete (must be greater than 0)\n username: Username of the person performing the delete\n\nRaises:\n OSMOUserError: If the revision doesn't exist or is the current revision",
"operationId": "delete_config_history_revision_api_configs_history__config_type__revision__revision__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Config Type"
},
"name": "config_type",
"in": "path"
},
{
"required": true,
"schema": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Revision"
},
"name": "revision",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/history/{config_type}/revision/{revision}/tags": {
"post": {
"tags": [
"Config API"
],
"summary": "Update Config History Tags",
"description": "Update tags for a specific config history revision.\n\nArgs:\n config_type: Type of config to update\n revision: Revision number to update (must be greater than 0)\n request: Request containing tags to add and delete\n username: Username of the person performing the update\n\nRaises:\n OSMOUserError: If the revision doesn't exist or is invalid",
"operationId": "update_config_history_tags_api_configs_history__config_type__revision__revision__tags_post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Config Type"
},
"name": "config_type",
"in": "path"
},
{
"required": true,
"schema": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Revision"
},
"name": "revision",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateConfigTagsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/configs/diff": {
"get": {
"tags": [
"Config API"
],
"summary": "Get Config Diff",
"description": "Returns two config revisions, similar to\nGET /api/configs/history/{config_type}/revision/{revision}, but with obfuscated secret strings\nthat say if a secret string is changed. Intended for use with the `diff` command.\n\nArgs:\n request: Request containing config type and revisions to compare\n\nReturns:\n ConfigDiffResponse containing the two revisions\n\nRaises:\n OSMOUserError: If either revision doesn't exist or is invalid",
"operationId": "get_config_diff_api_configs_diff_get",
"parameters": [
{
"required": true,
"schema": {
"$ref": "#/components/schemas/src__utils__connectors__postgres__ConfigHistoryType"
},
"name": "config_type",
"in": "query"
},
{
"description": "First revision to compare",
"required": true,
"schema": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "First Revision",
"description": "First revision to compare"
},
"name": "first_revision",
"in": "query"
},
{
"description": "Second revision to compare",
"required": true,
"schema": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Second Revision",
"description": "Second revision to compare"
},
"name": "second_revision",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/auth/jwt/refresh_token": {
"get": {
"tags": [
"Auth API"
],
"summary": "Get New Jwt Token",
"description": "API to fetch for a new access token using a refresh token.",
"operationId": "get_new_jwt_token_api_auth_jwt_refresh_token_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Refresh Token"
},
"name": "refresh_token",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Workflow Id"
},
"name": "workflow_id",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Group Name"
},
"name": "group_name",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Task Name"
},
"name": "task_name",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Retry Id",
"default": 0
},
"name": "retry_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/auth/refresh_token": {
"get": {
"tags": [
"Auth API"
],
"summary": "Get New Jwt Token",
"description": "API to fetch for a new access token using a refresh token.",
"operationId": "get_new_jwt_token_api_auth_refresh_token_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Refresh Token"
},
"name": "refresh_token",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Workflow Id"
},
"name": "workflow_id",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Group Name"
},
"name": "group_name",
"in": "query"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Task Name"
},
"name": "task_name",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Retry Id",
"default": 0
},
"name": "retry_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/auth/jwt/access_token": {
"get": {
"tags": [
"Auth API"
],
"summary": "Get Jwt Token From Access Token",
"description": "API to create a new jwt token from an access token.",
"operationId": "get_jwt_token_from_access_token_api_auth_jwt_access_token_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Access Token"
},
"name": "access_token",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/auth/access_token": {
"get": {
"tags": [
"Auth API"
],
"summary": "Get Access Token Info",
"description": "API to get the info for an access token.",
"operationId": "get_access_token_info_api_auth_access_token_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Access Token"
},
"name": "access_token",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessToken"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/auth/access_token/user/{token_name}": {
"post": {
"tags": [
"Auth API"
],
"summary": "Create Access Token",
"description": "API to create a new access token.",
"operationId": "create_access_token_api_auth_access_token_user__token_name__post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Token Name"
},
"name": "token_name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Expires At"
},
"name": "expires_at",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Description",
"default": ""
},
"name": "description",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Auth API"
],
"summary": "Delete Access Token",
"description": "API to delete an access token.",
"operationId": "delete_access_token_api_auth_access_token_user__token_name__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Token Name"
},
"name": "token_name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/auth/access_token/service/{token_name}": {
"post": {
"tags": [
"Auth API"
],
"summary": "Create Service Access Token",
"description": "API to create a new service access token.",
"operationId": "create_service_access_token_api_auth_access_token_service__token_name__post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Token Name"
},
"name": "token_name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Expires At"
},
"name": "expires_at",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Roles",
"default": []
},
"name": "roles",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Description",
"default": ""
},
"name": "description",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Auth API"
],
"summary": "Delete Service Access Token",
"description": "API to delete a service access token.",
"operationId": "delete_service_access_token_api_auth_access_token_service__token_name__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Token Name"
},
"name": "token_name",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/auth/access_token/user": {
"get": {
"tags": [
"Auth API"
],
"summary": "List Access Tokens",
"description": "API to list all access tokens for a user.",
"operationId": "list_access_tokens_api_auth_access_token_user_get",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AccessToken"
},
"type": "array",
"title": "Response List Access Tokens Api Auth Access Token User Get"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/auth/access_token/service": {
"get": {
"tags": [
"Auth API"
],
"summary": "List Service Access Tokens",
"description": "API to list all service access tokens.",
"operationId": "list_service_access_tokens_api_auth_access_token_service_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/AccessToken"
},
"type": "array",
"title": "Response List Service Access Tokens Api Auth Access Token Service Get"
}
}
}
}
}
}
},
"/api/app": {
"get": {
"tags": [
"Workflow App API"
],
"summary": "List Apps",
"operationId": "list_apps_api_app_get",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Users"
},
"name": "users",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "All Users",
"default": false
},
"name": "all_users",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Offset",
"default": 0
},
"name": "offset",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Limit",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ListOrder"
}
],
"default": "ASC"
},
"name": "order",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/app/user/{name}": {
"get": {
"tags": [
"Workflow App API"
],
"summary": "Get App",
"operationId": "get_app_api_app_user__name__get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Version"
},
"name": "version",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Limit",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ListOrder"
}
],
"default": "ASC"
},
"name": "order",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Workflow App API"
],
"summary": "Create App",
"operationId": "create_app_api_app_user__name__post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Description"
},
"name": "description",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "App Content"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Workflow App API"
],
"summary": "Delete App",
"operationId": "delete_app_api_app_user__name__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Version"
},
"name": "version",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "All Versions",
"default": false
},
"name": "all_versions",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": "object",
"title": "Response Delete App Api App User Name Delete"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"patch": {
"tags": [
"Workflow App API"
],
"summary": "Update App",
"operationId": "update_app_api_app_user__name__patch",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "App Content"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/app/user/{name}/spec": {
"get": {
"tags": [
"Workflow App API"
],
"summary": "Get App Content",
"operationId": "get_app_content_api_app_user__name__spec_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Version"
},
"name": "version",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/app/user/{name}/rename": {
"post": {
"tags": [
"Workflow App API"
],
"summary": "Rename App",
"operationId": "rename_app_api_app_user__name__rename_post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "New Name"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string",
"title": "Response Rename App Api App User Name Rename Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow/{name}/cancel": {
"post": {
"tags": [
"Workflow API"
],
"summary": "Cancel Workflow",
"description": "Cancels the workflow.",
"operationId": "cancel_workflow_api_workflow__name__cancel_post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Message"
},
"name": "message",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Force",
"default": false
},
"name": "force",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-Roles"
},
"name": "x-osmo-roles",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow": {
"get": {
"tags": [
"Workflow API"
],
"summary": "List Workflow",
"operationId": "list_workflow_api_workflow_get",
"parameters": [
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Users"
},
"name": "users",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"$ref": "#/components/schemas/WorkflowStatus"
},
"type": "array"
},
"name": "statuses",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Offset",
"default": 0
},
"name": "offset",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Limit",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ListOrder"
}
],
"default": "ASC"
},
"name": "order",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "All Users",
"default": false
},
"name": "all_users",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Pools"
},
"name": "pools",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "All Pools",
"default": false
},
"name": "all_pools",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"title": "Submitted Before"
},
"name": "submitted_before",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"title": "Submitted After"
},
"name": "submitted_after",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"name": "tags",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "App"
},
"name": "app",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"$ref": "#/components/schemas/WorkflowPriority"
},
"type": "array"
},
"name": "priority",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow/{name}/task/{task_name}": {
"get": {
"tags": [
"Workflow API"
],
"summary": "Get Workflow Task",
"description": "Returns the task (with the latest retry_id) with the given name in the workflow.",
"operationId": "get_workflow_task_api_workflow__name__task__task_name__get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Task Name"
},
"name": "task_name",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/task": {
"get": {
"tags": [
"Workflow API"
],
"summary": "List Task",
"operationId": "list_task_api_task_get",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "Workflow Id"
},
"name": "workflow_id",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"$ref": "#/components/schemas/TaskGroupStatus"
},
"type": "array"
},
"name": "statuses",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Users"
},
"name": "users",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "All Users",
"default": false
},
"name": "all_users",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Pools"
},
"name": "pools",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "All Pools",
"default": false
},
"name": "all_pools",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Nodes"
},
"name": "nodes",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"title": "Started After"
},
"name": "started_after",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"title": "Started Before"
},
"name": "started_before",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Offset",
"default": 0
},
"name": "offset",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Limit",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ListOrder"
}
],
"default": "ASC"
},
"name": "order",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Summary",
"default": false
},
"name": "summary",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Aggregate By Workflow",
"default": false
},
"name": "aggregate_by_workflow",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"$ref": "#/components/schemas/WorkflowPriority"
},
"type": "array"
},
"name": "priority",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow/{name}": {
"get": {
"tags": [
"Workflow API"
],
"summary": "Get Workflow",
"description": "Returns the workflow with the given name in the database.",
"operationId": "get_workflow_api_workflow__name__get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Skip Groups",
"default": false
},
"name": "skip_groups",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Verbose",
"default": false
},
"name": "verbose",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow/{name}/logs": {
"get": {
"tags": [
"Workflow API"
],
"summary": "Get Workflow Logs",
"description": "Returns the workflow logs.",
"operationId": "get_workflow_logs_api_workflow__name__logs_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Last N Lines"
},
"name": "last_n_lines",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Task Name"
},
"name": "task_name",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Retry Id"
},
"name": "retry_id",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Query"
},
"name": "query",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow/{name}/events": {
"get": {
"tags": [
"Workflow API"
],
"summary": "Get Workflow Pod Conditions",
"description": "Returns the workflow pod conditions.",
"operationId": "get_workflow_pod_conditions_api_workflow__name__events_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Task Name"
},
"name": "task_name",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Retry Id"
},
"name": "retry_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow/{name}/error_logs": {
"get": {
"tags": [
"Workflow API"
],
"summary": "Get Workflow Error Logs",
"description": "Returns the workflow error logs.",
"operationId": "get_workflow_error_logs_api_workflow__name__error_logs_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Last N Lines"
},
"name": "last_n_lines",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Task Name"
},
"name": "task_name",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Retry Id"
},
"name": "retry_id",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Query"
},
"name": "query",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow/{name}/spec": {
"get": {
"tags": [
"Workflow API"
],
"summary": "Get Workflow Spec",
"description": "Returns the workflow spec.",
"operationId": "get_workflow_spec_api_workflow__name__spec_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Use Template",
"default": false
},
"name": "use_template",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow/{name}/tag": {
"post": {
"tags": [
"Workflow API"
],
"summary": "Tag Workflow",
"description": "Returns the workflow spec.",
"operationId": "tag_workflow_api_workflow__name__tag_post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Add"
},
"name": "add",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Remove"
},
"name": "remove",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow/{name}/exec/group/{group_name}": {
"post": {
"tags": [
"Workflow API"
],
"summary": "Exec Into Group",
"description": "Send command to all tasks in a group.",
"operationId": "exec_into_group_api_workflow__name__exec_group__group_name__post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Group Name"
},
"name": "group_name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Entry Command"
},
"name": "entry_command",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-Roles"
},
"name": "x-osmo-roles",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/RouterResponse"
},
"type": "object",
"title": "Response Exec Into Group Api Workflow Name Exec Group Group Name Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow/{name}/exec/task/{task_name}": {
"post": {
"tags": [
"Workflow API"
],
"summary": "Exec Into Task",
"description": "Exec into a task container.",
"operationId": "exec_into_task_api_workflow__name__exec_task__task_name__post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Task Name"
},
"name": "task_name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Entry Command"
},
"name": "entry_command",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-Roles"
},
"name": "x-osmo-roles",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouterResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow/{name}/portforward/{task_name}": {
"post": {
"tags": [
"Workflow API"
],
"summary": "Port Forward Task",
"description": "Portforward into a task container.",
"operationId": "port_forward_task_api_workflow__name__portforward__task_name__post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Task Name"
},
"name": "task_name",
"in": "path"
},
{
"required": false,
"schema": {
"items": {
"type": "integer"
},
"type": "array",
"title": "Task Ports"
},
"name": "task_ports",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Use Udp",
"default": false
},
"name": "use_udp",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-Roles"
},
"name": "x-osmo-roles",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/RouterResponse"
},
"type": "array"
},
{
"$ref": "#/components/schemas/RouterResponse"
}
],
"title": "Response Port Forward Task Api Workflow Name Portforward Task Name Post"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow/{name}/webserver/{task_name}": {
"post": {
"tags": [
"Workflow API"
],
"summary": "Port Forward Webserver",
"description": "Hold a webserver connection to a task container.",
"operationId": "port_forward_webserver_api_workflow__name__webserver__task_name__post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Task Name"
},
"name": "task_name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "integer",
"title": "Task Port"
},
"name": "task_port",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-Roles"
},
"name": "x-osmo-roles",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouterResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/workflow/{name}/rsync/task/{task_name}": {
"post": {
"tags": [
"Workflow API"
],
"summary": "Rsync Task",
"description": "Rsync into a task container.",
"operationId": "rsync_task_api_workflow__name__rsync_task__task_name__post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Task Name"
},
"name": "task_name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-Roles"
},
"name": "x-osmo-roles",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouterResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/credentials": {
"get": {
"tags": [
"Credentials API"
],
"summary": "Get User Credential",
"description": "Get default/all user credentials",
"operationId": "get_user_credential_api_credentials_get",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/credentials/{cred_name}": {
"post": {
"tags": [
"Credentials API"
],
"summary": "Set User Credential",
"description": "Post/Update user credentials",
"operationId": "set_user_credential_api_credentials__cred_name__post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Cred Name"
},
"name": "cred_name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CredentialOptions"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Credentials API"
],
"summary": "Delete Users Credential",
"description": "Delete user credentials given the secret_id",
"operationId": "delete_users_credential_api_credentials__cred_name__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Cred Name"
},
"name": "cred_name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CredentialGetResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/resources": {
"get": {
"tags": [
"Resource API"
],
"summary": "Get Resources",
"description": "Returns the information of resources available in different pools.",
"operationId": "get_resources_api_resources_get",
"parameters": [
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Pools"
},
"name": "pools",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Platforms"
},
"name": "platforms",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "All Pools",
"default": false
},
"name": "all_pools",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Concise",
"default": false
},
"name": "concise",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-Roles"
},
"name": "x-osmo-roles",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/resources/{name}": {
"get": {
"tags": [
"Resource API"
],
"summary": "Get One Resource",
"description": "Returns the request resource's information.",
"operationId": "get_one_resource_api_resources__name__get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/pool": {
"get": {
"tags": [
"Pool API"
],
"summary": "Get Pools",
"description": "Returns information regarding pools to users.\n\nIf all_pools is set to true, all pools' information will be returned in API response.\nOtherwise, only information from pools that the user has access to will be returned\nin the response.",
"operationId": "get_pools_api_pool_get",
"parameters": [
{
"required": false,
"schema": {
"type": "boolean",
"title": "All Pools",
"default": true
},
"name": "all_pools",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Pools"
},
"name": "pools",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/pool_quota": {
"get": {
"tags": [
"Pool API"
],
"summary": "Get Pool Quotas",
"operationId": "get_pool_quotas_api_pool_quota_get",
"parameters": [
{
"required": false,
"schema": {
"type": "boolean",
"title": "All Pools",
"default": true
},
"name": "all_pools",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Pools"
},
"name": "pools",
"in": "query"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/pool/{pool_name}/workflow": {
"post": {
"tags": [
"Pool API"
],
"summary": "Submit Workflow",
"description": "This api validates that a workflow is well formed and valid and then submits it.",
"operationId": "submit_workflow_api_pool__pool_name__workflow_post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Pool Name"
},
"name": "pool_name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Workflow Id"
},
"name": "workflow_id",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "App Uuid"
},
"name": "app_uuid",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "App Version"
},
"name": "app_version",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Dry Run",
"default": false
},
"name": "dry_run",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Validation Only",
"default": false
},
"name": "validation_only",
"in": "query"
},
{
"required": false,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/WorkflowPriority"
}
],
"default": "NORMAL"
},
"name": "priority",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Env Vars",
"default": []
},
"name": "env_vars",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-Roles"
},
"name": "x-osmo-roles",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateSpec"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubmitResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/pool/{pool_name}/workflow/{workflow_id}/restart": {
"post": {
"tags": [
"Pool API"
],
"summary": "Restart Workflow",
"description": "This api restarts a failed workflow and then submits it.",
"operationId": "restart_workflow_api_pool__pool_name__workflow__workflow_id__restart_post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Pool Name"
},
"name": "pool_name",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Workflow Id"
},
"name": "workflow_id",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-Roles"
},
"name": "x-osmo-roles",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubmitResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/bucket": {
"get": {
"tags": [
"Dataset API"
],
"summary": "Get Bucket Info",
"description": "This api allows users to fetch the default bucket and the list of available buckets.",
"operationId": "get_bucket_info_api_bucket_get",
"parameters": [
{
"required": false,
"schema": {
"type": "boolean",
"title": "Default Only",
"default": false
},
"name": "default_only",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BucketInfoResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/bucket/{bucket}/dataset/{name}": {
"delete": {
"tags": [
"Dataset API"
],
"summary": "Delete Dataset",
"description": "This api deletes a Dataset.",
"operationId": "delete_dataset_api_bucket__bucket__dataset__name__delete",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Bucket"
},
"name": "bucket",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Tag"
},
"name": "tag",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "All Flag",
"default": false
},
"name": "all_flag",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "Finish",
"default": false
},
"name": "finish",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/bucket/{bucket}/dataset/{name}/attribute": {
"post": {
"tags": [
"Dataset API"
],
"summary": "Change Name Tag Label Metadata",
"description": "This api can rename a dataset/collection or set/remove tags/labels/metadata.\nIf tag is not given, latest tag is selected",
"operationId": "change_name_tag_label_metadata_api_bucket__bucket__dataset__name__attribute_post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Bucket"
},
"name": "bucket",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Tag"
},
"name": "tag",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "New Name"
},
"name": "new_name",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Set Tag",
"default": []
},
"name": "set_tag",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Delete Tag",
"default": []
},
"name": "delete_tag",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Delete Label",
"default": []
},
"name": "delete_label",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Delete Metadata",
"default": []
},
"name": "delete_metadata",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_change_name_tag_label_metadata_api_bucket__bucket__dataset__name__attribute_post"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataAttributeResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/bucket/{bucket}/dataset/{name}/info": {
"get": {
"tags": [
"Dataset API"
],
"summary": "Get Info",
"description": "This api gives info about the Dataset or Dataset Version.",
"operationId": "get_info_api_bucket__bucket__dataset__name__info_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Bucket"
},
"name": "bucket",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Tag"
},
"name": "tag",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "All Flag",
"default": false
},
"name": "all_flag",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Count",
"default": 100
},
"name": "count",
"in": "query"
},
{
"required": false,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ListOrder"
}
],
"default": "ASC"
},
"name": "order",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataInfoResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/bucket/list_dataset": {
"get": {
"tags": [
"Dataset API"
],
"summary": "List Dataset From Bucket",
"description": "This api returns the list of datasets/colections.",
"operationId": "list_dataset_from_bucket_api_bucket_list_dataset_get",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "User"
},
"name": "user",
"in": "query"
},
{
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array",
"title": "Buckets",
"default": []
},
"name": "buckets",
"in": "query"
},
{
"required": false,
"schema": {
"$ref": "#/components/schemas/DatasetType"
},
"name": "dataset_type",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"title": "Latest Before"
},
"name": "latest_before",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"format": "date-time",
"title": "Latest After"
},
"name": "latest_after",
"in": "query"
},
{
"required": false,
"schema": {
"type": "boolean",
"title": "All Users",
"default": false
},
"name": "all_users",
"in": "query"
},
{
"required": false,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/ListOrder"
}
],
"default": "ASC"
},
"name": "order",
"in": "query"
},
{
"required": false,
"schema": {
"type": "integer",
"title": "Count",
"default": 20
},
"name": "count",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataListResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/bucket/{bucket}/dataset/{name}/collect": {
"post": {
"tags": [
"Dataset API"
],
"summary": "Create Collection",
"description": "This api creates a collection from datasets.",
"operationId": "create_collection_api_bucket__bucket__dataset__name__collect_post",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Bucket"
},
"name": "bucket",
"in": "path"
},
{
"required": true,
"schema": {
"type": "string",
"title": "Name"
},
"name": "name",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Body_create_collection_api_bucket__bucket__dataset__name__collect_post"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/bucket/{bucket}/query": {
"get": {
"tags": [
"Dataset API"
],
"summary": "Query Dataset",
"description": "This api queries dataset.",
"operationId": "query_dataset_api_bucket__bucket__query_get",
"parameters": [
{
"required": true,
"schema": {
"type": "string",
"title": "Bucket"
},
"name": "bucket",
"in": "path"
},
{
"required": false,
"schema": {
"type": "string",
"title": "Command",
"default": ""
},
"name": "command",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/api/profile/settings": {
"get": {
"tags": [
"Profile API"
],
"summary": "Get Notification Settings",
"operationId": "get_notification_settings_api_profile_settings_get",
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-Roles"
},
"name": "x-osmo-roles",
"in": "header"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Profile API"
],
"summary": "Set Notification Settings",
"operationId": "set_notification_settings_api_profile_settings_post",
"parameters": [
{
"required": false,
"schema": {
"type": "boolean",
"title": "Set Default Backend",
"default": false
},
"name": "set_default_backend",
"in": "query"
},
{
"required": false,
"schema": {
"type": "string",
"title": "X-Osmo-User"
},
"name": "x-osmo-user",
"in": "header"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserProfile"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/client/version": {
"get": {
"tags": [
"Misc API"
],
"summary": "Get Osmo Client Version",
"operationId": "get_osmo_client_version_client_version_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/health": {
"get": {
"tags": [
"Misc API"
],
"summary": "Health",
"description": "To be used for the readiness probe, but not liveness probe. That way, if this method is\nslow, no new traffic gets routed, instead of killing the service.",
"operationId": "health_health_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/version": {
"get": {
"tags": [
"Misc API"
],
"summary": "Get Version",
"operationId": "get_version_api_version_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/users": {
"get": {
"tags": [
"Misc API"
],
"summary": "Get Users",
"description": "Returns the values of all users who have submitted a workflow.",
"operationId": "get_users_api_users_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
},
"/api/tag": {
"get": {
"tags": [
"Misc API"
],
"summary": "Get Available Workflow Tags",
"description": "Returns all workflow tags.",
"operationId": "get_available_workflow_tags_api_tag_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
}
}
}
},
"/api/plugins/configs": {
"get": {
"tags": [
"Misc API"
],
"summary": "Get Workflow Plugins Configs",
"description": "Get all the workflow plugins configurations",
"operationId": "get_workflow_plugins_configs_api_plugins_configs_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AccessToken": {
"properties": {
"user_name": {
"type": "string",
"title": "User Name"
},
"token_name": {
"type": "string",
"title": "Token Name"
},
"expires_at": {
"type": "string",
"format": "date-time",
"title": "Expires At"
},
"description": {
"type": "string",
"title": "Description"
},
"access_type": {
"$ref": "#/components/schemas/AccessTokenType"
},
"roles": {
"items": {
"type": "string"
},
"type": "array",
"title": "Roles"
}
},
"type": "object",
"required": [
"user_name",
"token_name",
"expires_at",
"description",
"access_type",
"roles"
],
"title": "AccessToken",
"description": "Single Pool Entry "
},
"AccessTokenType": {
"enum": [
"USER",
"SERVICE"
],
"title": "AccessTokenType",
"description": "Type of access token "
},
"ActionPermissions": {
"properties": {
"execute": {
"allOf": [
{
"$ref": "#/components/schemas/PermissionLevel"
}
],
"default": "PRIVATE"
},
"portforward": {
"allOf": [
{
"$ref": "#/components/schemas/PermissionLevel"
}
],
"default": "PRIVATE"
},
"cancel": {
"allOf": [
{
"$ref": "#/components/schemas/PermissionLevel"
}
],
"default": "PRIVATE"
},
"rsync": {
"allOf": [
{
"$ref": "#/components/schemas/PermissionLevel"
}
],
"default": "PRIVATE"
}
},
"type": "object",
"title": "ActionPermissions",
"description": "Defines permissions for certain actionsfor a pool "
},
"AsymmetricKeyPair": {
"properties": {
"public_key": {
"type": "string",
"title": "Public Key"
},
"private_key": {
"type": "string",
"format": "password",
"title": "Private Key",
"writeOnly": true
}
},
"type": "object",
"required": [
"public_key",
"private_key"
],
"title": "AsymmetricKeyPair",
"description": "Store a public/private key pair "
},
"AuthenticationConfig": {
"properties": {
"keys": {
"additionalProperties": {
"$ref": "#/components/schemas/AsymmetricKeyPair"
},
"type": "object",
"title": "Keys"
},
"active_key": {
"type": "string",
"title": "Active Key"
},
"issuer": {
"type": "string",
"title": "Issuer"
},
"audience": {
"type": "string",
"title": "Audience"
},
"user_roles": {
"items": {
"type": "string"
},
"type": "array",
"title": "User Roles",
"default": [
"osmo-user"
]
},
"ctrl_roles": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ctrl Roles",
"default": [
"osmo-user",
"osmo-ctrl"
]
},
"login_info": {
"allOf": [
{
"$ref": "#/components/schemas/LoginInfo"
}
],
"title": "Login Info",
"default": {}
},
"max_token_duration": {
"type": "string",
"title": "Max Token Duration",
"default": "365d"
}
},
"type": "object",
"required": [
"keys",
"active_key",
"issuer",
"audience"
],
"title": "AuthenticationConfig",
"description": "Store info needed to generate and validate idtokens "
},
"Backend": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description"
},
"version": {
"type": "string",
"title": "Version"
},
"k8s_uid": {
"type": "string",
"title": "K8S Uid"
},
"k8s_namespace": {
"type": "string",
"title": "K8S Namespace"
},
"dashboard_url": {
"type": "string",
"title": "Dashboard Url"
},
"grafana_url": {
"type": "string",
"title": "Grafana Url"
},
"tests": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tests"
},
"scheduler_settings": {
"$ref": "#/components/schemas/BackendSchedulerSettings"
},
"node_conditions": {
"$ref": "#/components/schemas/BackendNodeConditions"
},
"last_heartbeat": {
"type": "string",
"format": "date-time",
"title": "Last Heartbeat"
},
"created_date": {
"type": "string",
"format": "date-time",
"title": "Created Date"
},
"router_address": {
"type": "string",
"title": "Router Address"
},
"online": {
"type": "boolean",
"title": "Online"
}
},
"type": "object",
"required": [
"name",
"description",
"version",
"k8s_uid",
"k8s_namespace",
"dashboard_url",
"grafana_url",
"tests",
"scheduler_settings",
"node_conditions",
"last_heartbeat",
"created_date",
"router_address",
"online"
],
"title": "Backend",
"description": "Object storing backend info. "
},
"BackendConfig": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"k8s_uid": {
"type": "string",
"title": "K8S Uid"
},
"dashboard_url": {
"type": "string",
"title": "Dashboard Url"
},
"grafana_url": {
"type": "string",
"title": "Grafana Url"
},
"tests": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tests"
},
"scheduler_settings": {
"$ref": "#/components/schemas/BackendSchedulerSettings"
},
"node_conditions": {
"$ref": "#/components/schemas/BackendNodeConditions"
},
"router_address": {
"type": "string",
"title": "Router Address"
}
},
"type": "object",
"title": "BackendConfig",
"description": "Similar to connectors.Backend, but with optional fields."
},
"BackendNodeConditions": {
"properties": {
"rules": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Rules"
},
"prefix": {
"type": "string",
"title": "Prefix",
"default": "osmo.nvidia.com/"
}
},
"type": "object",
"title": "BackendNodeConditions",
"description": "Settings for backend node conditions. "
},
"BackendResourceType": {
"enum": [
"RESERVED",
"SHARED",
"UNUSED"
],
"title": "BackendResourceType",
"description": "Resource type for BackendResource. "
},
"BackendSchedulerSettings": {
"properties": {
"scheduler_type": {
"allOf": [
{
"$ref": "#/components/schemas/BackendSchedulerType"
}
],
"default": "kai"
},
"scheduler_name": {
"type": "string",
"title": "Scheduler Name",
"default": "kai-scheduler"
},
"scheduler_timeout": {
"type": "integer",
"title": "Scheduler Timeout",
"default": 30
}
},
"type": "object",
"title": "BackendSchedulerSettings",
"description": "Settings that control the how pods are scheduled in a backend"
},
"BackendSchedulerType": {
"enum": [
"kai"
],
"title": "BackendSchedulerType",
"description": "Defines the type of scheduler used by the backend "
},
"BackendTests": {
"properties": {
"name": {
"type": "string",
"minLength": 1,
"title": "Name"
},
"description": {
"type": "string",
"title": "Description"
},
"cron_schedule": {
"type": "string",
"minLength": 1,
"title": "Cron Schedule"
},
"test_timeout": {
"type": "string",
"title": "Test Timeout",
"default": "300s"
},
"node_conditions": {
"items": {
"type": "string"
},
"type": "array",
"minItems": 1,
"title": "Node Conditions"
},
"common_pod_template": {
"items": {
"type": "string"
},
"type": "array",
"minItems": 1,
"title": "Common Pod Template"
},
"parsed_pod_template": {
"type": "object",
"title": "Parsed Pod Template",
"default": {}
}
},
"type": "object",
"required": [
"name",
"description",
"cron_schedule",
"node_conditions",
"common_pod_template"
],
"title": "BackendTests",
"description": "Represents a test config. "
},
"Body_change_name_tag_label_metadata_api_bucket__bucket__dataset__name__attribute_post": {
"properties": {
"set_label": {
"type": "object",
"title": "Set Label",
"default": {}
},
"set_metadata": {
"type": "object",
"title": "Set Metadata",
"default": {}
}
},
"type": "object",
"title": "Body_change_name_tag_label_metadata_api_bucket__bucket__dataset__name__attribute_post"
},
"Body_create_collection_api_bucket__bucket__dataset__name__collect_post": {
"properties": {
"datasets": {
"items": {
"$ref": "#/components/schemas/DatasetStructure"
},
"type": "array",
"title": "Datasets"
}
},
"type": "object",
"required": [
"datasets"
],
"title": "Body_create_collection_api_bucket__bucket__dataset__name__collect_post"
},
"BucketConfig": {
"properties": {
"dataset_path": {
"type": "string",
"pattern": "(^swift://[^/,;*]+(/[^/,;*]+){2,}/*$|^s3://[^/,;*]+(/[^/,;*]+)*/*$|^gs://[^/,;*]+(/[^/,;*]+)*/*$|^tos://[^/,;*]+(/[^/,;*]+)+/*$|^azure://[^/,;*]+(/[^/,;*]+)+/*$)",
"title": "Dataset Path"
},
"region": {
"type": "string",
"title": "Region",
"default": "us-east-1"
},
"check_key": {
"type": "boolean",
"title": "Check Key",
"default": false
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"mode": {
"type": "string",
"title": "Mode",
"default": "read-write"
},
"default_credential": {
"$ref": "#/components/schemas/StaticDataCredential"
}
},
"type": "object",
"required": [
"dataset_path"
],
"title": "BucketConfig",
"description": "Class to store the name of the bucket and the dataset path"
},
"BucketInfoEntry": {
"properties": {
"path": {
"type": "string",
"title": "Path"
},
"description": {
"type": "string",
"title": "Description"
},
"mode": {
"type": "string",
"title": "Mode"
},
"default_cred": {
"type": "boolean",
"title": "Default Cred"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"path",
"description",
"mode",
"default_cred"
],
"title": "BucketInfoEntry",
"description": "Object storing Upload Response. "
},
"BucketInfoResponse": {
"properties": {
"default": {
"type": "string",
"title": "Default"
},
"buckets": {
"additionalProperties": {
"$ref": "#/components/schemas/BucketInfoEntry"
},
"type": "object",
"title": "Buckets"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"buckets"
],
"title": "BucketInfoResponse",
"description": "Object storing Upload Response. "
},
"CancelResponse": {
"properties": {
"name": {
"type": "string",
"title": "Name"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"title": "CancelResponse",
"description": "Object storing workflow name. "
},
"CliConfig": {
"properties": {
"latest_version": {
"type": "string",
"title": "Latest Version"
},
"min_supported_version": {
"type": "string",
"title": "Min Supported Version"
}
},
"type": "object",
"title": "CliConfig",
"description": "Config for storing information regarding CLI storage. "
},
"ConfigDiffResponse": {
"properties": {
"first_data": {
"title": "First Data"
},
"second_data": {
"title": "Second Data"
}
},
"type": "object",
"title": "ConfigDiffResponse",
"description": "Response body for config diff endpoint."
},
"ConfigHistory": {
"properties": {
"config_type": {
"$ref": "#/components/schemas/src__lib__utils__config_history__ConfigHistoryType"
},
"name": {
"type": "string",
"title": "Name"
},
"revision": {
"type": "integer",
"title": "Revision"
},
"username": {
"type": "string",
"title": "Username"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"data": {
"title": "Data"
}
},
"type": "object",
"required": [
"config_type",
"name",
"revision",
"username",
"created_at",
"description"
],
"title": "ConfigHistory",
"description": "Object storing config history."
},
"ConfigsRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
}
},
"type": "object",
"title": "ConfigsRequest",
"description": "Request body for updating configurations with history tracking metadata."
},
"CredentialConfig": {
"properties": {
"disable_registry_validation": {
"items": {
"type": "string"
},
"type": "array",
"title": "Disable Registry Validation",
"default": []
},
"disable_data_validation": {
"items": {
"type": "string"
},
"type": "array",
"title": "Disable Data Validation",
"default": []
}
},
"type": "object",
"title": "CredentialConfig",
"description": "Stores registries/data which do not do validation "
},
"CredentialGetResponse": {
"properties": {
"credentials": {
"items": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": "array",
"title": "Credentials"
}
},
"type": "object",
"required": [
"credentials"
],
"title": "CredentialGetResponse",
"description": "Credential Response. "
},
"CredentialOptions": {
"properties": {
"registry_credential": {
"allOf": [
{
"$ref": "#/components/schemas/UserRegistryCredential"
}
],
"title": "Registry Credential",
"description": "Authentication information for a Docker registry"
},
"data_credential": {
"allOf": [
{
"$ref": "#/components/schemas/UserDataCredential"
}
],
"title": "Data Credential",
"description": "Authentication information for a data service"
},
"generic_credential": {
"allOf": [
{
"$ref": "#/components/schemas/UserCredential"
}
],
"title": "Generic Credential",
"description": "Generic authentication information"
}
},
"type": "object",
"title": "CredentialOptions",
"description": "Credential options "
},
"DataAttributeResponse": {
"properties": {
"tag_response": {
"$ref": "#/components/schemas/DataTagResponse"
},
"label_response": {
"$ref": "#/components/schemas/DataMetadataResponse"
},
"metadata_response": {
"$ref": "#/components/schemas/DataMetadataResponse"
}
},
"additionalProperties": false,
"type": "object",
"title": "DataAttributeResponse",
"description": "Object storing Tag/Label/Metadata Response. "
},
"DataConfig": {
"properties": {
"credential": {
"$ref": "#/components/schemas/StaticDataCredential"
},
"base_url": {
"type": "string",
"title": "Base Url",
"default": ""
},
"websocket_timeout": {
"type": "integer",
"title": "Websocket Timeout",
"default": 1440
},
"data_timeout": {
"type": "integer",
"title": "Data Timeout",
"default": 10
},
"download_type": {
"allOf": [
{
"$ref": "#/components/schemas/DownloadType"
}
],
"default": "download"
}
},
"type": "object",
"title": "DataConfig",
"description": "Config for storing information about data. "
},
"DataInfoCollectionEntry": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"version": {
"type": "string",
"title": "Version"
},
"location": {
"type": "string",
"title": "Location"
},
"uri": {
"type": "string",
"title": "Uri"
},
"hash_location": {
"type": "string",
"title": "Hash Location"
},
"size": {
"type": "integer",
"title": "Size"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"version",
"location",
"uri",
"size"
],
"title": "DataInfoCollectionEntry",
"description": "Object storing Info Element. "
},
"DataInfoDatasetEntry": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"version": {
"type": "string",
"title": "Version"
},
"status": {
"$ref": "#/components/schemas/DatasetStatus"
},
"created_by": {
"type": "string",
"title": "Created By"
},
"created_date": {
"type": "string",
"format": "date-time",
"title": "Created Date"
},
"last_used": {
"type": "string",
"format": "date-time",
"title": "Last Used"
},
"retention_policy": {
"type": "number",
"format": "time-delta",
"title": "Retention Policy"
},
"size": {
"type": "integer",
"title": "Size"
},
"checksum": {
"type": "string",
"title": "Checksum"
},
"location": {
"type": "string",
"title": "Location"
},
"uri": {
"type": "string",
"title": "Uri"
},
"metadata": {
"type": "object",
"title": "Metadata"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"collections": {
"items": {
"type": "string"
},
"type": "array",
"title": "Collections"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"version",
"status",
"created_by",
"created_date",
"last_used",
"retention_policy",
"size",
"checksum",
"location",
"uri",
"metadata",
"tags",
"collections"
],
"title": "DataInfoDatasetEntry",
"description": "Object storing Info Element. "
},
"DataInfoResponse": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"id": {
"type": "string",
"title": "Id"
},
"bucket": {
"type": "string",
"title": "Bucket"
},
"created_by": {
"type": "string",
"title": "Created By"
},
"created_date": {
"type": "string",
"format": "date-time",
"title": "Created Date"
},
"hash_location": {
"type": "string",
"title": "Hash Location"
},
"hash_location_size": {
"type": "integer",
"title": "Hash Location Size"
},
"labels": {
"type": "object",
"title": "Labels"
},
"type": {
"$ref": "#/components/schemas/DatasetType"
},
"versions": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/DataInfoDatasetEntry"
},
{
"$ref": "#/components/schemas/DataInfoCollectionEntry"
}
]
},
"type": "array",
"title": "Versions"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"id",
"bucket",
"labels",
"type",
"versions"
],
"title": "DataInfoResponse",
"description": "Object storing Data Info Elements. "
},
"DataListEntry": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"id": {
"type": "string",
"title": "Id"
},
"bucket": {
"type": "string",
"title": "Bucket"
},
"create_time": {
"type": "string",
"format": "date-time",
"title": "Create Time"
},
"last_created": {
"type": "string",
"format": "date-time",
"title": "Last Created"
},
"hash_location": {
"type": "string",
"title": "Hash Location"
},
"hash_location_size": {
"type": "integer",
"title": "Hash Location Size"
},
"version_id": {
"type": "string",
"title": "Version Id"
},
"type": {
"$ref": "#/components/schemas/DatasetType"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"id",
"bucket",
"create_time",
"type"
],
"title": "DataListEntry",
"description": "Object storing Data List Element. "
},
"DataListResponse": {
"properties": {
"datasets": {
"items": {
"$ref": "#/components/schemas/DataListEntry"
},
"type": "array",
"title": "Datasets"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"datasets"
],
"title": "DataListResponse",
"description": "Object storing Data List Elements. "
},
"DataMetadataResponse": {
"properties": {
"metadata": {
"type": "object",
"title": "Metadata"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"metadata"
],
"title": "DataMetadataResponse",
"description": "Object storing Label/Metadata Response. "
},
"DataTagResponse": {
"properties": {
"version_id": {
"type": "string",
"title": "Version Id"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"version_id",
"tags"
],
"title": "DataTagResponse",
"description": "Object storing Tag Response. "
},
"DatasetConfig": {
"properties": {
"buckets": {
"additionalProperties": {
"$ref": "#/components/schemas/BucketConfig"
},
"type": "object",
"title": "Buckets",
"default": {}
},
"default_bucket": {
"type": "string",
"title": "Default Bucket",
"default": ""
}
},
"type": "object",
"title": "DatasetConfig",
"description": "Stores any dataset configs External Admins control "
},
"DatasetStatus": {
"enum": [
"PENDING",
"READY",
"PENDING_DELETE",
"DELETED"
],
"title": "DatasetStatus",
"description": "The status of a dataset / dataset version."
},
"DatasetStructure": {
"properties": {
"name": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]+$",
"title": "Name"
},
"tag": {
"type": "string",
"pattern": "^([a-zA-Z0-9_-]*)$",
"title": "Tag"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"tag"
],
"title": "DatasetStructure",
"description": "Object storing execution cluster node resource information. "
},
"DatasetType": {
"enum": [
"COLLECTION",
"DATASET"
],
"title": "DatasetType",
"description": "An enumeration."
},
"DeleteBackendRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"force": {
"type": "boolean",
"title": "Force",
"default": false
}
},
"type": "object",
"title": "DeleteBackendRequest",
"description": "Request body for deleting a backend with history tracking metadata."
},
"DownloadType": {
"type": "string",
"enum": [
"download"
],
"title": "DownloadType",
"description": "Type of Config to fetch or set "
},
"EditResponse": {
"properties": {
"uuid": {
"type": "string",
"title": "Uuid"
},
"version": {
"type": "integer",
"title": "Version"
},
"name": {
"type": "string",
"title": "Name"
},
"created_by": {
"type": "string",
"title": "Created By"
},
"created_date": {
"type": "string",
"format": "date-time",
"title": "Created Date"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"uuid",
"version",
"name",
"created_by",
"created_date"
],
"title": "EditResponse"
},
"EditablePoolConfig": {
"properties": {
"pools": {
"additionalProperties": {
"$ref": "#/components/schemas/PoolEditable"
},
"type": "object",
"title": "Pools",
"default": {}
}
},
"type": "object",
"title": "EditablePoolConfig",
"description": "Stores editable pool configs."
},
"GetConfigsHistoryResponse": {
"properties": {
"configs": {
"items": {
"$ref": "#/components/schemas/ConfigHistory"
},
"type": "array",
"title": "Configs"
}
},
"type": "object",
"required": [
"configs"
],
"title": "GetConfigsHistoryResponse",
"description": "Response body for config history endpoint."
},
"GroupQueryResponse": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"status": {
"$ref": "#/components/schemas/TaskGroupStatus"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time"
},
"end_time": {
"type": "string",
"format": "date-time",
"title": "End Time"
},
"processing_start_time": {
"type": "string",
"format": "date-time",
"title": "Processing Start Time"
},
"scheduling_start_time": {
"type": "string",
"format": "date-time",
"title": "Scheduling Start Time"
},
"initializing_start_time": {
"type": "string",
"format": "date-time",
"title": "Initializing Start Time"
},
"remaining_upstream_groups": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Remaining Upstream Groups"
},
"downstream_groups": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Downstream Groups"
},
"failure_message": {
"type": "string",
"title": "Failure Message"
},
"tasks": {
"items": {
"$ref": "#/components/schemas/TaskQueryResponse"
},
"type": "array",
"title": "Tasks",
"default": []
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"status"
],
"title": "GroupQueryResponse",
"description": "Represents the queryed task information. "
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"ListBackendsResponse": {
"properties": {
"backends": {
"items": {
"$ref": "#/components/schemas/Backend"
},
"type": "array",
"title": "Backends"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"backends"
],
"title": "ListBackendsResponse",
"description": "Object storing info for all backends. "
},
"ListOrder": {
"enum": [
"ASC",
"DESC"
],
"title": "ListOrder",
"description": "Represents the list order for the database. "
},
"ListTaskAggregatedEntry": {
"properties": {
"user": {
"type": "string",
"title": "User"
},
"pool": {
"type": "string",
"title": "Pool"
},
"storage": {
"type": "integer",
"title": "Storage"
},
"cpu": {
"type": "integer",
"title": "Cpu"
},
"memory": {
"type": "integer",
"title": "Memory"
},
"gpu": {
"type": "integer",
"title": "Gpu"
},
"priority": {
"type": "string",
"title": "Priority"
},
"workflow_id": {
"type": "string",
"title": "Workflow Id"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"user",
"storage",
"cpu",
"memory",
"gpu",
"priority",
"workflow_id"
],
"title": "ListTaskAggregatedEntry",
"description": "Entry for task list API results, aggregated by workflow. "
},
"ListTaskAggregatedResponse": {
"properties": {
"summaries": {
"items": {
"$ref": "#/components/schemas/ListTaskAggregatedEntry"
},
"type": "array",
"title": "Summaries"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"summaries"
],
"title": "ListTaskAggregatedResponse"
},
"ListTaskEntry": {
"properties": {
"user": {
"type": "string",
"title": "User"
},
"workflow_id": {
"type": "string",
"title": "Workflow Id"
},
"workflow_uuid": {
"type": "string",
"title": "Workflow Uuid"
},
"task_name": {
"type": "string",
"title": "Task Name"
},
"retry_id": {
"type": "integer",
"title": "Retry Id"
},
"pool": {
"type": "string",
"title": "Pool"
},
"node": {
"type": "string",
"title": "Node"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time"
},
"end_time": {
"type": "string",
"format": "date-time",
"title": "End Time"
},
"duration": {
"type": "number",
"format": "time-delta",
"title": "Duration"
},
"status": {
"$ref": "#/components/schemas/TaskGroupStatus"
},
"overview": {
"type": "string",
"title": "Overview"
},
"logs": {
"type": "string",
"title": "Logs"
},
"error_logs": {
"type": "string",
"title": "Error Logs"
},
"grafana_url": {
"type": "string",
"title": "Grafana Url"
},
"dashboard_url": {
"type": "string",
"title": "Dashboard Url"
},
"storage": {
"type": "integer",
"title": "Storage"
},
"cpu": {
"type": "integer",
"title": "Cpu"
},
"memory": {
"type": "integer",
"title": "Memory"
},
"gpu": {
"type": "integer",
"title": "Gpu"
},
"priority": {
"type": "string",
"title": "Priority"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"user",
"workflow_id",
"workflow_uuid",
"task_name",
"retry_id",
"status",
"overview",
"logs",
"storage",
"cpu",
"memory",
"gpu",
"priority"
],
"title": "ListTaskEntry",
"description": "Entry for task list API results. "
},
"ListTaskResponse": {
"properties": {
"tasks": {
"items": {
"$ref": "#/components/schemas/ListTaskEntry"
},
"type": "array",
"title": "Tasks"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tasks"
],
"title": "ListTaskResponse"
},
"ListTaskSummaryEntry": {
"properties": {
"user": {
"type": "string",
"title": "User"
},
"pool": {
"type": "string",
"title": "Pool"
},
"storage": {
"type": "integer",
"title": "Storage"
},
"cpu": {
"type": "integer",
"title": "Cpu"
},
"memory": {
"type": "integer",
"title": "Memory"
},
"gpu": {
"type": "integer",
"title": "Gpu"
},
"priority": {
"type": "string",
"title": "Priority"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"user",
"storage",
"cpu",
"memory",
"gpu",
"priority"
],
"title": "ListTaskSummaryEntry",
"description": "Entry for task list API results. "
},
"ListTaskSummaryResponse": {
"properties": {
"summaries": {
"items": {
"$ref": "#/components/schemas/ListTaskSummaryEntry"
},
"type": "array",
"title": "Summaries"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"summaries"
],
"title": "ListTaskSummaryResponse"
},
"LogConfig": {
"properties": {
"credential": {
"$ref": "#/components/schemas/StaticDataCredential"
}
},
"type": "object",
"title": "LogConfig",
"description": "Config for storing information about data. "
},
"LoginInfo": {
"properties": {
"device_endpoint": {
"type": "string",
"title": "Device Endpoint"
},
"device_client_id": {
"type": "string",
"title": "Device Client Id"
},
"browser_endpoint": {
"type": "string",
"title": "Browser Endpoint"
},
"browser_client_id": {
"type": "string",
"title": "Browser Client Id"
},
"token_endpoint": {
"type": "string",
"title": "Token Endpoint"
},
"logout_endpoint": {
"type": "string",
"title": "Logout Endpoint"
}
},
"type": "object",
"title": "LoginInfo",
"description": "Store info needed to login "
},
"MinimalPoolConfig": {
"properties": {
"pools": {
"additionalProperties": {
"$ref": "#/components/schemas/PoolMinimal"
},
"type": "object",
"title": "Pools",
"default": {}
}
},
"type": "object",
"title": "MinimalPoolConfig",
"description": "Stores minimal pool configs."
},
"NotificationConfig": {
"properties": {
"slack_token": {
"type": "string",
"format": "password",
"title": "Slack Token",
"default": "",
"writeOnly": true
},
"smtp_settings": {
"allOf": [
{
"$ref": "#/components/schemas/SMTPConfig"
}
],
"title": "Smtp Settings",
"default": {
"host": "",
"sender": "",
"password": ""
}
}
},
"type": "object",
"title": "NotificationConfig"
},
"OperatorType": {
"enum": [
"GT",
"GE",
"LT",
"LE",
"EQ"
],
"title": "OperatorType",
"description": "An enumeration."
},
"OsmoImageConfig": {
"properties": {
"init": {
"type": "string",
"title": "Init",
"default": ""
},
"client": {
"type": "string",
"title": "Client",
"default": ""
},
"credential": {
"allOf": [
{
"$ref": "#/components/schemas/RegistryCredential"
}
],
"title": "Credential",
"default": {
"registry": "",
"username": "",
"auth": ""
}
}
},
"type": "object",
"title": "OsmoImageConfig",
"description": "Dynamic Config for storing the image URLs for service images and the credentials needed\nto pull them."
},
"PatchBackendTestRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs_dict": {
"type": "object",
"title": "Configs Dict"
}
},
"type": "object",
"required": [
"configs_dict"
],
"title": "PatchBackendTestRequest",
"description": "Request body for patching a test with history tracking metadata."
},
"PatchConfigRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs_dict": {
"type": "object",
"title": "Configs Dict"
}
},
"type": "object",
"required": [
"configs_dict"
],
"title": "PatchConfigRequest",
"description": "Request body for patching configurations with history tracking metadata."
},
"PatchDatasetRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs_dict": {
"type": "object",
"title": "Configs Dict"
}
},
"type": "object",
"required": [
"configs_dict"
],
"title": "PatchDatasetRequest",
"description": "Request body for patching a dataset bucket configuration with history tracking metadata."
},
"PatchPoolRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs_dict": {
"type": "object",
"title": "Configs Dict"
}
},
"type": "object",
"required": [
"configs_dict"
],
"title": "PatchPoolRequest",
"description": "Request body for patching a pool with history tracking metadata."
},
"PermissionLevel": {
"enum": [
"PUBLIC",
"POOL",
"PRIVATE"
],
"title": "PermissionLevel",
"description": "Permission Level "
},
"Platform": {
"properties": {
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"host_network_allowed": {
"type": "boolean",
"title": "Host Network Allowed",
"default": false
},
"privileged_allowed": {
"type": "boolean",
"title": "Privileged Allowed",
"default": false
},
"allowed_mounts": {
"items": {
"type": "string"
},
"type": "array",
"title": "Allowed Mounts",
"default": []
},
"default_mounts": {
"items": {
"type": "string"
},
"type": "array",
"title": "Default Mounts",
"default": []
},
"tolerations": {
"items": {
"$ref": "#/components/schemas/Toleration"
},
"type": "array",
"title": "Tolerations",
"default": []
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Labels",
"default": {}
},
"default_variables": {
"type": "object",
"title": "Default Variables",
"default": {}
},
"resource_validations": {
"items": {
"type": "string"
},
"type": "array",
"title": "Resource Validations",
"default": []
},
"parsed_resource_validations": {
"items": {
"$ref": "#/components/schemas/ResourceAssertion"
},
"type": "array",
"title": "Parsed Resource Validations",
"default": []
},
"override_pod_template": {
"items": {
"type": "string"
},
"type": "array",
"title": "Override Pod Template",
"default": []
},
"parsed_pod_template": {
"type": "object",
"title": "Parsed Pod Template",
"default": {}
}
},
"type": "object",
"title": "Platform",
"description": "Single Platform Entry "
},
"PlatformEditable": {
"properties": {
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"host_network_allowed": {
"type": "boolean",
"title": "Host Network Allowed",
"default": false
},
"privileged_allowed": {
"type": "boolean",
"title": "Privileged Allowed",
"default": false
},
"allowed_mounts": {
"items": {
"type": "string"
},
"type": "array",
"title": "Allowed Mounts",
"default": []
},
"default_variables": {
"type": "object",
"title": "Default Variables",
"default": {}
},
"resource_validations": {
"items": {
"type": "string"
},
"type": "array",
"title": "Resource Validations",
"default": []
},
"override_pod_template": {
"items": {
"type": "string"
},
"type": "array",
"title": "Override Pod Template",
"default": []
}
},
"type": "object",
"title": "PlatformEditable",
"description": "Single Platform Entry "
},
"PlatformMinimal": {
"properties": {
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"host_network_allowed": {
"type": "boolean",
"title": "Host Network Allowed",
"default": false
},
"privileged_allowed": {
"type": "boolean",
"title": "Privileged Allowed",
"default": false
},
"allowed_mounts": {
"items": {
"type": "string"
},
"type": "array",
"title": "Allowed Mounts",
"default": []
},
"default_mounts": {
"items": {
"type": "string"
},
"type": "array",
"title": "Default Mounts",
"default": []
}
},
"type": "object",
"title": "PlatformMinimal",
"description": "Single Platform Entry "
},
"PluginsConfig": {
"properties": {
"rsync": {
"allOf": [
{
"$ref": "#/components/schemas/RsyncConfig"
}
],
"title": "Rsync",
"default": {
"enabled": false,
"enable_telemetry": false,
"read_bandwidth_limit": 2621440,
"write_bandwidth_limit": 2621440,
"allowed_paths": {},
"daemon_debounce_delay": 30.0,
"daemon_poll_interval": 120.0,
"daemon_reconcile_interval": 60.0,
"client_upload_rate_limit": 2097152
}
}
},
"type": "object",
"title": "PluginsConfig",
"description": "Stores any plugins configs "
},
"Pool": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"default": ""
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"status": {
"$ref": "#/components/schemas/PoolStatus"
},
"download_type": {
"$ref": "#/components/schemas/DownloadType"
},
"enable_maintenance": {
"type": "boolean",
"title": "Enable Maintenance",
"default": false
},
"backend": {
"type": "string",
"title": "Backend"
},
"default_platform": {
"type": "string",
"title": "Default Platform"
},
"default_exec_timeout": {
"type": "string",
"title": "Default Exec Timeout",
"default": ""
},
"default_queue_timeout": {
"type": "string",
"title": "Default Queue Timeout",
"default": ""
},
"max_exec_timeout": {
"type": "string",
"title": "Max Exec Timeout",
"default": ""
},
"max_queue_timeout": {
"type": "string",
"title": "Max Queue Timeout",
"default": ""
},
"default_exit_actions": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Default Exit Actions",
"default": {}
},
"action_permissions": {
"allOf": [
{
"$ref": "#/components/schemas/ActionPermissions"
}
],
"title": "Action Permissions",
"default": {
"execute": "PRIVATE",
"portforward": "PRIVATE",
"cancel": "PRIVATE",
"rsync": "PRIVATE"
}
},
"resources": {
"allOf": [
{
"$ref": "#/components/schemas/PoolResources"
}
],
"title": "Resources",
"default": {}
},
"common_default_variables": {
"type": "object",
"title": "Common Default Variables",
"default": {}
},
"common_resource_validations": {
"items": {
"type": "string"
},
"type": "array",
"title": "Common Resource Validations",
"default": []
},
"parsed_resource_validations": {
"items": {
"$ref": "#/components/schemas/ResourceAssertion"
},
"type": "array",
"title": "Parsed Resource Validations",
"default": []
},
"common_pod_template": {
"items": {
"type": "string"
},
"type": "array",
"title": "Common Pod Template",
"default": []
},
"parsed_pod_template": {
"type": "object",
"title": "Parsed Pod Template",
"default": {}
},
"platforms": {
"additionalProperties": {
"$ref": "#/components/schemas/Platform"
},
"type": "object",
"title": "Platforms",
"default": {}
},
"last_heartbeat": {
"type": "string",
"format": "date-time",
"title": "Last Heartbeat"
}
},
"type": "object",
"required": [
"backend"
],
"title": "Pool",
"description": "Single Pool Entry "
},
"PoolEditable": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"default": ""
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"status": {
"$ref": "#/components/schemas/PoolStatus"
},
"download_type": {
"$ref": "#/components/schemas/DownloadType"
},
"enable_maintenance": {
"type": "boolean",
"title": "Enable Maintenance",
"default": false
},
"backend": {
"type": "string",
"title": "Backend"
},
"default_platform": {
"type": "string",
"title": "Default Platform"
},
"default_exec_timeout": {
"type": "string",
"title": "Default Exec Timeout",
"default": ""
},
"default_queue_timeout": {
"type": "string",
"title": "Default Queue Timeout",
"default": ""
},
"max_exec_timeout": {
"type": "string",
"title": "Max Exec Timeout",
"default": ""
},
"max_queue_timeout": {
"type": "string",
"title": "Max Queue Timeout",
"default": ""
},
"default_exit_actions": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Default Exit Actions",
"default": {}
},
"action_permissions": {
"allOf": [
{
"$ref": "#/components/schemas/ActionPermissions"
}
],
"title": "Action Permissions",
"default": {
"execute": "PRIVATE",
"portforward": "PRIVATE",
"cancel": "PRIVATE",
"rsync": "PRIVATE"
}
},
"resources": {
"allOf": [
{
"$ref": "#/components/schemas/PoolResources"
}
],
"title": "Resources",
"default": {}
},
"common_default_variables": {
"type": "object",
"title": "Common Default Variables",
"default": {}
},
"common_resource_validations": {
"items": {
"type": "string"
},
"type": "array",
"title": "Common Resource Validations",
"default": []
},
"common_pod_template": {
"items": {
"type": "string"
},
"type": "array",
"title": "Common Pod Template",
"default": []
},
"platforms": {
"additionalProperties": {
"$ref": "#/components/schemas/PlatformEditable"
},
"type": "object",
"title": "Platforms",
"default": {}
}
},
"type": "object",
"required": [
"backend"
],
"title": "PoolEditable",
"description": "Pool schema to expose through API endpoint. "
},
"PoolMinimal": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"default": ""
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"status": {
"$ref": "#/components/schemas/PoolStatus"
},
"download_type": {
"$ref": "#/components/schemas/DownloadType"
},
"enable_maintenance": {
"type": "boolean",
"title": "Enable Maintenance",
"default": false
},
"backend": {
"type": "string",
"title": "Backend"
},
"default_platform": {
"type": "string",
"title": "Default Platform"
},
"default_exec_timeout": {
"type": "string",
"title": "Default Exec Timeout",
"default": ""
},
"default_queue_timeout": {
"type": "string",
"title": "Default Queue Timeout",
"default": ""
},
"max_exec_timeout": {
"type": "string",
"title": "Max Exec Timeout",
"default": ""
},
"max_queue_timeout": {
"type": "string",
"title": "Max Queue Timeout",
"default": ""
},
"default_exit_actions": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Default Exit Actions",
"default": {}
},
"action_permissions": {
"allOf": [
{
"$ref": "#/components/schemas/ActionPermissions"
}
],
"title": "Action Permissions",
"default": {
"execute": "PRIVATE",
"portforward": "PRIVATE",
"cancel": "PRIVATE",
"rsync": "PRIVATE"
}
},
"resources": {
"allOf": [
{
"$ref": "#/components/schemas/PoolResources"
}
],
"title": "Resources",
"default": {}
},
"platforms": {
"additionalProperties": {
"$ref": "#/components/schemas/PlatformMinimal"
},
"type": "object",
"title": "Platforms",
"default": {}
}
},
"type": "object",
"required": [
"backend"
],
"title": "PoolMinimal",
"description": "Pool schema to expose through API endpoint. "
},
"PoolNodeSetResourceUsage": {
"properties": {
"pools": {
"items": {
"$ref": "#/components/schemas/PoolResourceUsage"
},
"type": "array",
"title": "Pools"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"pools"
],
"title": "PoolNodeSetResourceUsage",
"description": "Object storing pool node set information. "
},
"PoolResourceCountable": {
"properties": {
"guarantee": {
"type": "integer",
"title": "Guarantee",
"default": -1
},
"maximum": {
"type": "integer",
"title": "Maximum",
"default": -1
},
"weight": {
"type": "integer",
"title": "Weight",
"default": 1
}
},
"type": "object",
"title": "PoolResourceCountable",
"description": "Resources like GPU or CPU that have a discrete number. For guarantee and maximum, a value of -1\nindicates that there is no limit."
},
"PoolResourceUsage": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"default": ""
},
"description": {
"type": "string",
"title": "Description",
"default": ""
},
"status": {
"$ref": "#/components/schemas/PoolStatus"
},
"download_type": {
"$ref": "#/components/schemas/DownloadType"
},
"enable_maintenance": {
"type": "boolean",
"title": "Enable Maintenance",
"default": false
},
"backend": {
"type": "string",
"title": "Backend"
},
"default_platform": {
"type": "string",
"title": "Default Platform"
},
"default_exec_timeout": {
"type": "string",
"title": "Default Exec Timeout",
"default": ""
},
"default_queue_timeout": {
"type": "string",
"title": "Default Queue Timeout",
"default": ""
},
"max_exec_timeout": {
"type": "string",
"title": "Max Exec Timeout",
"default": ""
},
"max_queue_timeout": {
"type": "string",
"title": "Max Queue Timeout",
"default": ""
},
"default_exit_actions": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Default Exit Actions",
"default": {}
},
"action_permissions": {
"allOf": [
{
"$ref": "#/components/schemas/ActionPermissions"
}
],
"title": "Action Permissions",
"default": {
"execute": "PRIVATE",
"portforward": "PRIVATE",
"cancel": "PRIVATE",
"rsync": "PRIVATE"
}
},
"resources": {
"allOf": [
{
"$ref": "#/components/schemas/PoolResources"
}
],
"title": "Resources",
"default": {}
},
"platforms": {
"additionalProperties": {
"$ref": "#/components/schemas/PlatformMinimal"
},
"type": "object",
"title": "Platforms",
"default": {}
},
"resource_usage": {
"$ref": "#/components/schemas/ResourceUsage"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"backend",
"resource_usage"
],
"title": "PoolResourceUsage",
"description": "Object storing pool information. "
},
"PoolResources": {
"properties": {
"gpu": {
"$ref": "#/components/schemas/PoolResourceCountable"
}
},
"type": "object",
"title": "PoolResources",
"description": "Resources allocated to the pool, for schedulers that support this feature "
},
"PoolResourcesEntry": {
"properties": {
"pool": {
"type": "string",
"title": "Pool"
},
"platform": {
"type": "string",
"title": "Platform"
},
"status": {
"$ref": "#/components/schemas/PoolStatus"
},
"usage_fields": {
"type": "object",
"title": "Usage Fields"
},
"allocatable_fields": {
"type": "object",
"title": "Allocatable Fields"
},
"backend": {
"type": "string",
"title": "Backend"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"pool",
"platform",
"status",
"usage_fields",
"allocatable_fields",
"backend"
],
"title": "PoolResourcesEntry",
"description": "Entry for resources API results. "
},
"PoolResourcesResponse": {
"properties": {
"pools": {
"items": {
"$ref": "#/components/schemas/PoolResourcesEntry"
},
"type": "array",
"title": "Pools"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"pools"
],
"title": "PoolResourcesResponse",
"description": "Object storing execution cluster node resource information. "
},
"PoolResponse": {
"properties": {
"node_sets": {
"items": {
"$ref": "#/components/schemas/PoolNodeSetResourceUsage"
},
"type": "array",
"title": "Node Sets"
},
"resource_sum": {
"$ref": "#/components/schemas/ResourceUsage"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"node_sets",
"resource_sum"
],
"title": "PoolResponse",
"description": "Object storing pool information. "
},
"PoolStatus": {
"enum": [
"ONLINE",
"OFFLINE",
"MAINTENANCE"
],
"title": "PoolStatus",
"description": "Represents the types of statuses a pool can have. "
},
"PostBackendRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"$ref": "#/components/schemas/BackendConfig"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PostBackendRequest",
"description": "Request body for creating a new backend with history tracking metadata."
},
"ProfileResponse": {
"properties": {
"profile": {
"$ref": "#/components/schemas/UserProfile"
},
"pools": {
"items": {
"type": "string"
},
"type": "array",
"title": "Pools"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"profile",
"pools"
],
"title": "ProfileResponse",
"description": "Object storing workflow name. "
},
"PutBackendTestRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"$ref": "#/components/schemas/BackendTests"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PutBackendTestRequest",
"description": "Request body for updating a test with history tracking metadata."
},
"PutBackendTestsRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"additionalProperties": {
"$ref": "#/components/schemas/BackendTests"
},
"type": "object",
"title": "Configs"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PutBackendTestsRequest",
"description": "Request body for updating a test with history tracking metadata."
},
"PutDatasetRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"$ref": "#/components/schemas/DatasetConfig"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PutDatasetRequest",
"description": "Request body for updating dataset configurations with history tracking metadata."
},
"PutPodTemplateRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"type": "object",
"title": "Configs"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PutPodTemplateRequest",
"description": "Request body for updating a pod template with history tracking metadata."
},
"PutPodTemplatesRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"additionalProperties": {
"type": "object"
},
"type": "object",
"title": "Configs"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PutPodTemplatesRequest",
"description": "Request body for updating pod templates with history tracking metadata."
},
"PutPoolPlatformRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"$ref": "#/components/schemas/Platform"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PutPoolPlatformRequest",
"description": "Request body for updating a platform in a pool with history tracking metadata."
},
"PutPoolRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"$ref": "#/components/schemas/Pool"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PutPoolRequest",
"description": "Request body for updating a pool with history tracking metadata."
},
"PutPoolsRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"additionalProperties": {
"$ref": "#/components/schemas/Pool"
},
"type": "object",
"title": "Configs"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PutPoolsRequest",
"description": "Request body for updating pools with history tracking metadata."
},
"PutResourceValidationRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"items": {
"type": "object"
},
"type": "array",
"title": "Configs"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PutResourceValidationRequest",
"description": "Request body for updating a resource validation with history tracking metadata."
},
"PutResourceValidationsRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs_dict": {
"additionalProperties": {
"items": {
"type": "object"
},
"type": "array"
},
"type": "object",
"title": "Configs Dict"
}
},
"type": "object",
"required": [
"configs_dict"
],
"title": "PutResourceValidationsRequest",
"description": "Request body for updating resource validations with history tracking metadata."
},
"PutRoleRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"$ref": "#/components/schemas/Role"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PutRoleRequest",
"description": "Request body for updating a role with history tracking metadata."
},
"PutRolesRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"items": {
"$ref": "#/components/schemas/Role"
},
"type": "array",
"title": "Configs"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PutRolesRequest",
"description": "Request body for updating a test with history tracking metadata."
},
"PutServiceRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"$ref": "#/components/schemas/ServiceConfig"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PutServiceRequest",
"description": "Request body for updating service configurations with history tracking metadata."
},
"PutWorkflowRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"configs": {
"$ref": "#/components/schemas/WorkflowConfig"
}
},
"type": "object",
"required": [
"configs"
],
"title": "PutWorkflowRequest",
"description": "Request body for updating workflow configurations with history tracking metadata."
},
"RegistryCredential": {
"properties": {
"registry": {
"type": "string",
"title": "Registry",
"description": "The Docker registry URL",
"default": ""
},
"username": {
"type": "string",
"title": "Username",
"description": "The username for the Docker registry",
"default": ""
},
"auth": {
"type": "string",
"format": "password",
"title": "Auth",
"description": "The authentication token for the Docker registry",
"default": "",
"writeOnly": true
}
},
"additionalProperties": false,
"type": "object",
"title": "RegistryCredential",
"description": "Authentication information for a Docker registry. "
},
"RenamePoolPlatformRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"new_name": {
"type": "string",
"title": "New Name"
}
},
"type": "object",
"required": [
"new_name"
],
"title": "RenamePoolPlatformRequest",
"description": "Request body for renaming a platform in a pool with history tracking metadata."
},
"RenamePoolRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"new_name": {
"type": "string",
"title": "New Name"
}
},
"type": "object",
"required": [
"new_name"
],
"title": "RenamePoolRequest",
"description": "Request body for renaming a pool with history tracking metadata."
},
"ResourceAssertion": {
"properties": {
"operator": {
"$ref": "#/components/schemas/OperatorType"
},
"left_operand": {
"type": "string",
"title": "Left Operand"
},
"right_operand": {
"type": "string",
"title": "Right Operand"
},
"assert_message": {
"type": "string",
"title": "Assert Message"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"operator",
"left_operand",
"right_operand",
"assert_message"
],
"title": "ResourceAssertion",
"description": "Class for defining resource restrictions."
},
"ResourceUsage": {
"properties": {
"quota_used": {
"type": "string",
"title": "Quota Used"
},
"quota_free": {
"type": "string",
"title": "Quota Free"
},
"quota_limit": {
"type": "string",
"title": "Quota Limit"
},
"total_usage": {
"type": "string",
"title": "Total Usage"
},
"total_capacity": {
"type": "string",
"title": "Total Capacity"
},
"total_free": {
"type": "string",
"title": "Total Free"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"quota_used",
"quota_free",
"quota_limit",
"total_usage",
"total_capacity",
"total_free"
],
"title": "ResourceUsage",
"description": "Object storing resource usage information. "
},
"ResourcesEntry": {
"properties": {
"hostname": {
"type": "string",
"title": "Hostname"
},
"exposed_fields": {
"type": "object",
"title": "Exposed Fields"
},
"taints": {
"items": {
"type": "object"
},
"type": "array",
"title": "Taints"
},
"usage_fields": {
"type": "object",
"title": "Usage Fields"
},
"conditions": {
"items": {
"type": "string"
},
"type": "array",
"title": "Conditions"
},
"non_workflow_usage_fields": {
"type": "object",
"title": "Non Workflow Usage Fields"
},
"allocatable_fields": {
"type": "object",
"title": "Allocatable Fields"
},
"platform_allocatable_fields": {
"type": "object",
"title": "Platform Allocatable Fields"
},
"platform_available_fields": {
"type": "object",
"title": "Platform Available Fields"
},
"platform_workflow_allocatable_fields": {
"type": "object",
"title": "Platform Workflow Allocatable Fields"
},
"config_fields": {
"type": "object",
"title": "Config Fields"
},
"backend": {
"type": "string",
"title": "Backend"
},
"label_fields": {
"type": "object",
"title": "Label Fields"
},
"pool_platform_labels": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object",
"title": "Pool Platform Labels"
},
"resource_type": {
"$ref": "#/components/schemas/BackendResourceType"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"hostname",
"exposed_fields",
"taints",
"usage_fields",
"non_workflow_usage_fields",
"allocatable_fields",
"backend",
"pool_platform_labels",
"resource_type"
],
"title": "ResourcesEntry",
"description": "Entry for resources API results. "
},
"ResourcesResponse": {
"properties": {
"resources": {
"items": {
"$ref": "#/components/schemas/ResourcesEntry"
},
"type": "array",
"title": "Resources"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"resources"
],
"title": "ResourcesResponse",
"description": "Object storing execution cluster node resource information. "
},
"Role": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description"
},
"policies": {
"items": {
"$ref": "#/components/schemas/RolePolicy"
},
"type": "array",
"title": "Policies"
},
"immutable": {
"type": "boolean",
"title": "Immutable",
"default": false
}
},
"type": "object",
"required": [
"name",
"description",
"policies"
],
"title": "Role",
"description": "Single Role Entry "
},
"RoleAction": {
"properties": {
"base": {
"type": "string",
"pattern": "^(?Phttp)$",
"title": "Base"
},
"path": {
"type": "string",
"pattern": "^(?P(\\*|(!?)/([^:]+)))$",
"title": "Path"
},
"method": {
"type": "string",
"pattern": "^(?P(\\*|([a-zA-Z]+)))$",
"title": "Method"
}
},
"type": "object",
"required": [
"base",
"path",
"method"
],
"title": "RoleAction",
"description": "Single Role Action Entry "
},
"RolePolicy": {
"properties": {
"actions": {
"items": {
"$ref": "#/components/schemas/RoleAction"
},
"type": "array",
"title": "Actions"
}
},
"type": "object",
"required": [
"actions"
],
"title": "RolePolicy",
"description": "Single Role Policy Entry "
},
"RollbackConfigRequest": {
"properties": {
"description": {
"type": "string",
"title": "Description"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"config_type": {
"$ref": "#/components/schemas/src__utils__connectors__postgres__ConfigHistoryType"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Revision",
"description": "Revision to roll back to"
}
},
"type": "object",
"required": [
"config_type",
"revision"
],
"title": "RollbackConfigRequest",
"description": "Request body for config rollback endpoint."
},
"RouterResponse": {
"properties": {
"router_address": {
"type": "string",
"title": "Router Address"
},
"key": {
"type": "string",
"title": "Key"
},
"cookie": {
"type": "string",
"title": "Cookie"
}
},
"type": "object",
"required": [
"router_address",
"key",
"cookie"
],
"title": "RouterResponse",
"description": "Router Information Response. "
},
"RsyncAllowedPath": {
"properties": {
"path": {
"type": "string",
"title": "Path"
},
"writable": {
"type": "boolean",
"title": "Writable",
"default": false
}
},
"type": "object",
"required": [
"path"
],
"title": "RsyncAllowedPath",
"description": "Stores a single allowed path for rsync "
},
"RsyncConfig": {
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"default": false
},
"enable_telemetry": {
"type": "boolean",
"title": "Enable Telemetry",
"default": false
},
"read_bandwidth_limit": {
"type": "integer",
"minimum": 0.0,
"title": "Read Bandwidth Limit",
"description": "User pod's rsync read bandwidth limit in bytes per second, zero means no limit",
"default": 2621440
},
"write_bandwidth_limit": {
"type": "integer",
"minimum": 0.0,
"title": "Write Bandwidth Limit",
"description": "User pod's rsync write bandwidth limit in bytes per second, zero means no limit",
"default": 2621440
},
"allowed_paths": {
"additionalProperties": {
"$ref": "#/components/schemas/RsyncAllowedPath"
},
"type": "object",
"title": "Allowed Paths",
"default": {}
},
"daemon_debounce_delay": {
"type": "number",
"exclusiveMinimum": 0.0,
"title": "Daemon Debounce Delay",
"description": "Daemon debounce delay for rsync in seconds",
"default": 30.0
},
"daemon_poll_interval": {
"type": "number",
"exclusiveMinimum": 0.0,
"title": "Daemon Poll Interval",
"description": "Daemon poll interval for rsync in seconds",
"default": 120.0
},
"daemon_reconcile_interval": {
"type": "number",
"exclusiveMinimum": 0.0,
"title": "Daemon Reconcile Interval",
"description": "Daemon reconcile interval for rsync in seconds",
"default": 60.0
},
"client_upload_rate_limit": {
"type": "integer",
"minimum": 0.0,
"title": "Client Upload Rate Limit",
"description": "Client upload rate limit for rsync in bytes per second, zero means no limit",
"default": 2097152
}
},
"type": "object",
"title": "RsyncConfig",
"description": "Stores all configs for rsync "
},
"SMTPConfig": {
"properties": {
"host": {
"type": "string",
"title": "Host",
"default": ""
},
"sender": {
"type": "string",
"title": "Sender",
"default": ""
},
"password": {
"type": "string",
"format": "password",
"title": "Password",
"default": "",
"writeOnly": true
}
},
"type": "object",
"title": "SMTPConfig"
},
"ServiceConfig": {
"properties": {
"service_base_url": {
"type": "string",
"title": "Service Base Url",
"default": ""
},
"service_auth": {
"allOf": [
{
"$ref": "#/components/schemas/AuthenticationConfig"
}
],
"title": "Service Auth",
"default": {}
},
"cli_config": {
"allOf": [
{
"$ref": "#/components/schemas/CliConfig"
}
],
"title": "Cli Config",
"default": {}
},
"max_pod_restart_limit": {
"type": "string",
"title": "Max Pod Restart Limit",
"default": "30m"
},
"agent_queue_size": {
"type": "integer",
"title": "Agent Queue Size",
"default": 1024
}
},
"type": "object",
"title": "ServiceConfig",
"description": "Stores any configs OSMO Admins control "
},
"StaticDataCredential": {
"properties": {
"endpoint": {
"type": "string",
"title": "Endpoint",
"description": "The endpoint URL for the data service"
},
"region": {
"type": "string",
"title": "Region",
"description": "The region for the data service"
},
"access_key_id": {
"type": "string",
"title": "Access Key Id",
"description": "The authentication key for a data backend"
},
"access_key": {
"type": "string",
"format": "password",
"title": "Access Key",
"description": "The encrypted authentication secret for a data backend",
"writeOnly": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"endpoint",
"access_key_id",
"access_key"
],
"title": "StaticDataCredential",
"description": "Static data credentials (i.e. credentials with access_key_id and access_key) for a data backend."
},
"SubmitResponse": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"overview": {
"type": "string",
"title": "Overview"
},
"logs": {
"type": "string",
"title": "Logs"
},
"spec": {
"type": "string",
"title": "Spec"
},
"dashboard_url": {
"type": "string",
"title": "Dashboard Url"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"title": "SubmitResponse",
"description": "Object storing workflow name, logs, and spec after submission. "
},
"TaskEntry": {
"properties": {
"workflow_id": {
"type": "string",
"title": "Workflow Id"
},
"task_name": {
"type": "string",
"title": "Task Name"
},
"node": {
"type": "string",
"title": "Node"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time"
},
"end_time": {
"type": "string",
"format": "date-time",
"title": "End Time"
},
"status": {
"$ref": "#/components/schemas/TaskGroupStatus"
},
"storage": {
"type": "integer",
"title": "Storage"
},
"cpu": {
"type": "integer",
"title": "Cpu"
},
"memory": {
"type": "integer",
"title": "Memory"
},
"gpu": {
"type": "integer",
"title": "Gpu"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"workflow_id",
"task_name",
"status",
"storage",
"cpu",
"memory",
"gpu"
],
"title": "TaskEntry",
"description": "Entry for task GET API result. "
},
"TaskGroupStatus": {
"enum": [
"SUBMITTING",
"WAITING",
"PROCESSING",
"SCHEDULING",
"INITIALIZING",
"RUNNING",
"COMPLETED",
"RESCHEDULED",
"FAILED",
"FAILED_CANCELED",
"FAILED_SERVER_ERROR",
"FAILED_BACKEND_ERROR",
"FAILED_EXEC_TIMEOUT",
"FAILED_QUEUE_TIMEOUT",
"FAILED_IMAGE_PULL",
"FAILED_UPSTREAM",
"FAILED_EVICTED",
"FAILED_START_ERROR",
"FAILED_START_TIMEOUT",
"FAILED_PREEMPTED"
],
"title": "TaskGroupStatus",
"description": "Represents the status of a task group "
},
"TaskQueryResponse": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"retry_id": {
"type": "integer",
"title": "Retry Id"
},
"status": {
"$ref": "#/components/schemas/TaskGroupStatus"
},
"failure_message": {
"type": "string",
"title": "Failure Message"
},
"exit_code": {
"type": "integer",
"title": "Exit Code"
},
"logs": {
"type": "string",
"title": "Logs"
},
"error_logs": {
"type": "string",
"title": "Error Logs"
},
"processing_start_time": {
"type": "string",
"format": "date-time",
"title": "Processing Start Time"
},
"scheduling_start_time": {
"type": "string",
"format": "date-time",
"title": "Scheduling Start Time"
},
"initializing_start_time": {
"type": "string",
"format": "date-time",
"title": "Initializing Start Time"
},
"events": {
"type": "string",
"title": "Events"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time"
},
"end_time": {
"type": "string",
"format": "date-time",
"title": "End Time"
},
"input_download_start_time": {
"type": "string",
"format": "date-time",
"title": "Input Download Start Time"
},
"input_download_end_time": {
"type": "string",
"format": "date-time",
"title": "Input Download End Time"
},
"output_upload_start_time": {
"type": "string",
"format": "date-time",
"title": "Output Upload Start Time"
},
"dashboard_url": {
"type": "string",
"title": "Dashboard Url"
},
"pod_name": {
"type": "string",
"title": "Pod Name"
},
"pod_ip": {
"type": "string",
"title": "Pod Ip"
},
"task_uuid": {
"type": "string",
"title": "Task Uuid"
},
"node_name": {
"type": "string",
"title": "Node Name"
},
"lead": {
"type": "boolean",
"title": "Lead",
"default": false
}
},
"type": "object",
"required": [
"name",
"retry_id",
"status",
"logs",
"events",
"pod_name",
"task_uuid"
],
"title": "TaskQueryResponse",
"description": "Represents the queryed group information. "
},
"TemplateSpec": {
"properties": {
"file": {
"type": "string",
"title": "File"
},
"set_variables": {
"items": {
"type": "string"
},
"type": "array",
"title": "Set Variables",
"default": []
},
"set_string_variables": {
"items": {
"type": "string"
},
"type": "array",
"title": "Set String Variables",
"default": []
},
"uploaded_templated_spec": {
"type": "string",
"title": "Uploaded Templated Spec"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"file"
],
"title": "TemplateSpec",
"description": "Template Spec. "
},
"Toleration": {
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"operator": {
"type": "string",
"title": "Operator",
"default": "Equal"
},
"value": {
"type": "string",
"title": "Value"
},
"effect": {
"type": "string",
"title": "Effect"
}
},
"type": "object",
"required": [
"key"
],
"title": "Toleration",
"description": "Single Toleration Entry "
},
"UpdateConfigTagsRequest": {
"properties": {
"set_tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Set Tags",
"description": "Tags to add to the config"
},
"delete_tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Delete Tags",
"description": "Tags to remove from the config"
}
},
"type": "object",
"title": "UpdateConfigTagsRequest",
"description": "Request body for updating config tags endpoint."
},
"UserCredential": {
"properties": {
"credential": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Credential",
"description": "The credential dictionary that contains authentication information"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"credential"
],
"title": "UserCredential",
"description": "Generic authentication information. "
},
"UserDataCredential": {
"properties": {
"endpoint": {
"type": "string",
"title": "Endpoint",
"description": "The endpoint URL for the data service"
},
"region": {
"type": "string",
"title": "Region",
"description": "The region for the data service"
},
"access_key_id": {
"type": "string",
"title": "Access Key Id",
"description": "The authentication key for a data backend"
},
"access_key": {
"type": "string",
"title": "Access Key",
"description": "The authentication secret for a data backend"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"endpoint",
"access_key_id",
"access_key"
],
"title": "UserDataCredential",
"description": "Authentication information for a data service. "
},
"UserProfile": {
"properties": {
"username": {
"type": "string",
"title": "Username"
},
"email_notification": {
"type": "boolean",
"title": "Email Notification"
},
"slack_notification": {
"type": "boolean",
"title": "Slack Notification"
},
"bucket": {
"type": "string",
"title": "Bucket"
},
"pool": {
"type": "string",
"title": "Pool"
}
},
"type": "object",
"title": "UserProfile",
"description": "Provides all User Profile Information "
},
"UserRegistryCredential": {
"properties": {
"registry": {
"type": "string",
"title": "Registry",
"description": "The Docker registry URL",
"default": ""
},
"username": {
"type": "string",
"title": "Username",
"description": "The username for the Docker registry",
"default": ""
},
"auth": {
"type": "string",
"title": "Auth",
"description": "The authentication token for the Docker registry"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"auth"
],
"title": "UserRegistryCredential",
"description": "Authentication information for a Docker registry. "
},
"UserWorkflowLimitConfig": {
"properties": {
"max_num_workflows": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Max Num Workflows"
},
"max_num_tasks": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Max Num Tasks"
},
"jinja_sandbox_workers": {
"type": "integer",
"title": "Jinja Sandbox Workers",
"default": 2
},
"jinja_sandbox_max_time": {
"type": "number",
"title": "Jinja Sandbox Max Time",
"default": 0.5
},
"jinja_sandbox_memory_limit": {
"type": "integer",
"title": "Jinja Sandbox Memory Limit",
"default": 104857600
}
},
"type": "object",
"title": "UserWorkflowLimitConfig",
"description": "Stores workflow limits per user. Default is None, which means no limit.\nIf a limit is set, it must be greater than 0."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"VerbosePoolConfig": {
"properties": {
"pools": {
"additionalProperties": {
"$ref": "#/components/schemas/Pool"
},
"type": "object",
"title": "Pools",
"default": {}
}
},
"type": "object",
"title": "VerbosePoolConfig",
"description": "Stores verbose pool configs."
},
"WorkflowConfig": {
"properties": {
"workflow_data": {
"allOf": [
{
"$ref": "#/components/schemas/DataConfig"
}
],
"title": "Workflow Data",
"default": {
"base_url": "",
"websocket_timeout": 1440,
"data_timeout": 10,
"download_type": "download"
}
},
"workflow_log": {
"allOf": [
{
"$ref": "#/components/schemas/LogConfig"
}
],
"title": "Workflow Log",
"default": {}
},
"workflow_app": {
"allOf": [
{
"$ref": "#/components/schemas/LogConfig"
}
],
"title": "Workflow App",
"default": {}
},
"workflow_info": {
"allOf": [
{
"$ref": "#/components/schemas/WorkflowInfo"
}
],
"title": "Workflow Info",
"default": {
"tags": [],
"max_name_length": 64
}
},
"backend_images": {
"allOf": [
{
"$ref": "#/components/schemas/OsmoImageConfig"
}
],
"title": "Backend Images",
"default": {
"init": "",
"client": "",
"credential": {
"registry": "",
"username": "",
"auth": ""
}
}
},
"workflow_alerts": {
"allOf": [
{
"$ref": "#/components/schemas/NotificationConfig"
}
],
"title": "Workflow Alerts",
"default": {
"slack_token": "",
"smtp_settings": {
"host": "",
"sender": "",
"password": ""
}
}
},
"credential_config": {
"allOf": [
{
"$ref": "#/components/schemas/CredentialConfig"
}
],
"title": "Credential Config",
"default": {
"disable_registry_validation": [],
"disable_data_validation": []
}
},
"user_workflow_limits": {
"allOf": [
{
"$ref": "#/components/schemas/UserWorkflowLimitConfig"
}
],
"title": "User Workflow Limits",
"default": {
"jinja_sandbox_workers": 2,
"jinja_sandbox_max_time": 0.5,
"jinja_sandbox_memory_limit": 104857600
}
},
"plugins_config": {
"allOf": [
{
"$ref": "#/components/schemas/PluginsConfig"
}
],
"title": "Plugins Config",
"default": {
"rsync": {
"enabled": false,
"enable_telemetry": false,
"read_bandwidth_limit": 2621440,
"write_bandwidth_limit": 2621440,
"allowed_paths": {},
"daemon_debounce_delay": 30.0,
"daemon_poll_interval": 120.0,
"daemon_reconcile_interval": 60.0,
"client_upload_rate_limit": 2097152
}
}
},
"max_num_tasks": {
"type": "integer",
"title": "Max Num Tasks",
"default": 20
},
"max_num_ports_per_task": {
"type": "integer",
"title": "Max Num Ports Per Task",
"default": 30
},
"max_retry_per_task": {
"type": "integer",
"title": "Max Retry Per Task",
"default": 0
},
"max_retry_per_job": {
"type": "integer",
"title": "Max Retry Per Job",
"default": 5
},
"default_schedule_timeout": {
"type": "integer",
"title": "Default Schedule Timeout",
"default": 30
},
"default_exec_timeout": {
"type": "string",
"title": "Default Exec Timeout",
"default": "60d"
},
"default_queue_timeout": {
"type": "string",
"title": "Default Queue Timeout",
"default": "60d"
},
"max_exec_timeout": {
"type": "string",
"title": "Max Exec Timeout",
"default": "60d"
},
"max_queue_timeout": {
"type": "string",
"title": "Max Queue Timeout",
"default": "60d"
},
"force_cleanup_delay": {
"type": "string",
"title": "Force Cleanup Delay",
"default": "1h"
},
"max_log_lines": {
"type": "integer",
"title": "Max Log Lines",
"default": 10000
},
"max_task_log_lines": {
"type": "integer",
"title": "Max Task Log Lines",
"default": 1000
},
"max_error_log_lines": {
"type": "integer",
"title": "Max Error Log Lines",
"default": 100
},
"max_event_log_lines": {
"type": "integer",
"title": "Max Event Log Lines",
"default": 100
},
"task_heartbeat_frequency": {
"type": "string",
"title": "Task Heartbeat Frequency",
"default": "10m"
}
},
"type": "object",
"title": "WorkflowConfig",
"description": "Stores any workflow configs External Admins control "
},
"WorkflowInfo": {
"properties": {
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"default": []
},
"max_name_length": {
"type": "integer",
"title": "Max Name Length",
"default": 64
}
},
"type": "object",
"title": "WorkflowInfo",
"description": "Config for workflow storage info. "
},
"WorkflowPlugins": {
"properties": {
"rsync": {
"type": "boolean",
"title": "Rsync",
"default": false
}
},
"type": "object",
"title": "WorkflowPlugins",
"description": "Represents the state of plugins in a workflow upon submission. "
},
"WorkflowPriority": {
"type": "string",
"enum": [
"HIGH",
"NORMAL",
"LOW"
],
"title": "WorkflowPriority",
"description": "Scheduling priority for workflows"
},
"WorkflowQueryResponse": {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"uuid": {
"type": "string",
"title": "Uuid"
},
"submitted_by": {
"type": "string",
"title": "Submitted By"
},
"cancelled_by": {
"type": "string",
"title": "Cancelled By"
},
"spec": {
"type": "string",
"title": "Spec"
},
"template_spec": {
"type": "string",
"title": "Template Spec"
},
"logs": {
"type": "string",
"title": "Logs"
},
"events": {
"type": "string",
"title": "Events"
},
"overview": {
"type": "string",
"title": "Overview"
},
"parent_name": {
"type": "string",
"title": "Parent Name"
},
"parent_job_id": {
"type": "integer",
"title": "Parent Job Id"
},
"dashboard_url": {
"type": "string",
"title": "Dashboard Url"
},
"grafana_url": {
"type": "string",
"title": "Grafana Url"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags",
"default": []
},
"submit_time": {
"type": "string",
"format": "date-time",
"title": "Submit Time"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time"
},
"end_time": {
"type": "string",
"format": "date-time",
"title": "End Time"
},
"exec_timeout": {
"type": "number",
"format": "time-delta",
"title": "Exec Timeout"
},
"queue_timeout": {
"type": "number",
"format": "time-delta",
"title": "Queue Timeout"
},
"duration": {
"type": "number",
"format": "time-delta",
"title": "Duration"
},
"queued_time": {
"type": "number",
"format": "time-delta",
"title": "Queued Time"
},
"status": {
"$ref": "#/components/schemas/WorkflowStatus"
},
"outputs": {
"type": "string",
"title": "Outputs",
"default": ""
},
"groups": {
"items": {
"$ref": "#/components/schemas/GroupQueryResponse"
},
"type": "array",
"title": "Groups"
},
"pool": {
"type": "string",
"title": "Pool"
},
"backend": {
"type": "string",
"title": "Backend"
},
"app_owner": {
"type": "string",
"title": "App Owner"
},
"app_name": {
"type": "string",
"title": "App Name"
},
"app_version": {
"type": "integer",
"title": "App Version"
},
"plugins": {
"$ref": "#/components/schemas/WorkflowPlugins"
},
"priority": {
"type": "string",
"title": "Priority"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"uuid",
"submitted_by",
"spec",
"template_spec",
"logs",
"events",
"overview",
"submit_time",
"queued_time",
"status",
"groups",
"plugins",
"priority"
],
"title": "WorkflowQueryResponse",
"description": "Represents the queryed workflow information. "
},
"WorkflowStatus": {
"type": "string",
"enum": [
"PENDING",
"RUNNING",
"WAITING",
"COMPLETED",
"FAILED",
"FAILED_SUBMISSION",
"FAILED_SERVER_ERROR",
"FAILED_EXEC_TIMEOUT",
"FAILED_QUEUE_TIMEOUT",
"FAILED_CANCELED",
"FAILED_BACKEND_ERROR",
"FAILED_IMAGE_PULL",
"FAILED_EVICTED",
"FAILED_START_ERROR",
"FAILED_START_TIMEOUT",
"FAILED_PREEMPTED"
],
"title": "WorkflowStatus",
"description": "Represents the status of a workflow. "
},
"src__lib__utils__config_history__ConfigHistoryType": {
"enum": [
"SERVICE",
"WORKFLOW",
"DATASET",
"BACKEND",
"POOL",
"POD_TEMPLATE",
"RESOURCE_VALIDATION",
"BACKEND_TEST",
"ROLE"
],
"title": "ConfigHistoryType",
"description": "Type of configs supported by config history "
},
"src__service__core__app__objects__ListEntry": {
"properties": {
"uuid": {
"type": "string",
"title": "Uuid"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description"
},
"created_date": {
"type": "string",
"format": "date-time",
"title": "Created Date"
},
"owner": {
"type": "string",
"title": "Owner"
},
"latest_version": {
"type": "string",
"title": "Latest Version"
}
},
"type": "object",
"required": [
"uuid",
"name",
"description",
"created_date",
"owner",
"latest_version"
],
"title": "ListEntry"
},
"src__service__core__app__objects__ListResponse": {
"properties": {
"apps": {
"items": {
"$ref": "#/components/schemas/src__service__core__app__objects__ListEntry"
},
"type": "array",
"title": "Apps"
},
"more_entries": {
"type": "boolean",
"title": "More Entries"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"apps",
"more_entries"
],
"title": "ListResponse"
},
"src__service__core__workflow__objects__ListEntry": {
"properties": {
"user": {
"type": "string",
"title": "User"
},
"name": {
"type": "string",
"title": "Name"
},
"workflow_uuid": {
"type": "string",
"title": "Workflow Uuid"
},
"submit_time": {
"type": "string",
"format": "date-time",
"title": "Submit Time"
},
"start_time": {
"type": "string",
"format": "date-time",
"title": "Start Time"
},
"end_time": {
"type": "string",
"format": "date-time",
"title": "End Time"
},
"queued_time": {
"type": "number",
"format": "time-delta",
"title": "Queued Time"
},
"duration": {
"type": "number",
"format": "time-delta",
"title": "Duration"
},
"status": {
"$ref": "#/components/schemas/WorkflowStatus"
},
"overview": {
"type": "string",
"title": "Overview"
},
"logs": {
"type": "string",
"title": "Logs"
},
"error_logs": {
"type": "string",
"title": "Error Logs"
},
"grafana_url": {
"type": "string",
"title": "Grafana Url"
},
"dashboard_url": {
"type": "string",
"title": "Dashboard Url"
},
"pool": {
"type": "string",
"title": "Pool"
},
"app_owner": {
"type": "string",
"title": "App Owner"
},
"app_name": {
"type": "string",
"title": "App Name"
},
"app_version": {
"type": "integer",
"title": "App Version"
},
"priority": {
"type": "string",
"title": "Priority"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"user",
"name",
"workflow_uuid",
"submit_time",
"queued_time",
"status",
"overview",
"logs",
"priority"
],
"title": "ListEntry",
"description": "Entry for list API results. "
},
"src__service__core__workflow__objects__ListResponse": {
"properties": {
"workflows": {
"items": {
"$ref": "#/components/schemas/src__service__core__workflow__objects__ListEntry"
},
"type": "array",
"title": "Workflows"
},
"more_entries": {
"type": "boolean",
"title": "More Entries"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"workflows",
"more_entries"
],
"title": "ListResponse"
},
"src__utils__connectors__postgres__ConfigHistoryType": {
"enum": [
"SERVICE",
"WORKFLOW",
"DATASET",
"BACKEND",
"POOL",
"POD_TEMPLATE",
"RESOURCE_VALIDATION",
"BACKEND_TEST",
"ROLE"
],
"title": "ConfigHistoryType",
"description": "Type of configs supported by config history "
}
}
}
}