iwf-sdk.yaml

openapi: 3.0.0
servers:
  - url: 'http://petstore.swagger.io/v2'
info:
  description: >-
    This APIs for iwf SDKs to operate workflows
  version: 1.0.0
  title: Workflow APIs
  license:
    name: Apache-2.0
    url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
paths:
  # workflow APIs are hosted by iWF server for iWF SDKs to call
  /api/v1/workflow/start:
    post:
      summary: "start a workflow"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowStartRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowStartResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/workflow/signal:
    post:
      summary: "signal a workflow"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowSignalRequest'
      responses:
        '200':
          description: successful operation
          content: {}
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/workflow/stop:
    post:
      summary: "stop a workflow"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowStopRequest'
      responses:
        '200':
          description: successful operation
          content: {}
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/workflow/dataobjects/get:
    post:
      summary: "get workflow data objects"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowGetDataObjectsRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowGetDataObjectsResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/workflow/searchattributes/get:
    post:
      summary: "get workflow search attributes"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowGetSearchAttributesRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowGetSearchAttributesResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/workflow/get:
    post:
      summary: "get a workflow's status and results(if completed & requested)"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowGetRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowGetResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/workflow/getWithWait: ## this will wait for workflow to close if still running
    post:
      summary: "get a workflow's status and results(if completed & requested), wait if the workflow is still running"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowGetRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowGetResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '420':
          description: wait has exceeded timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/workflow/search:
    post:
      summary: "search for workflows by a search attribute query"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowSearchRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowSearchResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/workflow/reset:
    post:
      summary: "reset a workflow"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowResetRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowResetResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/workflow/rpc:
    post:
      summary: "execute an RPC of a workflow"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowRpcRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRpcResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '420':
          description: RPC execution error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '450':
          description: RPC acquire locking failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/workflow/timer/skip:
    post:
      summary: "skip the timer of a workflow"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowSkipTimerRequest'
      responses:
        '200':
          description: successful operation
          content: {}
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/workflow/config/update:
    post:
      summary: "update the config of a workflow"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowConfigUpdateRequest'
      responses:
        '200':
          description: successful operation
          content: {}
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/workflow/waitForStateCompletion:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowWaitForStateCompletionRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowWaitForStateCompletionResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '420':
          description: wait has exceeded timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/workflow/internal/dump:
    post:
      summary: "dump internal info of a workflow"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowDumpRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowDumpResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /info/healthcheck:
    get:
      summary: "return health info of the server"
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthInfo'
  /api/v1/workflow/triggerContinueAsNew:
    post:
      summary: "trigger ContinueAsNew for a workflow"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TriggerContinueAsNewRequest'
      responses:
        '200':
          description: successful operation
          content: {}
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  # Below APIs are hosted by iWF SDK for iWF server to call
  /api/v1/workflowState/start: #TODO: rename to /api/v1/workflowState/waitUntil
    post:
      summary: "for invoking WorkflowState.waitUntil API"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowStateWaitUntilRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowStateWaitUntilResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkerErrorResponse'
  /api/v1/workflowState/decide: # TODO: rename to /api/v1/workflowState/execute:
    post:
      summary: "for invoking WorkflowState.execute API"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowStateExecuteRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowStateExecuteResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkerErrorResponse'
  /api/v1/workflowWorker/rpc:
    post:
      summary: "for invoking workflow RPC API in the worker"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowWorkerRpcRequest'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowWorkerRpcResponse'
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkerErrorResponse'
components:
  schemas:
    KeyValue:
      type: object
      properties:
        key:
          type: string
        value:
          $ref: '#/components/schemas/EncodedObject'
    EncodedObject:
      type: object
      properties:
        encoding:
          type: string
        data:
          type: string
    SearchAttributeKeyAndType:
      type: object
      properties:
        key:
          type: string
        valueType:
          $ref: '#/components/schemas/SearchAttributeValueType'
    SearchAttributeValueType: # see https://docs.temporal.io/concepts/what-is-a-search-attribute#types
      type: string
      enum:
        - KEYWORD
        - TEXT
        - DATETIME
        - INT
        - DOUBLE
        - BOOL
        - KEYWORD_ARRAY # NOTE: for Cadence/Temporal keyword array is registered in the same type as KEYWORD
    SearchAttribute:
      type: object
      properties:
        key:
          type: string
        stringValue: # It's used for any value than can be stored as string: keyword, text, and DATETIME
          type: string
        integerValue: # It's used for INT type
          type: integer
          format: int64
        doubleValue: # For DOUBLE type
          type: number
          format: double
        boolValue: # for BOOL type
          type: boolean
        stringArrayValue: # for any type than can be stored as string array: KEYWORD, TEXT, and DATETIME
          type: array
          items:
            type: string
        valueType:
          $ref: '#/components/schemas/SearchAttributeValueType'
    RetryPolicy:
      type: object
      properties:
        initialIntervalSeconds: # default to 1s
          type: integer
        backoffCoefficient: # default to 2
          type: number
          format: float
        maximumIntervalSeconds: # default to 100x of initial interval
          type: integer
        maximumAttempts: # default to 0, means unlimited
          type: integer
        maximumAttemptsDurationSeconds: # the end to end duration of all attempts
          type: integer
    WorkflowRetryPolicy:
      type: object
      properties:
        initialIntervalSeconds: # default to 1s
          type: integer
        backoffCoefficient: # default to 2
          type: number
          format: float
        maximumIntervalSeconds: # default to 100x of initial interval
          type: integer
        maximumAttempts: # default to 0, means unlimited
          type: integer
    ExecuteApiFailurePolicy:
      type: string
      enum:
        - FAIL_WORKFLOW_ON_EXECUTE_API_FAILURE
        - PROCEED_TO_CONFIGURED_STATE
    WaitUntilApiFailurePolicy:
      type: string
      enum:
        - FAIL_WORKFLOW_ON_FAILURE
        - PROCEED_ON_FAILURE # next states derived from execute() API
    WorkflowStateOptions:
      type: object
      properties:
        searchAttributesLoadingPolicy:
          $ref: '#/components/schemas/PersistenceLoadingPolicy'
        dataAttributesLoadingPolicy:
          $ref: '#/components/schemas/PersistenceLoadingPolicy'
        waitUntilApiTimeoutSeconds: # NOTE: this is the timeout for the single attempt of Cadence/Temporal activity(start to close timeout)
          type: integer
        executeApiTimeoutSeconds: # NOTE: this is the timeout for the single attempt of Cadence/Temporal activity(start to close timeout)
          type: integer
        waitUntilApiRetryPolicy:
          $ref: '#/components/schemas/RetryPolicy'
        executeApiRetryPolicy:
          $ref: '#/components/schemas/RetryPolicy'
        waitUntilApiFailurePolicy:
          $ref: '#/components/schemas/WaitUntilApiFailurePolicy'
        executeApiFailurePolicy:
          $ref: '#/components/schemas/ExecuteApiFailurePolicy'
        executeApiFailureProceedStateId:
          type: string
        executeApiFailureProceedStateOptions:
          $ref: '#/components/schemas/WorkflowStateOptions'
        skipWaitUntil:
          type: boolean
    WorkflowStartOptions:
      type: object
      properties:
        idReusePolicy:
          $ref: '#/components/schemas/IDReusePolicy'
        cronSchedule:
          type: string
        workflowStartDelaySeconds:
          type: integer
          format: int32
        retryPolicy:
          $ref: '#/components/schemas/WorkflowRetryPolicy'
        searchAttributes:
          type: array
          items:
            $ref: '#/components/schemas/SearchAttribute'
        workflowConfigOverride:
          $ref: '#/components/schemas/WorkflowConfig'
        useMemoForDataAttributes:
          type: boolean
    IDReusePolicy:
      type: string
      enum:
        - ALLOW_IF_PREVIOUS_EXISTS_ABNORMALLY
        - ALLOW_IF_NO_RUNNING
        - DISALLOW_REUSE
        - ALLOW_TERMINATE_IF_RUNNING
    PersistenceLoadingPolicy:
      type: object
      properties:
        persistenceLoadingType:
          $ref: '#/components/schemas/PersistenceLoadingType'
        partialLoadingKeys:
          type: array
          items:
            type: string
        lockingKeys:
          type: array
          items:
            type: string
        useKeyAsPrefix:
          type: boolean
    PersistenceLoadingType:
      type: string
      enum:
        - LOAD_ALL_WITHOUT_LOCKING
        - LOAD_PARTIAL_WITHOUT_LOCKING
        - LOAD_PARTIAL_WITH_EXCLUSIVE_LOCK
        - LOAD_NONE
        - LOAD_ALL_WITH_PARTIAL_LOCK
    WorkerErrorResponse:
      type: object
      properties:
        detail:
          type: string
        errorType:
          type: string
    HealthInfo:
      type: object
      properties:
        condition:
          type: string
        hostname:
          type: string
        duration: # indicate how long to check the health(in seconds)
          type: integer
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
        subStatus:
          $ref: '#/components/schemas/ErrorSubStatus'
        originalWorkerErrorDetail:
          type: string
        originalWorkerErrorType:
          type: string
        originalWorkerErrorStatus:
          type: integer
    ErrorSubStatus:
      type: string
      enum:
        - UNCATEGORIZED_SUB_STATUS
        - WORKFLOW_ALREADY_STARTED_SUB_STATUS
        - WORKFLOW_NOT_EXISTS_SUB_STATUS
        - WORKER_API_ERROR
        - LONG_POLL_TIME_OUT_SUB_STATUS
    WorkflowStartRequest:
      type: object
      required:
        - workflowId
        - iwfWorkerUrl
        - iwfWorkflowType
        - workflowTimeoutSeconds
      properties:
        workflowId:
          type: string
        iwfWorkflowType:
          type: string
        workflowTimeoutSeconds:
          type: integer
        iwfWorkerUrl:
          type: string
        startStateId:
          type: string
        waitForCompletionStateExecutionIds:
          type: array
          items:
            type: string
        stateInput:
          $ref: '#/components/schemas/EncodedObject'
        stateOptions:
          $ref: '#/components/schemas/WorkflowStateOptions'
        workflowStartOptions:
          $ref: '#/components/schemas/WorkflowStartOptions'
    WorkflowStartResponse:
      type: object
      properties:
        workflowRunId:
          type: string
    WorkflowSignalRequest:
      type: object
      required:
        - workflowId
        - signalChannelName
      properties:
        workflowId:
          type: string
        workflowRunId:
          type: string
        signalChannelName:
          type: string
        signalValue:
          $ref: '#/components/schemas/EncodedObject'
    WorkflowStopRequest:
      type: object
      required:
        - workflowId
      properties:
        workflowId:
          type: string
        workflowRunId:
          type: string
        reason:
          type: string
        stopType:
          $ref: '#/components/schemas/WorkflowStopType'
    WorkflowStopType:
      type: string
      enum:
        - CANCEL # default behavior
        - TERMINATE # this will hard terminate the workflow
        - FAIL
    WorkflowGetDataObjectsRequest:
      type: object
      required:
        - workflowId
      properties:
        workflowId:
          type: string
        workflowRunId:
          type: string
        keys: # return all objects if this is empty
          type: array
          items:
            type: string
        useMemoForDataAttributes:
          type: boolean
    WorkflowGetDataObjectsResponse:
      type: object
      properties:
        objects:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
    WorkflowGetSearchAttributesRequest:
      type: object
      required:
        - workflowId
      properties:
        workflowId:
          type: string
        workflowRunId:
          type: string
        keys: # return all search attributes if this is empty
          type: array
          items:
            $ref: '#/components/schemas/SearchAttributeKeyAndType'
    WorkflowGetSearchAttributesResponse:
      type: object
      properties:
        searchAttributes:
          type: array
          items:
            $ref: '#/components/schemas/SearchAttribute'
    WorkflowGetRequest:
      type: object
      required:
        - workflowId
      properties:
        workflowId:
          type: string
        workflowRunId:
          type: string
        needsResults: # result will be return if this is true, and workflow is completed
          type: boolean
        waitTimeSeconds: # amount of time that the request will be waiting for, only works for getWithWait API
          type: integer
    WorkflowGetResponse:
      type: object
      required:
        - workflowRunId
        - workflowStatus
      properties:
        workflowRunId:
          type: string
        workflowStatus:
          $ref: '#/components/schemas/WorkflowStatus'
        results: # result will be return if needsResults is true in request, and workflow is completed
          type: array
          items:
            $ref: '#/components/schemas/StateCompletionOutput'
        errorType:
          $ref: '#/components/schemas/WorkflowErrorType'
        errorMessage:
          type: string
    WorkflowErrorType:
      type: string
      enum:
        - STATE_DECISION_FAILING_WORKFLOW_ERROR_TYPE
        - CLIENT_API_FAILING_WORKFLOW_ERROR_TYPE
        - STATE_API_FAIL_MAX_OUT_RETRY_ERROR_TYPE
        - INVALID_USER_WORKFLOW_CODE_ERROR_TYPE
        - RPC_ACQUIRE_LOCK_FAILURE
        - SERVER_INTERNAL_ERROR_TYPE
    WorkflowStatus:
      type: string
      enum:
        - RUNNING
        - COMPLETED
        - FAILED
        - TIMEOUT
        - TERMINATED
        - CANCELED
        - CONTINUED_AS_NEW
    StateCompletionOutput:
      type: object
      required:
        - completedStateExecutionId
        - completedStateId
      properties:
        completedStateId:
          type: string
        completedStateExecutionId:
          type: string
        completedStateOutput:
          $ref: '#/components/schemas/EncodedObject'
    WorkflowSearchRequest:
      type: object
      required:
        - query
      properties:
        query:
          type: string
        pageSize:
          type: integer
          format: int32
        nextPageToken:
          type: string
    WorkflowSearchResponse:
      type: object
      properties:
        workflowExecutions:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowSearchResponseEntry'
        nextPageToken:
          type: string
    WorkflowSearchResponseEntry:
      type: object
      required:
        - workflowId
        - workflowRunId
      properties:
        workflowId:
          type: string
        workflowRunId:
          type: string
    WorkflowResetRequest:
      type: object
      required:
        - workflowId
        - resetType
      properties:
        workflowId:
          type: string
        workflowRunId:
          type: string
        resetType:
          $ref: '#/components/schemas/WorkflowResetType'
        historyEventId: #required for resetType of HISTORY_EVENT_ID. The eventID of any event after DecisionTaskStarted you want to reset to (this event is exclusive in a new run. The new run history will fork and continue from the previous eventID of this). It can be DecisionTaskCompleted, DecisionTaskFailed or others
          type: integer
        reason: #reason to do the reset for tracking purpose
          type: string
        historyEventTime: #Earliest time of history event time, required for resetType of HISTORY_EVENT_TIME.Supported formats are '2006-01-02T15:04:05+07:00', raw UnixNano and time range (N<duration>), where 0 < N < 1000000 and duration (full-notation/short-notation) can be second/s, minute/m, hour/h, day/d, week/w, month/M or year/y. For example, '15minute' or '15m' implies last 15 minutes, meaning that workflow will be reset to the first decision that completed in last 15 minutes
          type: string
        stateId: # required for STATE_ID resetType
          type: string
        stateExecutionId: # required for STATE_EXECUTION_ID resetType
          type: string
        skipSignalReapply: # whether skipping signals reapply after the reset point
          type: boolean
    WorkflowResetType:
      type: string
      enum:
        - HISTORY_EVENT_ID
        - BEGINNING
        - HISTORY_EVENT_TIME
        - STATE_ID
        - STATE_EXECUTION_ID
    WorkflowResetResponse:
      type: object
      required:
        - workflowRunId
      properties:
        workflowRunId:
          type: string
    WorkflowDumpRequest:
      type: object
      required:
        - workflowId
        - workflowRunId
        - pageSizeInBytes
        - pageNum
      properties:
        workflowId:
          type: string
        workflowRunId:
          type: string
        pageSizeInBytes:
          type: integer
        pageNum:
          type: integer
    WorkflowDumpResponse:
      type: object
      required:
        - checksum
        - totalPages
        - jsonData
      properties:
        checksum:
          type: string # caller should start over if the checksum is not matched anymore
        totalPages:
          type: integer
        jsonData:
          type: string # serialized data of service.DumpAllInternalResponse model of iwf repo
    WorkflowRpcRequest:
      type: object
      required:
        - workflowId
        - rpcName
      properties:
        workflowId:
          type: string
        workflowRunId:
          type: string
        rpcName:
          type: string
        input:
          $ref: '#/components/schemas/EncodedObject'
        searchAttributesLoadingPolicy:
          $ref: '#/components/schemas/PersistenceLoadingPolicy'
        dataAttributesLoadingPolicy:
          $ref: '#/components/schemas/PersistenceLoadingPolicy'
        timeoutSeconds:
          type: integer
        useMemoForDataAttributes:
          type: boolean
        searchAttributes:
          type: array
          items:
            $ref: '#/components/schemas/SearchAttributeKeyAndType'
    WorkflowRpcResponse:
      type: object
      properties:
        output:
          $ref: '#/components/schemas/EncodedObject'
    WorkflowWorkerRpcRequest:
      type: object
      required:
        - context
        - workflowType
        - rpcName
      properties:
        context:
          $ref: '#/components/schemas/Context'
        workflowType:
          type: string
        rpcName:
          type: string
        input:
          $ref: '#/components/schemas/EncodedObject'
        searchAttributes:
          type: array
          items:
            $ref: '#/components/schemas/SearchAttribute'
        dataAttributes:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
    WorkflowWorkerRpcResponse:
      type: object
      properties:
        output:
          $ref: '#/components/schemas/EncodedObject'
        stateDecision:
          $ref: '#/components/schemas/StateDecision'
        upsertSearchAttributes:
          type: array
          items:
            $ref: '#/components/schemas/SearchAttribute'
        upsertDataAttributes:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        recordEvents:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        upsertStateLocals: # this is probably no much value but we keep it to make the APIs more consistent
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        publishToInterStateChannel:
          type: array
          items:
            $ref: '#/components/schemas/InterStateChannelPublishing'
    WorkflowStateWaitUntilRequest:
      type: object
      required:
        - context
        - workflowStateId
        - workflowType
      properties:
        context:
          $ref: '#/components/schemas/Context'
        workflowType:
          type: string
        workflowStateId:
          type: string
        stateInput:
          $ref: '#/components/schemas/EncodedObject'
        searchAttributes:
          type: array
          items:
            $ref: '#/components/schemas/SearchAttribute'
        dataObjects:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
    WorkflowSkipTimerRequest:
      type: object
      required:
        - workflowId
        - workflowStateExecutionId
      properties:
        workflowId:
          type: string
        workflowRunId:
          type: string
        workflowStateExecutionId:
          type: string
        timerCommandId: # NOTE: either timerCommandId or timerCommandIndex must be provided
          type: string
        timerCommandIndex: # NOTE: either timerCommandId or timerCommandIndex must be provided
          type: integer
    WorkflowConfigUpdateRequest:
      type: object
      required:
        - workflowId
        - workflowConfig
      properties:
        workflowId:
          type: string
        workflowRunId:
          type: string
        workflowConfig:
          $ref: '#/components/schemas/WorkflowConfig'
    WorkflowStateWaitUntilResponse:
      type: object
      properties:
        upsertSearchAttributes:
          type: array
          items:
            $ref: '#/components/schemas/SearchAttribute'
        upsertDataObjects:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        commandRequest:
          $ref: '#/components/schemas/CommandRequest'
        upsertStateLocals:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        recordEvents:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        publishToInterStateChannel:
          type: array
          items:
            $ref: '#/components/schemas/InterStateChannelPublishing'
    WorkflowStateExecuteRequest:
      type: object
      required:
        - context
        - workflowType
        - workflowStateId
      properties:
        context:
          $ref: '#/components/schemas/Context'
        workflowType:
          type: string
        workflowStateId:
          type: string
        stateInput:
          $ref: '#/components/schemas/EncodedObject'
        searchAttributes:
          type: array
          items:
            $ref: '#/components/schemas/SearchAttribute'
        DataObjects:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        stateLocals :
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        commandResults:
          $ref: '#/components/schemas/CommandResults'
    WorkflowStateExecuteResponse:
      type: object
      properties:
        stateDecision:
          $ref: '#/components/schemas/StateDecision'
        upsertSearchAttributes:
          type: array
          items:
            $ref: '#/components/schemas/SearchAttribute'
        upsertDataObjects:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        recordEvents:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        upsertStateLocals: # this is probably no much value but we keep it to make the APIs more consistent
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
        publishToInterStateChannel:
          type: array
          items:
            $ref: '#/components/schemas/InterStateChannelPublishing'
    WorkflowWaitForStateCompletionRequest:
      type: object
      required:
        - workflowId
        - stateExecutionId
      properties:
        workflowId:
          type: string
        stateExecutionId:
          type: string
        waitTimeSeconds: # amount of time that the request will be waiting for, only works for getWithWait API
          type: integer
    WorkflowWaitForStateCompletionResponse:
      type: object
      properties:
        stateCompletionOutput:
          $ref: '#/components/schemas/StateCompletionOutput'
    TriggerContinueAsNewRequest:
      type: object
      required:
        - workflowId
      properties:
        workflowId:
          type: string
        workflowRunId:
          type: string
    StateDecision:
      type: object
      properties:
        nextStates:
          type: array
          items:
            $ref: '#/components/schemas/StateMovement'
        conditionalClose: # note that the above nextStates will be used on condition unmet
          $ref: '#/components/schemas/WorkflowConditionalClose'
    WorkflowConditionalClose:
      type: object
      properties:
        conditionalCloseType:
          $ref: '#/components/schemas/WorkflowConditionalCloseType'
        channelName:
          type: string
        closeInput:
          $ref: '#/components/schemas/EncodedObject'
    WorkflowConditionalCloseType:
      type: string
      enum:
        - FORCE_COMPLETE_ON_INTERNAL_CHANNEL_EMPTY
        - FORCE_COMPLETE_ON_SIGNAL_CHANNEL_EMPTY
        - GRACEFUL_COMPLETE_ON_ALL_CHANNELS_EMPTY
    StateMovement:
      type: object
      required:
        - stateId
      properties:
        stateId:
          type: string
        stateInput:
          $ref: '#/components/schemas/EncodedObject'
        stateOptions:
          $ref: '#/components/schemas/WorkflowStateOptions'
    CommandRequest:
      type: object
      required:
        - commandWaitingType
      properties:
        commandWaitingType:
          $ref: '#/components/schemas/CommandWaitingType'
        timerCommands:
          type: array
          items:
            $ref: '#/components/schemas/TimerCommand'
        signalCommands:
          type: array
          items:
            $ref: '#/components/schemas/SignalCommand'
        interStateChannelCommands:
          type: array
          items:
            $ref: '#/components/schemas/InterStateChannelCommand'
        commandCombinations:
          type: array
          items:
            $ref: '#/components/schemas/CommandCombination'
    CommandWaitingType:
      type: string
      enum:
        - ALL_COMPLETED
        - ANY_COMPLETED
        - ANY_COMBINATION_COMPLETED # this allows specifying combination using commandIds, all commandIds cannot be emptied in order to use this CommandWaitingType
    CommandCombination:
      type: object
      properties:
        commandIds:
          type: array
          items:
            type: string
    CommandResults:
      type: object
      properties:
        signalResults:
          type: array
          items:
            $ref: '#/components/schemas/SignalResult'
        interStateChannelResults:
          type: array
          items:
            $ref: '#/components/schemas/InterStateChannelResult'
        timerResults:
          type: array
          items:
            $ref: '#/components/schemas/TimerResult'
        stateStartApiSucceeded: #TODO change this one in the future to waitUntilSucceeded
          type: boolean
    TimerCommand:
      type: object
      required:
        - commandId
        - firingUnixTimestampSeconds
      properties:
        commandId:
          type: string
        firingUnixTimestampSeconds:
          type: integer
          format: int64
    SignalCommand:
      type: object
      required:
        - commandId
        - signalChannelName
      properties:
        commandId:
          type: string
        signalChannelName:
          type: string
        atLeast:
          type: integer
        atMost:
          type: integer
    InterStateChannelCommand:
      type: object
      required:
        - commandId
        - channelName
      properties:
        commandId:
          type: string
        channelName:
          type: string
        atLeast:
          type: integer
        atMost:
          type: integer
    TimerResult:
      type: object
      required:
        - commandId
        - timerStatus
      properties:
        commandId:
          type: string
        timerStatus:
          $ref: '#/components/schemas/TimerStatus'
    TimerStatus:
      type: string
      enum:
        - SCHEDULED
        - FIRED
    SignalResult:
      type: object
      required:
        - commandId
        - signalChannelName
        - signalRequestStatus
      properties:
        commandId:
          type: string
        signalRequestStatus:
          $ref: '#/components/schemas/ChannelRequestStatus'
        signalChannelName:
          type: string
        signalValue:
          $ref: '#/components/schemas/EncodedObject'
    InterStateChannelResult:
      type: object
      required:
        - commandId
        - channelName
        - requestStatus
      properties:
        commandId:
          type: string
        requestStatus:
          $ref: '#/components/schemas/ChannelRequestStatus'
        channelName:
          type: string
        value:
          $ref: '#/components/schemas/EncodedObject'
    ChannelRequestStatus:
      type: string
      enum:
        - WAITING
        - RECEIVED
    InterStateChannelPublishing:
      type: object
      required:
        - channelName
      properties:
        channelName:
          type: string
        value:
          $ref: '#/components/schemas/EncodedObject'
    WorkflowConfig:
      type: object
      properties:
        disableSystemSearchAttribute: # deprecated in favor of enabledExecutingStateExecutionIds
          type: boolean
        enabledExecutingStateExecutionIds:
          type: boolean
        continueAsNewThreshold:
          type: integer
        continueAsNewPageSizeInBytes:
          type: integer
        optimizeActivity:
          type: boolean
    Context:
      type: object
      required:
        - workflowId
        - workflowRunId
        - workflowStartedTimestamp
      properties:
        workflowId:
          type: string
        workflowRunId:
          type: string
        workflowStartedTimestamp:
          type: integer
          format: int64
        stateExecutionId:
          type: string
        firstAttemptTimestamp: # it's from ScheduledTimestamp of Cadence/Temporal activity.GetInfo
          type: integer
          format: int64
        attempt: # it's from Attempt of Cadence/Temporal activity.GetInfo
          type: integer