3081 lines
79 KiB
YAML
3081 lines
79 KiB
YAML
openapi: 3.1.0
|
|
info:
|
|
title: platform-api service
|
|
version: 0.1.0
|
|
paths:
|
|
/:
|
|
get:
|
|
summary: Root
|
|
operationId: root__get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
title: Response Root Get
|
|
/health/live:
|
|
get:
|
|
summary: Live
|
|
operationId: live_health_live_get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
title: Response Live Health Live Get
|
|
/api/v1/health:
|
|
get:
|
|
summary: Public Health
|
|
operationId: public_health_api_v1_health_get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
title: Response Public Health Api V1 Health Get
|
|
/health/ready:
|
|
get:
|
|
summary: Ready
|
|
operationId: ready_health_ready_get
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
additionalProperties: true
|
|
type: object
|
|
title: Response Ready Health Ready Get
|
|
/api/v1/files/{storage_object_id}/lock:
|
|
post:
|
|
tags:
|
|
- file-locks
|
|
summary: Acquire File Lock
|
|
operationId: acquire_file_lock_api_v1_files__storage_object_id__lock_post
|
|
parameters:
|
|
- name: storage_object_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Storage Object Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'201':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema: {}
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/file-locks/{edit_session_id}/heartbeat:
|
|
post:
|
|
tags:
|
|
- file-locks
|
|
summary: Heartbeat File Lock
|
|
operationId: heartbeat_file_lock_api_v1_file_locks__edit_session_id__heartbeat_post
|
|
parameters:
|
|
- name: edit_session_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Edit Session Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FileLockTokenRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema: {}
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/file-locks/{edit_session_id}:
|
|
delete:
|
|
tags:
|
|
- file-locks
|
|
summary: Release File Lock
|
|
operationId: release_file_lock_api_v1_file_locks__edit_session_id__delete
|
|
parameters:
|
|
- name: edit_session_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Edit Session Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FileLockTokenRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema: {}
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/jupyter/access-tickets:
|
|
post:
|
|
tags:
|
|
- jupyter
|
|
summary: Create Jupyter Access Ticket
|
|
operationId: create_jupyter_access_ticket_api_v1_jupyter_access_tickets_post
|
|
parameters:
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CreateJupyterAccessTicketRequest'
|
|
responses:
|
|
'201':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema: {}
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/data-resources/uploads:
|
|
post:
|
|
tags:
|
|
- data-resources
|
|
summary: Create Resource Upload
|
|
operationId: create_resource_upload_api_v1_data_resources_uploads_post
|
|
parameters:
|
|
- name: Idempotency-Key
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
minLength: 8
|
|
maxLength: 128
|
|
title: Idempotency-Key
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CreateResourceUploadRequest'
|
|
responses:
|
|
'201':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Create Resource Upload Api V1 Data Resources Uploads Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/data-resources/uploads/{upload_id}/complete:
|
|
post:
|
|
tags:
|
|
- data-resources
|
|
summary: Complete Resource Upload
|
|
operationId: complete_resource_upload_api_v1_data_resources_uploads__upload_id__complete_post
|
|
parameters:
|
|
- name: upload_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Upload Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CompleteResourceUploadRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Complete Resource Upload Api V1 Data Resources Uploads Upload Id Complete
|
|
Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/data-resources:
|
|
get:
|
|
tags:
|
|
- data-resources
|
|
summary: List Resources
|
|
operationId: list_resources_api_v1_data_resources_get
|
|
parameters:
|
|
- name: visibility
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Visibility
|
|
- name: keyword
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 100
|
|
- type: 'null'
|
|
title: Keyword
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response List Resources Api V1 Data Resources Get
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/data-resources/{resource_id}:
|
|
get:
|
|
tags:
|
|
- data-resources
|
|
summary: Get Resource
|
|
operationId: get_resource_api_v1_data_resources__resource_id__get
|
|
parameters:
|
|
- name: resource_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Resource Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Get Resource Api V1 Data Resources Resource Id Get
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
delete:
|
|
tags:
|
|
- data-resources
|
|
summary: Delete Resource
|
|
operationId: delete_resource_api_v1_data_resources__resource_id__delete
|
|
parameters:
|
|
- name: resource_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Resource Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Delete Resource Api V1 Data Resources Resource Id Delete
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/data-resources/{resource_id}/download-url:
|
|
post:
|
|
tags:
|
|
- data-resources
|
|
summary: Resource Download Url
|
|
operationId: resource_download_url_api_v1_data_resources__resource_id__download_url_post
|
|
parameters:
|
|
- name: resource_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Resource Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DownloadUrlRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Resource Download Url Api V1 Data Resources Resource Id Download Url
|
|
Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/schedules/{schedule_id}/run:
|
|
post:
|
|
tags:
|
|
- schedule-runs
|
|
summary: Run Schedule Now
|
|
operationId: run_schedule_now_api_v1_schedules__schedule_id__run_post
|
|
parameters:
|
|
- name: schedule_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Schedule Id
|
|
- name: Idempotency-Key
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Idempotency-Key
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
anyOf:
|
|
- $ref: '#/components/schemas/RunScheduleRequest'
|
|
- type: 'null'
|
|
title: Payload
|
|
responses:
|
|
'202':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Run Schedule Now Api V1 Schedules Schedule Id Run Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/schedule-runs:
|
|
get:
|
|
tags:
|
|
- schedule-runs
|
|
summary: List Schedule Runs
|
|
operationId: list_schedule_runs_api_v1_schedule_runs_get
|
|
parameters:
|
|
- name: schedule_id
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: Schedule Id
|
|
- name: status
|
|
in: query
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- enum:
|
|
- queued
|
|
- running
|
|
- succeeded
|
|
- failed
|
|
- cancelled
|
|
- timed_out
|
|
type: string
|
|
- type: 'null'
|
|
title: Status
|
|
- name: limit
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
maximum: 200
|
|
minimum: 1
|
|
default: 50
|
|
title: Limit
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response List Schedule Runs Api V1 Schedule Runs Get
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/schedule-runs/{run_id}:
|
|
get:
|
|
tags:
|
|
- schedule-runs
|
|
summary: Get Schedule Run
|
|
operationId: get_schedule_run_api_v1_schedule_runs__run_id__get
|
|
parameters:
|
|
- name: run_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Run Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Get Schedule Run Api V1 Schedule Runs Run Id Get
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/cron/preview:
|
|
post:
|
|
tags:
|
|
- schedules
|
|
summary: Preview Cron
|
|
operationId: preview_cron_api_v1_cron_preview_post
|
|
parameters:
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CronPreviewRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Preview Cron Api V1 Cron Preview Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/schedule-artifacts:
|
|
get:
|
|
tags:
|
|
- schedules
|
|
summary: List Schedule Artifacts
|
|
operationId: list_schedule_artifacts_api_v1_schedule_artifacts_get
|
|
parameters:
|
|
- name: limit
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
maximum: 500
|
|
minimum: 1
|
|
default: 100
|
|
title: Limit
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response List Schedule Artifacts Api V1 Schedule Artifacts Get
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/schedules:
|
|
get:
|
|
tags:
|
|
- schedules
|
|
summary: List Schedules
|
|
operationId: list_schedules_api_v1_schedules_get
|
|
parameters:
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response List Schedules Api V1 Schedules Get
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
post:
|
|
tags:
|
|
- schedules
|
|
summary: Create Schedule
|
|
operationId: create_schedule_api_v1_schedules_post
|
|
parameters:
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CreateScheduleRequest'
|
|
responses:
|
|
'201':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Create Schedule Api V1 Schedules Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/schedules/{schedule_id}:
|
|
get:
|
|
tags:
|
|
- schedules
|
|
summary: Get Schedule
|
|
operationId: get_schedule_api_v1_schedules__schedule_id__get
|
|
parameters:
|
|
- name: schedule_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Schedule Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Get Schedule Api V1 Schedules Schedule Id Get
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
patch:
|
|
tags:
|
|
- schedules
|
|
summary: Update Schedule
|
|
operationId: update_schedule_api_v1_schedules__schedule_id__patch
|
|
parameters:
|
|
- name: schedule_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Schedule Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UpdateScheduleRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Update Schedule Api V1 Schedules Schedule Id Patch
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
put:
|
|
tags:
|
|
- schedules
|
|
summary: Update Schedule
|
|
operationId: update_schedule_api_v1_schedules__schedule_id__put
|
|
parameters:
|
|
- name: schedule_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Schedule Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UpdateScheduleRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Update Schedule Api V1 Schedules Schedule Id Put
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
delete:
|
|
tags:
|
|
- schedules
|
|
summary: Delete Schedule
|
|
operationId: delete_schedule_api_v1_schedules__schedule_id__delete
|
|
parameters:
|
|
- name: schedule_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Schedule Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WorkflowVersionRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Delete Schedule Api V1 Schedules Schedule Id Delete
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/schedules/{schedule_id}/nodes:
|
|
post:
|
|
tags:
|
|
- schedules
|
|
summary: Create Schedule Node
|
|
operationId: create_schedule_node_api_v1_schedules__schedule_id__nodes_post
|
|
parameters:
|
|
- name: schedule_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Schedule Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CreateScheduleNodeRequest'
|
|
responses:
|
|
'201':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Create Schedule Node Api V1 Schedules Schedule Id Nodes Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/schedules/{schedule_id}/nodes/{node_id}:
|
|
put:
|
|
tags:
|
|
- schedules
|
|
summary: Update Schedule Node
|
|
operationId: update_schedule_node_api_v1_schedules__schedule_id__nodes__node_id__put
|
|
parameters:
|
|
- name: schedule_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Schedule Id
|
|
- name: node_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Node Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UpdateScheduleNodeRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Update Schedule Node Api V1 Schedules Schedule Id Nodes Node Id Put
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
delete:
|
|
tags:
|
|
- schedules
|
|
summary: Delete Schedule Node
|
|
operationId: delete_schedule_node_api_v1_schedules__schedule_id__nodes__node_id__delete
|
|
parameters:
|
|
- name: schedule_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Schedule Id
|
|
- name: node_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Node Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WorkflowVersionRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Delete Schedule Node Api V1 Schedules Schedule Id Nodes Node Id Delete
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/schedules/{schedule_id}/edges:
|
|
post:
|
|
tags:
|
|
- schedules
|
|
summary: Create Schedule Edge
|
|
operationId: create_schedule_edge_api_v1_schedules__schedule_id__edges_post
|
|
parameters:
|
|
- name: schedule_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Schedule Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CreateScheduleEdgeRequest'
|
|
responses:
|
|
'201':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Create Schedule Edge Api V1 Schedules Schedule Id Edges Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/schedules/{schedule_id}/edges/{edge_id}:
|
|
put:
|
|
tags:
|
|
- schedules
|
|
summary: Update Schedule Edge
|
|
operationId: update_schedule_edge_api_v1_schedules__schedule_id__edges__edge_id__put
|
|
parameters:
|
|
- name: schedule_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Schedule Id
|
|
- name: edge_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Edge Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UpdateScheduleEdgeRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Update Schedule Edge Api V1 Schedules Schedule Id Edges Edge Id Put
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
delete:
|
|
tags:
|
|
- schedules
|
|
summary: Delete Schedule Edge
|
|
operationId: delete_schedule_edge_api_v1_schedules__schedule_id__edges__edge_id__delete
|
|
parameters:
|
|
- name: schedule_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Schedule Id
|
|
- name: edge_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Edge Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/WorkflowVersionRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Delete Schedule Edge Api V1 Schedules Schedule Id Edges Edge Id Delete
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/schedules/{schedule_id}/validate:
|
|
post:
|
|
tags:
|
|
- schedules
|
|
summary: Validate Schedule
|
|
operationId: validate_schedule_api_v1_schedules__schedule_id__validate_post
|
|
parameters:
|
|
- name: schedule_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Schedule Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Validate Schedule Api V1 Schedules Schedule Id Validate Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/scripts:
|
|
post:
|
|
tags:
|
|
- scripts
|
|
summary: Create Script
|
|
operationId: create_script_api_v1_scripts_post
|
|
parameters:
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CreateScriptRequest'
|
|
responses:
|
|
'201':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Create Script Api V1 Scripts Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
get:
|
|
tags:
|
|
- scripts
|
|
summary: List Scripts
|
|
operationId: list_scripts_api_v1_scripts_get
|
|
parameters:
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response List Scripts Api V1 Scripts Get
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/scripts/upload:
|
|
post:
|
|
tags:
|
|
- scripts
|
|
summary: Upload Script
|
|
operationId: upload_script_api_v1_scripts_upload_post
|
|
parameters:
|
|
- name: file_name
|
|
in: query
|
|
required: true
|
|
schema:
|
|
type: string
|
|
minLength: 1
|
|
maxLength: 255
|
|
title: File Name
|
|
- name: parent_path
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: string
|
|
maxLength: 1024
|
|
default: ''
|
|
title: Parent Path
|
|
- name: visibility
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: string
|
|
pattern: ^(private|workspace|public)$
|
|
default: workspace
|
|
title: Visibility
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'201':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Upload Script Api V1 Scripts Upload Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/workspace-tree:
|
|
get:
|
|
tags:
|
|
- scripts
|
|
summary: Get Workspace Tree
|
|
operationId: get_workspace_tree_api_v1_workspace_tree_get
|
|
parameters:
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Get Workspace Tree Api V1 Workspace Tree Get
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/workspace-directories:
|
|
post:
|
|
tags:
|
|
- scripts
|
|
summary: Create Workspace Directory
|
|
operationId: create_workspace_directory_api_v1_workspace_directories_post
|
|
parameters:
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/CreateWorkspaceDirectoryRequest'
|
|
responses:
|
|
'201':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Create Workspace Directory Api V1 Workspace Directories Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
delete:
|
|
tags:
|
|
- scripts
|
|
summary: Delete Workspace Directory
|
|
operationId: delete_workspace_directory_api_v1_workspace_directories_delete
|
|
parameters:
|
|
- name: path
|
|
in: query
|
|
required: true
|
|
schema:
|
|
type: string
|
|
minLength: 1
|
|
maxLength: 1024
|
|
title: Path
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Delete Workspace Directory Api V1 Workspace Directories Delete
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/scripts/{script_id}:
|
|
get:
|
|
tags:
|
|
- scripts
|
|
summary: Get Script
|
|
operationId: get_script_api_v1_scripts__script_id__get
|
|
parameters:
|
|
- name: script_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Script Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Get Script Api V1 Scripts Script Id Get
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
put:
|
|
tags:
|
|
- scripts
|
|
summary: Update Script
|
|
operationId: update_script_api_v1_scripts__script_id__put
|
|
parameters:
|
|
- name: script_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Script Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/UpdateScriptRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Update Script Api V1 Scripts Script Id Put
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
delete:
|
|
tags:
|
|
- scripts
|
|
summary: Delete Script
|
|
operationId: delete_script_api_v1_scripts__script_id__delete
|
|
parameters:
|
|
- name: script_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Script Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Delete Script Api V1 Scripts Script Id Delete
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/scripts/{script_id}/versions:
|
|
post:
|
|
tags:
|
|
- scripts
|
|
summary: Publish Version
|
|
operationId: publish_version_api_v1_scripts__script_id__versions_post
|
|
parameters:
|
|
- name: script_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Script Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PublishVersionRequest'
|
|
responses:
|
|
'201':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Publish Version Api V1 Scripts Script Id Versions Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
get:
|
|
tags:
|
|
- scripts
|
|
summary: List Versions
|
|
operationId: list_versions_api_v1_scripts__script_id__versions_get
|
|
parameters:
|
|
- name: script_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Script Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response List Versions Api V1 Scripts Script Id Versions Get
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/versions/{versions_id}:
|
|
get:
|
|
tags:
|
|
- scripts
|
|
summary: Get Version
|
|
operationId: get_version_api_v1_versions__versions_id__get
|
|
parameters:
|
|
- name: versions_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Versions Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Get Version Api V1 Versions Versions Id Get
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
delete:
|
|
tags:
|
|
- scripts
|
|
summary: Delete Version
|
|
operationId: delete_version_api_v1_versions__versions_id__delete
|
|
parameters:
|
|
- name: versions_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Versions Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Delete Version Api V1 Versions Versions Id Delete
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/versions/{versions_id}/download-url:
|
|
post:
|
|
tags:
|
|
- scripts
|
|
summary: Version Download Url
|
|
operationId: version_download_url_api_v1_versions__versions_id__download_url_post
|
|
parameters:
|
|
- name: versions_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: Versions Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DownloadUrlRequest'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Version Download Url Api V1 Versions Versions Id Download Url Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/admin/employees:
|
|
get:
|
|
tags:
|
|
- admin
|
|
summary: List Employees
|
|
operationId: list_employees_api_v1_admin_employees_get
|
|
parameters:
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response List Employees Api V1 Admin Employees Get
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
post:
|
|
tags:
|
|
- admin
|
|
summary: Create Employee
|
|
operationId: create_employee_api_v1_admin_employees_post
|
|
parameters:
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/EmployeeCreate'
|
|
responses:
|
|
'201':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Create Employee Api V1 Admin Employees Post
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
/api/v1/admin/employees/{user_id}:
|
|
patch:
|
|
tags:
|
|
- admin
|
|
summary: Update Employee
|
|
operationId: update_employee_api_v1_admin_employees__user_id__patch
|
|
parameters:
|
|
- name: user_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: User Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/EmployeeUpdate'
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Update Employee Api V1 Admin Employees User Id Patch
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
delete:
|
|
tags:
|
|
- admin
|
|
summary: Delete Employee
|
|
operationId: delete_employee_api_v1_admin_employees__user_id__delete
|
|
parameters:
|
|
- name: user_id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: User Id
|
|
- name: X-User-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-User-Id
|
|
- name: X-Workspace-ID
|
|
in: header
|
|
required: true
|
|
schema:
|
|
type: string
|
|
title: X-Workspace-Id
|
|
- name: X-Request-ID
|
|
in: header
|
|
required: false
|
|
schema:
|
|
anyOf:
|
|
- type: string
|
|
- type: 'null'
|
|
title: X-Request-Id
|
|
responses:
|
|
'200':
|
|
description: Successful Response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
additionalProperties: true
|
|
title: Response Delete Employee Api V1 Admin Employees User Id Delete
|
|
'422':
|
|
description: Validation Error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
components:
|
|
schemas:
|
|
CompleteResourceUploadRequest:
|
|
properties:
|
|
resource_name:
|
|
type: string
|
|
maxLength: 255
|
|
minLength: 1
|
|
title: Resource Name
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 1000
|
|
- type: 'null'
|
|
title: Description
|
|
visibility:
|
|
type: string
|
|
enum:
|
|
- private
|
|
- workspace
|
|
- public
|
|
title: Visibility
|
|
default: private
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- resource_name
|
|
title: CompleteResourceUploadRequest
|
|
CreateJupyterAccessTicketRequest:
|
|
properties:
|
|
edit_session_id:
|
|
type: string
|
|
maxLength: 26
|
|
minLength: 26
|
|
title: Edit Session Id
|
|
lock_token:
|
|
type: string
|
|
maxLength: 256
|
|
minLength: 32
|
|
title: Lock Token
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- edit_session_id
|
|
- lock_token
|
|
title: CreateJupyterAccessTicketRequest
|
|
CreateResourceUploadRequest:
|
|
properties:
|
|
file_name:
|
|
type: string
|
|
maxLength: 255
|
|
minLength: 1
|
|
title: File Name
|
|
content_type:
|
|
type: string
|
|
maxLength: 255
|
|
minLength: 1
|
|
title: Content Type
|
|
expected_size_bytes:
|
|
type: integer
|
|
maximum: 104857600.0
|
|
minimum: 0.0
|
|
title: Expected Size Bytes
|
|
expected_hash:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 64
|
|
minLength: 64
|
|
- type: 'null'
|
|
title: Expected Hash
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- file_name
|
|
- content_type
|
|
- expected_size_bytes
|
|
title: CreateResourceUploadRequest
|
|
CreateScheduleEdgeRequest:
|
|
properties:
|
|
workflow_version:
|
|
type: integer
|
|
minimum: 1.0
|
|
title: Workflow Version
|
|
source_node_id:
|
|
type: string
|
|
maxLength: 26
|
|
minLength: 26
|
|
title: Source Node Id
|
|
target_node_id:
|
|
type: string
|
|
maxLength: 26
|
|
minLength: 26
|
|
title: Target Node Id
|
|
condition_expr:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 1000
|
|
- type: 'null'
|
|
title: Condition Expr
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- workflow_version
|
|
- source_node_id
|
|
- target_node_id
|
|
title: CreateScheduleEdgeRequest
|
|
CreateScheduleNodeRequest:
|
|
properties:
|
|
workflow_version:
|
|
type: integer
|
|
minimum: 1.0
|
|
title: Workflow Version
|
|
node_key:
|
|
type: string
|
|
maxLength: 64
|
|
minLength: 1
|
|
pattern: ^[A-Za-z][A-Za-z0-9_-]*$
|
|
title: Node Key
|
|
node_name:
|
|
type: string
|
|
maxLength: 255
|
|
minLength: 1
|
|
title: Node Name
|
|
versions_id:
|
|
type: string
|
|
maxLength: 26
|
|
minLength: 26
|
|
title: Versions Id
|
|
timeout_seconds:
|
|
type: integer
|
|
maximum: 86400.0
|
|
minimum: 1.0
|
|
title: Timeout Seconds
|
|
default: 600
|
|
retry_count:
|
|
type: integer
|
|
maximum: 10.0
|
|
minimum: 0.0
|
|
title: Retry Count
|
|
default: 0
|
|
retry_interval_sec:
|
|
type: integer
|
|
maximum: 3600.0
|
|
minimum: 0.0
|
|
title: Retry Interval Sec
|
|
default: 5
|
|
position_x:
|
|
type: number
|
|
maximum: 100000.0
|
|
minimum: -100000.0
|
|
title: Position X
|
|
default: 0
|
|
position_y:
|
|
type: number
|
|
maximum: 100000.0
|
|
minimum: -100000.0
|
|
title: Position Y
|
|
default: 0
|
|
arguments_json:
|
|
additionalProperties: true
|
|
type: object
|
|
maxProperties: 100
|
|
title: Arguments Json
|
|
env_refs_json:
|
|
additionalProperties:
|
|
type: string
|
|
type: object
|
|
maxProperties: 100
|
|
title: Env Refs Json
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- workflow_version
|
|
- node_key
|
|
- node_name
|
|
- versions_id
|
|
title: CreateScheduleNodeRequest
|
|
CreateScheduleRequest:
|
|
properties:
|
|
schedule_name:
|
|
type: string
|
|
maxLength: 255
|
|
minLength: 1
|
|
title: Schedule Name
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 1000
|
|
- type: 'null'
|
|
title: Description
|
|
trigger_type:
|
|
type: string
|
|
enum:
|
|
- manual
|
|
- cron
|
|
- api
|
|
title: Trigger Type
|
|
default: cron
|
|
cron_expression:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 128
|
|
- type: 'null'
|
|
title: Cron Expression
|
|
timezone:
|
|
type: string
|
|
maxLength: 64
|
|
minLength: 1
|
|
title: Timezone
|
|
default: Asia/Shanghai
|
|
enabled:
|
|
type: boolean
|
|
title: Enabled
|
|
default: false
|
|
max_concurrency:
|
|
type: integer
|
|
maximum: 64.0
|
|
minimum: 1.0
|
|
title: Max Concurrency
|
|
default: 1
|
|
failure_policy:
|
|
type: string
|
|
enum:
|
|
- stop
|
|
- continue
|
|
title: Failure Policy
|
|
default: stop
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- schedule_name
|
|
title: CreateScheduleRequest
|
|
CreateScriptRequest:
|
|
properties:
|
|
script_name:
|
|
type: string
|
|
maxLength: 255
|
|
minLength: 1
|
|
title: Script Name
|
|
script_type:
|
|
type: string
|
|
enum:
|
|
- python
|
|
- notebook
|
|
title: Script Type
|
|
content:
|
|
type: string
|
|
maxLength: 10485760
|
|
title: Content
|
|
visibility:
|
|
type: string
|
|
enum:
|
|
- private
|
|
- workspace
|
|
- public
|
|
title: Visibility
|
|
default: private
|
|
parent_path:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 1024
|
|
- type: 'null'
|
|
title: Parent Path
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- script_name
|
|
- script_type
|
|
- content
|
|
title: CreateScriptRequest
|
|
CreateWorkspaceDirectoryRequest:
|
|
properties:
|
|
directory_name:
|
|
type: string
|
|
maxLength: 255
|
|
minLength: 1
|
|
title: Directory Name
|
|
parent_path:
|
|
type: string
|
|
maxLength: 1024
|
|
title: Parent Path
|
|
default: ''
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- directory_name
|
|
title: CreateWorkspaceDirectoryRequest
|
|
CronPreviewRequest:
|
|
properties:
|
|
cron_expression:
|
|
type: string
|
|
maxLength: 128
|
|
minLength: 1
|
|
title: Cron Expression
|
|
timezone:
|
|
type: string
|
|
maxLength: 64
|
|
minLength: 1
|
|
title: Timezone
|
|
default: Asia/Shanghai
|
|
count:
|
|
type: integer
|
|
maximum: 20.0
|
|
minimum: 1.0
|
|
title: Count
|
|
default: 5
|
|
base_time:
|
|
anyOf:
|
|
- type: string
|
|
format: date-time
|
|
- type: 'null'
|
|
title: Base Time
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- cron_expression
|
|
title: CronPreviewRequest
|
|
DownloadUrlRequest:
|
|
properties:
|
|
expires_seconds:
|
|
type: integer
|
|
maximum: 3600.0
|
|
minimum: 30.0
|
|
title: Expires Seconds
|
|
default: 300
|
|
additionalProperties: false
|
|
type: object
|
|
title: DownloadUrlRequest
|
|
EmployeeCreate:
|
|
properties:
|
|
username:
|
|
type: string
|
|
maxLength: 64
|
|
minLength: 2
|
|
title: Username
|
|
display_name:
|
|
type: string
|
|
maxLength: 100
|
|
minLength: 1
|
|
title: Display Name
|
|
email:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 255
|
|
- type: 'null'
|
|
title: Email
|
|
role_code:
|
|
type: string
|
|
enum:
|
|
- admin
|
|
- developer
|
|
title: Role Code
|
|
default: developer
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- username
|
|
- display_name
|
|
title: EmployeeCreate
|
|
EmployeeUpdate:
|
|
properties:
|
|
display_name:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 100
|
|
minLength: 1
|
|
- type: 'null'
|
|
title: Display Name
|
|
email:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 255
|
|
- type: 'null'
|
|
title: Email
|
|
role_code:
|
|
anyOf:
|
|
- type: string
|
|
enum:
|
|
- admin
|
|
- developer
|
|
- type: 'null'
|
|
title: Role Code
|
|
status:
|
|
anyOf:
|
|
- type: string
|
|
enum:
|
|
- active
|
|
- disabled
|
|
- locked
|
|
- type: 'null'
|
|
title: Status
|
|
additionalProperties: false
|
|
type: object
|
|
title: EmployeeUpdate
|
|
FileLockTokenRequest:
|
|
properties:
|
|
lock_token:
|
|
type: string
|
|
maxLength: 256
|
|
minLength: 32
|
|
title: Lock Token
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- lock_token
|
|
title: FileLockTokenRequest
|
|
HTTPValidationError:
|
|
properties:
|
|
detail:
|
|
items:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
type: array
|
|
title: Detail
|
|
type: object
|
|
title: HTTPValidationError
|
|
PublishVersionRequest:
|
|
properties:
|
|
source_object_id:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 26
|
|
minLength: 26
|
|
- type: 'null'
|
|
title: Source Object Id
|
|
release_note:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 1000
|
|
- type: 'null'
|
|
title: Release Note
|
|
visibility:
|
|
type: string
|
|
enum:
|
|
- private
|
|
- workspace
|
|
- public
|
|
title: Visibility
|
|
default: workspace
|
|
additionalProperties: false
|
|
type: object
|
|
title: PublishVersionRequest
|
|
RunScheduleRequest:
|
|
properties:
|
|
reason:
|
|
type: string
|
|
maxLength: 255
|
|
minLength: 1
|
|
title: Reason
|
|
default: manual_run
|
|
additionalProperties: false
|
|
type: object
|
|
title: RunScheduleRequest
|
|
UpdateScheduleEdgeRequest:
|
|
properties:
|
|
workflow_version:
|
|
type: integer
|
|
minimum: 1.0
|
|
title: Workflow Version
|
|
condition_expr:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 1000
|
|
- type: 'null'
|
|
title: Condition Expr
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- workflow_version
|
|
title: UpdateScheduleEdgeRequest
|
|
UpdateScheduleNodeRequest:
|
|
properties:
|
|
workflow_version:
|
|
type: integer
|
|
minimum: 1.0
|
|
title: Workflow Version
|
|
node_name:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 255
|
|
minLength: 1
|
|
- type: 'null'
|
|
title: Node Name
|
|
versions_id:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 26
|
|
minLength: 26
|
|
- type: 'null'
|
|
title: Versions Id
|
|
timeout_seconds:
|
|
anyOf:
|
|
- type: integer
|
|
maximum: 86400.0
|
|
minimum: 1.0
|
|
- type: 'null'
|
|
title: Timeout Seconds
|
|
retry_count:
|
|
anyOf:
|
|
- type: integer
|
|
maximum: 10.0
|
|
minimum: 0.0
|
|
- type: 'null'
|
|
title: Retry Count
|
|
retry_interval_sec:
|
|
anyOf:
|
|
- type: integer
|
|
maximum: 3600.0
|
|
minimum: 0.0
|
|
- type: 'null'
|
|
title: Retry Interval Sec
|
|
position_x:
|
|
anyOf:
|
|
- type: number
|
|
maximum: 100000.0
|
|
minimum: -100000.0
|
|
- type: 'null'
|
|
title: Position X
|
|
position_y:
|
|
anyOf:
|
|
- type: number
|
|
maximum: 100000.0
|
|
minimum: -100000.0
|
|
- type: 'null'
|
|
title: Position Y
|
|
arguments_json:
|
|
anyOf:
|
|
- additionalProperties: true
|
|
type: object
|
|
maxProperties: 100
|
|
- type: 'null'
|
|
title: Arguments Json
|
|
env_refs_json:
|
|
anyOf:
|
|
- additionalProperties:
|
|
type: string
|
|
type: object
|
|
maxProperties: 100
|
|
- type: 'null'
|
|
title: Env Refs Json
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- workflow_version
|
|
title: UpdateScheduleNodeRequest
|
|
UpdateScheduleRequest:
|
|
properties:
|
|
workflow_version:
|
|
type: integer
|
|
minimum: 1.0
|
|
title: Workflow Version
|
|
schedule_name:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 255
|
|
minLength: 1
|
|
- type: 'null'
|
|
title: Schedule Name
|
|
description:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 1000
|
|
- type: 'null'
|
|
title: Description
|
|
trigger_type:
|
|
anyOf:
|
|
- type: string
|
|
enum:
|
|
- manual
|
|
- cron
|
|
- api
|
|
- type: 'null'
|
|
title: Trigger Type
|
|
cron_expression:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 128
|
|
- type: 'null'
|
|
title: Cron Expression
|
|
timezone:
|
|
anyOf:
|
|
- type: string
|
|
maxLength: 64
|
|
minLength: 1
|
|
- type: 'null'
|
|
title: Timezone
|
|
enabled:
|
|
anyOf:
|
|
- type: boolean
|
|
- type: 'null'
|
|
title: Enabled
|
|
max_concurrency:
|
|
anyOf:
|
|
- type: integer
|
|
maximum: 64.0
|
|
minimum: 1.0
|
|
- type: 'null'
|
|
title: Max Concurrency
|
|
failure_policy:
|
|
anyOf:
|
|
- type: string
|
|
enum:
|
|
- stop
|
|
- continue
|
|
- type: 'null'
|
|
title: Failure Policy
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- workflow_version
|
|
title: UpdateScheduleRequest
|
|
UpdateScriptRequest:
|
|
properties:
|
|
content:
|
|
type: string
|
|
maxLength: 10485760
|
|
title: Content
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- content
|
|
title: UpdateScriptRequest
|
|
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
|
|
WorkflowVersionRequest:
|
|
properties:
|
|
workflow_version:
|
|
type: integer
|
|
minimum: 1.0
|
|
title: Workflow Version
|
|
additionalProperties: false
|
|
type: object
|
|
required:
|
|
- workflow_version
|
|
title: WorkflowVersionRequest
|