hatchet/api-contracts/openapi/paths/workflow/workflow.yaml

withTenant:
  get:
    x-resources: ["tenant"]
    description: Get all workflows for a tenant
    operationId: workflow:list
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The number to skip
        in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int
          default: 0
      - description: The number to limit by
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int
          default: 50
      - description: Search by name
        in: query
        name: name
        required: false
        schema:
          type: string
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/WorkflowList"
        description: Successfully retrieved the workflows
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get workflows
    tags:
      - Workflow
withWorkflow:
  get:
    x-resources: ["tenant", "workflow"]
    description: Get a workflow for a tenant
    operationId: workflow:get
    parameters:
      - description: The workflow id
        in: path
        name: workflow
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/Workflow"
        description: Successfully retrieved the workflow
      "404":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Not found
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get workflow
    tags:
      - Workflow
  delete:
    x-resources: ["tenant", "workflow"]
    description: Delete a workflow for a tenant
    operationId: workflow:delete
    parameters:
      - description: The workflow id
        in: path
        name: workflow
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "204":
        description: Successfully deleted the workflow
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
      "404":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Not found
    summary: Delete workflow
    tags:
      - Workflow
  patch:
    x-resources: ["tenant", "workflow"]
    description: Update a workflow for a tenant
    operationId: workflow:update
    parameters:
      - description: The workflow id
        in: path
        name: workflow
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    requestBody:
      content:
        application/json:
          schema:
            $ref: "../../components/schemas/_index.yaml#/WorkflowUpdateRequest"
      description: The input to update the workflow
      required: true
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/Workflow"
        description: Successfully updated the workflow
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Update workflow
    tags:
      - Workflow
workflowVersion:
  get:
    x-resources: ["tenant", "workflow"]
    description: Get a workflow version for a tenant
    operationId: workflow-version:get
    parameters:
      - description: The workflow id
        in: path
        name: workflow
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The workflow version. If not supplied, the latest version is fetched.
        in: query
        name: version
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/WorkflowVersion"
        description: Successfully retrieved the workflow version
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
      "404":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Not found
    summary: Get workflow version
    tags:
      - Workflow
workflowVersionDefinition:
  get:
    x-resources: ["tenant", "workflow"]
    description: Get a workflow version definition for a tenant
    operationId: workflow-version:get:definition
    parameters:
      - description: The workflow id
        in: path
        name: workflow
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The workflow version. If not supplied, the latest version is fetched.
        in: query
        name: version
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/WorkflowVersionDefinition"
        description: Successfully retrieved the workflow version definition
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
      "404":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Not found
    summary: Get workflow version definition
    tags:
      - Workflow
triggerWorkflow:
  post:
    x-resources: ["tenant", "workflow"]
    description: Trigger a new workflow run for a tenant
    operationId: workflow-run:create
    parameters:
      - description: The workflow id
        in: path
        name: workflow
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The workflow version. If not supplied, the latest version is fetched.
        in: query
        name: version
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    requestBody:
      content:
        application/json:
          schema:
            $ref: "../../components/schemas/_index.yaml#/TriggerWorkflowRunRequest"
      description: The input to the workflow run
      required: true
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/WorkflowRun"
        description: Successfully created the workflow run
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "429":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Resource limit exceeded
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
      "404":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Not found
    summary: Trigger workflow run
    tags:
      - Workflow Run

cancelWorkflowRuns:
  post:
    x-resources: ["tenant"]
    description: Cancel a batch of workflow runs
    operationId: workflow-run:cancel
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    requestBody:
      content:
        application/json:
          schema:
            $ref: "../../components/schemas/_index.yaml#/WorkflowRunsCancelRequest"
      description: The input to cancel the workflow runs
      required: true
    responses:
      "200":
        content:
          application/json:
            schema:
              type: object
              properties:
                workflowRunIds:
                  type: array
                  items:
                    type: string
                    format: uuid
                    minLength: 36
                    maxLength: 36
        description: Successfully cancelled the workflow runs
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Cancel workflow runs
    tags:
      - Workflow Run

