B3 Action API

openapi: 3.1.0
info:
  description: Workflow management API for B3OS
  title: B3OS Workflow Action API
  version: '1.0'
tags:
- name: Action
paths:
  /v1/actions/{type}/test:
    post:
      description: Test an action with custom payload
      parameters:
      - description: Action type
        in: path
        name: type
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - type: object
              - $ref: '#/components/schemas/TestActionParams'
                summary: body
                description: Test parameters
        description: Test parameters
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestActionSuccessResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Bad Request
        '402':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Payment Required
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Not Found
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse'
          description: Bad Gateway
      tags:
      - Action
components:
  schemas:
    TestActionParams:
      properties:
        connector:
          $ref: '#/components/schemas/github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ConnectorReference'
        inputs:
          additionalProperties: {}
          type: object
      required:
      - inputs
      type: object
    github_com_b3-fun_b3-mono_services_b3os-workflow_internal_pkg_entity.ConnectorReference:
      description: nil if action doesn't need connector
      properties:
        id:
          description: Connector ID (or subOrgId for turnkey)
          type: string
        type:
          description: Connector type (e.g., "slack", "turnkey")
          type: string
      type: object
    ActionTestError:
      properties:
        code:
          type: string
        message:
          type: string
      type: object
    TestActionData:
      properties:
        actionType:
          type: string
        cuCost:
          type: number
        error:
          $ref: '#/components/schemas/ActionTestError'
        executionTimeMs:
          type: integer
        requiresGas:
          type: boolean
        result:
          additionalProperties: {}
          type: object
        success:
          type: boolean
      type: object
    github_com_b3-fun_b3-mono_services_b3os-workflow_internal_app_api_http.ErrorResponse:
      properties:
        code:
          type: integer
        details:
          items: {}
          type: array
          uniqueItems: false
        message:
          type: string
        requestId:
          type: string
      type: object
    TestActionSuccessResponse:
      properties:
        code:
          example: 0
          type: integer
        data:
          $ref: '#/components/schemas/TestActionData'
        message:
          example: successfully
          type: string
        requestId:
          example: abc-123
          type: string
      type: object