Dapr Workflow API — Workflow

naftiko: 1.0.0-alpha2
info:
  label: Dapr Workflow API — Workflow
  description: 'Dapr Workflow API — Workflow. 7 operations. Lead operation: Dapr Get Workflow. Self-contained Naftiko capability
    covering one Dapr business surface.'
  tags:
  - Dapr
  - Workflow
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DAPR_API_KEY: DAPR_API_KEY
capability:
  consumes:
  - type: http
    namespace: workflow-workflow
    baseUri: http://localhost:3500
    description: Dapr Workflow API — Workflow business capability. Self-contained, no shared references.
    resources:
    - name: v1.0-workflows-workflowComponentName-instanceId
      path: /v1.0/workflows/{workflowComponentName}/{instanceId}
      operations:
      - name: getworkflow
        method: GET
        description: Dapr Get Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowComponentName
          in: path
          type: string
          description: The workflow component name.
          required: true
        - name: instanceId
          in: path
          type: string
          description: The workflow instance ID.
          required: true
    - name: v1.0-workflows-workflowComponentName-instanceId-pause
      path: /v1.0/workflows/{workflowComponentName}/{instanceId}/pause
      operations:
      - name: pauseworkflow
        method: POST
        description: Dapr Pause Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowComponentName
          in: path
          type: string
          description: The workflow component name.
          required: true
        - name: instanceId
          in: path
          type: string
          description: The workflow instance ID.
          required: true
    - name: v1.0-workflows-workflowComponentName-instanceId-purge
      path: /v1.0/workflows/{workflowComponentName}/{instanceId}/purge
      operations:
      - name: purgeworkflow
        method: POST
        description: Dapr Purge Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowComponentName
          in: path
          type: string
          description: The workflow component name.
          required: true
        - name: instanceId
          in: path
          type: string
          description: The workflow instance ID.
          required: true
    - name: v1.0-workflows-workflowComponentName-instanceId-raiseEvent-eventName
      path: /v1.0/workflows/{workflowComponentName}/{instanceId}/raiseEvent/{eventName}
      operations:
      - name: raiseworkflowevent
        method: POST
        description: Dapr Raise Workflow Event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowComponentName
          in: path
          type: string
          description: The workflow component name.
          required: true
        - name: instanceId
          in: path
          type: string
          description: The workflow instance ID.
          required: true
        - name: eventName
          in: path
          type: string
          description: The name of the event to raise.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1.0-workflows-workflowComponentName-instanceId-resume
      path: /v1.0/workflows/{workflowComponentName}/{instanceId}/resume
      operations:
      - name: resumeworkflow
        method: POST
        description: Dapr Resume Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowComponentName
          in: path
          type: string
          description: The workflow component name.
          required: true
        - name: instanceId
          in: path
          type: string
          description: The workflow instance ID.
          required: true
    - name: v1.0-workflows-workflowComponentName-instanceId-terminate
      path: /v1.0/workflows/{workflowComponentName}/{instanceId}/terminate
      operations:
      - name: terminateworkflow
        method: POST
        description: Dapr Terminate Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowComponentName
          in: path
          type: string
          description: The workflow component name.
          required: true
        - name: instanceId
          in: path
          type: string
          description: The workflow instance ID.
          required: true
    - name: v1.0-workflows-workflowComponentName-workflowName-start
      path: /v1.0/workflows/{workflowComponentName}/{workflowName}/start
      operations:
      - name: startworkflow
        method: POST
        description: Dapr Start Workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowComponentName
          in: path
          type: string
          description: The workflow component name (e.g., dapr).
          required: true
        - name: workflowName
          in: path
          type: string
          description: The name of the workflow to start.
          required: true
        - name: instanceID
          in: query
          type: string
          description: Optional instance ID for the workflow. If not provided, a random ID is generated.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: workflow-workflow-rest
    port: 8080
    description: REST adapter for Dapr Workflow API — Workflow. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1-0/workflows/{workflowcomponentname}/{instanceid}
      name: v1-0-workflows-workflowcomponentname-instanceid
      description: REST surface for v1.0-workflows-workflowComponentName-instanceId.
      operations:
      - method: GET
        name: getworkflow
        description: Dapr Get Workflow
        call: workflow-workflow.getworkflow
        with:
          workflowComponentName: rest.workflowComponentName
          instanceId: rest.instanceId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1-0/workflows/{workflowcomponentname}/{instanceid}/pause
      name: v1-0-workflows-workflowcomponentname-instanceid-pause
      description: REST surface for v1.0-workflows-workflowComponentName-instanceId-pause.
      operations:
      - method: POST
        name: pauseworkflow
        description: Dapr Pause Workflow
        call: workflow-workflow.pauseworkflow
        with:
          workflowComponentName: rest.workflowComponentName
          instanceId: rest.instanceId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1-0/workflows/{workflowcomponentname}/{instanceid}/purge
      name: v1-0-workflows-workflowcomponentname-instanceid-purge
      description: REST surface for v1.0-workflows-workflowComponentName-instanceId-purge.
      operations:
      - method: POST
        name: purgeworkflow
        description: Dapr Purge Workflow
        call: workflow-workflow.purgeworkflow
        with:
          workflowComponentName: rest.workflowComponentName
          instanceId: rest.instanceId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1-0/workflows/{workflowcomponentname}/{instanceid}/raiseevent/{eventname}
      name: v1-0-workflows-workflowcomponentname-instanceid-raiseevent-eventname
      description: REST surface for v1.0-workflows-workflowComponentName-instanceId-raiseEvent-eventName.
      operations:
      - method: POST
        name: raiseworkflowevent
        description: Dapr Raise Workflow Event
        call: workflow-workflow.raiseworkflowevent
        with:
          workflowComponentName: rest.workflowComponentName
          instanceId: rest.instanceId
          eventName: rest.eventName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1-0/workflows/{workflowcomponentname}/{instanceid}/resume
      name: v1-0-workflows-workflowcomponentname-instanceid-resume
      description: REST surface for v1.0-workflows-workflowComponentName-instanceId-resume.
      operations:
      - method: POST
        name: resumeworkflow
        description: Dapr Resume Workflow
        call: workflow-workflow.resumeworkflow
        with:
          workflowComponentName: rest.workflowComponentName
          instanceId: rest.instanceId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1-0/workflows/{workflowcomponentname}/{instanceid}/terminate
      name: v1-0-workflows-workflowcomponentname-instanceid-terminate
      description: REST surface for v1.0-workflows-workflowComponentName-instanceId-terminate.
      operations:
      - method: POST
        name: terminateworkflow
        description: Dapr Terminate Workflow
        call: workflow-workflow.terminateworkflow
        with:
          workflowComponentName: rest.workflowComponentName
          instanceId: rest.instanceId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1-0/workflows/{workflowcomponentname}/{workflowname}/start
      name: v1-0-workflows-workflowcomponentname-workflowname-start
      description: REST surface for v1.0-workflows-workflowComponentName-workflowName-start.
      operations:
      - method: POST
        name: startworkflow
        description: Dapr Start Workflow
        call: workflow-workflow.startworkflow
        with:
          workflowComponentName: rest.workflowComponentName
          workflowName: rest.workflowName
          instanceID: rest.instanceID
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: workflow-workflow-mcp
    port: 9090
    transport: http
    description: MCP adapter for Dapr Workflow API — Workflow. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: dapr-get-workflow
      description: Dapr Get Workflow
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: workflow-workflow.getworkflow
      with:
        workflowComponentName: tools.workflowComponentName
        instanceId: tools.instanceId
      outputParameters:
      - type: object
        mapping: $.
    - name: dapr-pause-workflow
      description: Dapr Pause Workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: workflow-workflow.pauseworkflow
      with:
        workflowComponentName: tools.workflowComponentName
        instanceId: tools.instanceId
      outputParameters:
      - type: object
        mapping: $.
    - name: dapr-purge-workflow
      description: Dapr Purge Workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: workflow-workflow.purgeworkflow
      with:
        workflowComponentName: tools.workflowComponentName
        instanceId: tools.instanceId
      outputParameters:
      - type: object
        mapping: $.
    - name: dapr-raise-workflow-event
      description: Dapr Raise Workflow Event
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: workflow-workflow.raiseworkflowevent
      with:
        workflowComponentName: tools.workflowComponentName
        instanceId: tools.instanceId
        eventName: tools.eventName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: dapr-resume-workflow
      description: Dapr Resume Workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: workflow-workflow.resumeworkflow
      with:
        workflowComponentName: tools.workflowComponentName
        instanceId: tools.instanceId
      outputParameters:
      - type: object
        mapping: $.
    - name: dapr-terminate-workflow
      description: Dapr Terminate Workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: workflow-workflow.terminateworkflow
      with:
        workflowComponentName: tools.workflowComponentName
        instanceId: tools.instanceId
      outputParameters:
      - type: object
        mapping: $.
    - name: dapr-start-workflow
      description: Dapr Start Workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: workflow-workflow.startworkflow
      with:
        workflowComponentName: tools.workflowComponentName
        workflowName: tools.workflowName
        instanceID: tools.instanceID
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.