workflowRuns:
  get:
    x-resources: ["tenant"]
    description: Get all workflow runs for a tenant
    operationId: workflow-run:list
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The number to skip
        in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int64
      - description: The number to limit by
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int64
      - description: The event id to get runs for.
        in: query
        name: eventId
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The workflow id to get runs for.
        in: query
        name: workflowId
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The parent workflow run id
        in: query
        name: parentWorkflowRunId
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The parent step run id
        in: query
        name: parentStepRunId
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: A list of workflow run statuses to filter by
        in: query
        name: statuses
        required: false
        schema:
          $ref: "../../components/schemas/_index.yaml#/WorkflowRunStatusList"
      - description: A list of workflow kinds to filter by
        in: query
        name: kinds
        required: false
        schema:
          $ref: "../../components/schemas/_index.yaml#/WorkflowKindList"
      - description: A list of metadata key value pairs to filter by
        in: query
        name: additionalMetadata
        example: ["key1:value1", "key2:value2"]
        required: false
        schema:
          type: array
          items:
            type: string
      - description: The time after the workflow run was created
        in: query
        name: createdAfter
        example: "2021-01-01T00:00:00Z"
        required: false
        schema:
          type: string
          format: date-time
      - description: The time before the workflow run was created
        in: query
        name: createdBefore
        example: "2021-01-01T00:00:00Z"
        required: false
        schema:
          type: string
          format: date-time
      - description: The time after the workflow run was finished
        in: query
        name: finishedAfter
        example: "2021-01-01T00:00:00Z"
        required: false
        schema:
          type: string
          format: date-time
      - description: The time before the workflow run was finished
        in: query
        name: finishedBefore
        example: "2021-01-01T00:00:00Z"
        required: false
        schema:
          type: string
          format: date-time
      - description: The order by field
        in: query
        name: orderByField
        required: false
        schema:
          $ref: "../../components/schemas/_index.yaml#/WorkflowRunOrderByField"
      - description: The order by direction
        in: query
        name: orderByDirection
        required: false
        schema:
          $ref: "../../components/schemas/_index.yaml#/WorkflowRunOrderByDirection"
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/WorkflowRunList"
        description: Successfully retrieved the workflow runs
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get workflow runs
    tags:
      - Workflow
workflowRunsMetrics:
  get:
    x-resources: ["tenant"]
    description: Get a summary of  workflow run metrics for a tenant
    operationId: workflow-run:get:metrics
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The event id to get runs for.
        in: query
        name: eventId
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The workflow id to get runs for.
        in: query
        name: workflowId
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The parent workflow run id
        in: query
        name: parentWorkflowRunId
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The parent step run id
        in: query
        name: parentStepRunId
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: A list of metadata key value pairs to filter by
        in: query
        name: additionalMetadata
        example: ["key1:value1", "key2:value2"]
        required: false
        schema:
          type: array
          items:
            type: string
      - description: The time after the workflow run was created
        in: query
        name: createdAfter
        example: "2021-01-01T00:00:00Z"
        required: false
        schema:
          type: string
          format: date-time
      - description: The time before the workflow run was created
        in: query
        name: createdBefore
        example: "2021-01-01T00:00:00Z"
        required: false
        schema:
          type: string
          format: date-time
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/WorkflowRunsMetrics"
        description: Successfully retrieved the workflow runs metrics
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get workflow runs metrics
    tags:
      - Workflow
workflowRun:
  get:
    x-resources: ["tenant", "workflow-run"]
    description: Get a workflow run for a tenant
    operationId: workflow-run:get
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The workflow run id
        in: path
        name: workflow-run
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/WorkflowRun"
        description: Successfully retrieved the workflow run
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get workflow run
    tags:
      - Workflow
workflowRunShape:
  get:
    x-resources: ["tenant", "workflow-run"]
    description: Get a workflow run for a tenant
    operationId: workflow-run:get:shape
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The workflow run id
        in: path
        name: workflow-run
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/WorkflowRunShape"
        description: Successfully retrieved the workflow run
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get workflow run
    tags:
      - Workflow
getMetrics:
  get:
    x-resources: ["tenant", "workflow"]
    description: Get the metrics for a workflow version
    operationId: workflow:get:metrics
    parameters:
      - description: The workflow id
        in: path
        name: workflow
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: A status of workflow run statuses to filter by
        in: query
        name: status
        required: false
        schema:
          $ref: "../../components/schemas/_index.yaml#/WorkflowRunStatus"
      - description: A group key to filter metrics by
        in: query
        name: groupKey
        required: false
        schema:
          type: string
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/WorkflowMetrics"
        description: Successfully retrieved the workflow version metrics
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
      "404":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Not found
    summary: Get workflow metrics
    tags:
      - Workflow

workflowWorkersCount:
  get:
    x-resources: ["tenant", "workflow"]
    description: Get a count of the workers available for workflow
    operationId: workflow:get:workers-count
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The workflow id
        in: path
        name: workflow
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/WorkflowWorkersCount"
        description: Successfully retrieved the workflow worker count
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get workflow worker count
    tags:
      - Workflow

scheduledCreate:
  post:
    x-resources: ["tenant"]
    description: Schedule a new workflow run for a tenant
    operationId: scheduled-workflow-run:create
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The workflow name
        in: path
        name: workflow
        required: true
        schema:
          type: string
    requestBody:
      content:
        application/json:
          schema:
            $ref: "../../components/schemas/_index.yaml#/ScheduleWorkflowRunRequest"
      description: The input to the scheduled workflow run
      required: true
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/ScheduledWorkflows"
        description: Successfully created the scheduled workflow run
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "429":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Resource limit exceeded
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
      "404":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Not found
    summary: Trigger workflow run
    tags:
      - Workflow Run

scheduledList:
  get:
    x-resources: ["tenant"]
    description: Get all scheduled workflow runs for a tenant
    operationId: workflow-scheduled:list
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The number to skip
        in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int64
      - description: The number to limit by
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int64
      - description: The order by field
        in: query
        name: orderByField
        required: false
        schema:
          $ref: "../../components/schemas/_index.yaml#/ScheduledWorkflowsOrderByField"
      - description: The order by direction
        in: query
        name: orderByDirection
        required: false
        schema:
          $ref: "../../components/schemas/_index.yaml#/WorkflowRunOrderByDirection"
      - description: The workflow id to get runs for.
        in: query
        name: workflowId
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The parent workflow run id
        in: query
        name: parentWorkflowRunId
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The parent step run id
        in: query
        name: parentStepRunId
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: A list of metadata key value pairs to filter by
        in: query
        name: additionalMetadata
        example: ["key1:value1", "key2:value2"]
        required: false
        schema:
          type: array
          items:
            type: string
      - description: A list of scheduled run statuses to filter by
        in: query
        name: statuses
        required: false
        schema:
          type: array
          items:
            $ref: "../../components/schemas/_index.yaml#/ScheduledRunStatus"
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/ScheduledWorkflowsList"
        description: Successfully retrieved the workflow runs
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get scheduled workflow runs
    tags:
      - Workflow

scheduled:
  get:
    x-resources: ["tenant", "scheduled-workflow-run"]
    description: Get a scheduled workflow run for a tenant
    operationId: workflow-scheduled:get
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The scheduled workflow id
        in: path
        name: scheduled-workflow-run
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/ScheduledWorkflows"
        description: Successfully retrieved the workflow runs
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
      "404":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get scheduled workflow run
    tags:
      - Workflow
  delete:
    x-resources: ["tenant", "scheduled-workflow-run"]
    description: Delete a scheduled workflow run for a tenant
    operationId: workflow-scheduled:delete
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The scheduled workflow id
        in: path
        name: scheduled-workflow-run
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "204":
        description: Successfully deleted the scheduled workflow run
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIError"
        description: Forbidden
    summary: Delete scheduled workflow run
    tags:
      - Workflow

crons:
  get:
    x-resources: ["tenant", "cron-workflow"]
    description: Get a cron job workflow run for a tenant
    operationId: workflow-cron:get
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The cron job id
        in: path
        name: cron-workflow
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/CronWorkflows"
        description: Successfully retrieved the workflow runs
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
      "404":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get cron job workflow run
    tags:
      - Workflow
  delete:
    x-resources: ["tenant", "cron-workflow"]
    description: Delete a cron job workflow run for a tenant
    operationId: workflow-cron:delete
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The cron job id
        in: path
        name: cron-workflow
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "204":
        description: Successfully deleted the cron job workflow run
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIError"
        description: Forbidden
    summary: Delete cron job workflow run
    tags:
      - Workflow
  patch:
    x-resources: ["tenant", "cron-workflow"]
    description: Update a cron workflow for a tenant
    operationId: workflow-cron:update
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The cron job id
        in: path
        name: cron-workflow
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    requestBody:
      content:
        application/json:
          schema:
            $ref: "../../components/schemas/_index.yaml#/UpdateCronWorkflowTriggerRequest"
      description: The input for updates
      required: true
    responses:
      "204":
        description: Successfully updated the cron job workflow run
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIError"
        description: Forbidden
    summary: Update cron job workflow run
    tags:
      - Workflow

cronsCreate:
  post:
    x-resources: ["tenant"]
    description: Create a new cron job workflow trigger for a tenant
    operationId: cron-workflow-trigger:create
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The workflow name
        in: path
        name: workflow
        required: true
        schema:
          type: string
    requestBody:
      content:
        application/json:
          schema:
            $ref: "../../components/schemas/_index.yaml#/CreateCronWorkflowTriggerRequest"
      description: The input to the cron job workflow trigger
      required: true
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/CronWorkflows"
        description: Successfully created the cron job workflow trigger
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "429":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Resource limit exceeded
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
      "404":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Not found
    summary: Create cron job workflow trigger
    tags:
      - Workflow Run

cronsList:
  get:
    x-resources: ["tenant"]
    description: Get all cron job workflow triggers for a tenant
    operationId: cron-workflow:list
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The number to skip
        in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int64
      - description: The number to limit by
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int64
      - description: The workflow id to get runs for.
        in: query
        name: workflowId
        required: false
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The workflow name to get runs for.
        in: query
        name: workflowName
        required: false
        schema:
          type: string
      - description: The cron name to get runs for.
        in: query
        name: cronName
        required: false
        schema:
          type: string
      - description: A list of metadata key value pairs to filter by
        in: query
        name: additionalMetadata
        example: ["key1:value1", "key2:value2"]
        required: false
        schema:
          type: array
          items:
            type: string
      - description: The order by field
        in: query
        name: orderByField
        required: false
        schema:
          $ref: "../../components/schemas/_index.yaml#/CronWorkflowsOrderByField"
      - description: The order by direction
        in: query
        name: orderByDirection
        required: false
        schema:
          $ref: "../../components/schemas/_index.yaml#/WorkflowRunOrderByDirection"
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/CronWorkflowsList"
        description: Successfully retrieved the workflow runs
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get cron job workflows
    tags:
      - Workflow