# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kibana Workflows API
  version: 1.0.0
extends: openapi/elk-stack-workflows-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 31
- target: $.paths['/api/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List and search workflows
      effect: read
      questions:
      - How do I list the automation workflows defined in my Kibana space?
      - Can I filter workflows by tag, creator or whether they're enabled?
      - Which workflows are managed ones versus ones my team wrote?
      instructions:
      - text: List my workflows matching {query}.
        slots:
          query: query.query
      - text: Show enabled workflows tagged {tags}, sorted by {sortField}.
        slots:
          tags: query.tags
          sortField: query.sortField
      - text: Find workflows created by {createdBy}.
        slots:
          createdBy: query.createdBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create several workflows at once
      effect: write
      questions:
      - Can I import a batch of workflow definitions in a single request?
      - Is there a dry-run mode to check a bulk workflow import before it saves anything?
      instructions:
      - text: Bulk create workflows {workflows}.
        slots:
          workflows: requestBody.workflows
      - text: Bulk import {workflows}, overwriting existing ones when overwrite is {overwrite}.
        slots:
          workflows: requestBody.workflows
          overwrite: query.overwrite
      - text: Dry-run a bulk workflow creation of {workflows} without saving.
        slots:
          workflows: requestBody.workflows
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several workflows at once
      effect: destructive
      questions:
      - How do I delete a batch of workflows by their IDs in one call?
      - Can I force-delete multiple workflows even if they would normally be protected?
      instructions:
      - text: Bulk delete workflows {ids}.
        slots:
          ids: requestBody.ids
      - text: Force-delete the workflows with IDs {ids} using force {force}.
        slots:
          ids: requestBody.ids
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/aggs'].get
  update:
    x-apievangelist-phrasing:
      intent: Aggregate workflows by field
      effect: read
      questions:
      - How many workflows do I have per tag or per creator?
      - Can I get facet counts over my workflows for building filters?
      instructions:
      - text: Aggregate my workflows by fields {fields}.
        slots:
          fields: query.fields
      - text: Count managed workflows grouped by {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/connectors'].get
  update:
    x-apievangelist-phrasing:
      intent: List connectors available to workflows
      effect: read
      questions:
      - Which connectors can my workflow steps call?
      - What integrations are available to use inside a workflow?
      instructions:
      - text: List the connectors I can use in workflows.
      - text: Show available workflow connector types and instances.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/executions/{executionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow execution
      effect: read
      questions:
      - How do I check the status of one workflow run?
      - Can I see the input and output that a particular workflow execution used?
      instructions:
      - text: Get workflow execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Show execution {executionId} including its output.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/executions/{executionId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a workflow execution
      effect: destructive
      questions:
      - How do I stop a single workflow run that's stuck or running too long?
      - Can I cancel one specific execution without touching the workflow's other runs?
      instructions:
      - text: Cancel workflow execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Abort the running execution {executionId}.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/executions/{executionId}/children'].get
  update:
    x-apievangelist-phrasing:
      intent: List child executions of a workflow run
      effect: read
      questions:
      - Which sub-workflow runs did a parent workflow execution spawn?
      - How do I trace the child executions started by one workflow run?
      instructions:
      - text: List child executions of {executionId}.
        slots:
          executionId: path.executionId
      - text: Show sub-workflow runs spawned by execution {executionId}.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/executions/{executionId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get logs for a workflow execution
      effect: read
      questions:
      - Where can I read the logs of a failed workflow run?
      - Can I narrow execution logs down to a single step?
      instructions:
      - text: Get logs for workflow execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Show logs of execution {executionId} for step run {stepExecutionId}.
        slots:
          executionId: path.executionId
          stepExecutionId: query.stepExecutionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/executions/{executionId}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused workflow execution
      effect: write
      questions:
      - How do I continue a workflow run that's waiting for input?
      - Can I pass values back into a paused execution when resuming it from inside Kibana?
      instructions:
      - text: Resume execution {executionId} with input {input}.
        slots:
          executionId: path.executionId
          input: requestBody.input
      - text: Continue paused workflow run {executionId}, supplying {input}.
        slots:
          executionId: path.executionId
          input: requestBody.input
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/executions/{executionId}/step/{stepExecutionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one step execution of a workflow run
      effect: read
      questions:
      - How do I inspect what happened in a single step of a workflow run?
      - Can I see the result of one step execution by its ID?
      instructions:
      - text: Get step execution {stepExecutionId} of run {executionId}.
        slots:
          stepExecutionId: path.stepExecutionId
          executionId: path.executionId
      - text: Show the details of step run {stepExecutionId} in execution {executionId}.
        slots:
          stepExecutionId: path.stepExecutionId
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/executions/{executionId}/steps/{stepId}/resume/external'].get
  update:
    x-apievangelist-phrasing:
      intent: Approve or reject a paused step via external link
      effect: write
      questions:
      - Can someone outside Kibana approve a paused workflow step from a link?
      - What does the token in an external approval link for a workflow step do?
      instructions:
      - text: Approve step {stepId} of execution {executionId} using link token {token}.
        slots:
          stepId: path.stepId
          executionId: path.executionId
          token: query.token
      - text: Reject paused step {stepId} in run {executionId} with token {token} and approved {approved}.
        slots:
          stepId: path.stepId
          executionId: path.executionId
          token: query.token
          approved: query.approved
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/executions/{executionId}/steps/{stepId}/resume/external'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit external form input to a paused step
      effect: write
      questions:
      - How does an external user submit form data to a paused workflow step?
      - Can an outside reviewer post their answers into a waiting workflow run?
      instructions:
      - text: Submit form input to step {stepId} of run {executionId} with token {token}.
        slots:
          stepId: path.stepId
          executionId: path.executionId
          token: query.token
      - text: Post the external reviewer's answers for {stepId} in execution {executionId} using token {token}.
        slots:
          stepId: path.stepId
          executionId: path.executionId
          token: query.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/executions/{executionId}/steps/{stepId}/resume/external/form'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the external input form for a paused step
      effect: read
      questions:
      - What form does an external reviewer see for a paused workflow step?
      - Can I fetch the input fields a waiting step expects before submitting them?
      instructions:
      - text: Get the external form for step {stepId} in run {executionId} with token {token}.
        slots:
          stepId: path.stepId
          executionId: path.executionId
          token: query.token
      - text: Show the fields paused step {stepId} of {executionId} is asking for, using token {token}.
        slots:
          stepId: path.stepId
          executionId: path.executionId
          token: query.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export workflows
      effect: read
      questions:
      - How do I export workflow definitions to move them to another space or cluster?
      - Can I back up a selected set of workflows as files?
      instructions:
      - text: Export workflows {ids}.
        slots:
          ids: requestBody.ids
      - text: Download the definitions of workflows {ids} for backup.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/managed/workflow/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a managed workflow
      effect: write
      questions:
      - Can I change a managed (system-provided) workflow's YAML or enable it?
      - How do I disable a managed workflow I don't need?
      instructions:
      - text: Update managed workflow {id} with YAML {yaml}.
        slots:
          id: path.id
          yaml: requestBody.yaml
      - text: Set managed workflow {id} enabled to {enabled}.
        slots:
          id: path.id
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/mget'].post
  update:
    x-apievangelist-phrasing:
      intent: Get several workflows by ID
      effect: read
      questions:
      - Can I fetch a handful of workflows by their IDs in one request?
      - Is it possible to limit which fields come back when looking up workflows by ID?
      instructions:
      - text: Fetch workflows {ids}.
        slots:
          ids: requestBody.ids
      - text: Look up workflows {ids} returning only fields {source}.
        slots:
          ids: requestBody.ids
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the workflow definition JSON schema
      effect: read
      questions:
      - Where can I get the JSON schema for validating workflow YAML in my editor?
      - Is there a looser version of the workflow schema for partial definitions?
      instructions:
      - text: Get the workflow JSON schema with loose mode {loose}.
        slots:
          loose: query.loose
      - text: Download the strict schema for workflow definitions, loose set to {loose}.
        slots:
          loose: query.loose
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get workflow statistics
      effect: read
      questions:
      - How many workflows and executions do I have overall?
      - What are the usage stats for workflows in this space?
      instructions:
      - text: Show workflow statistics.
      - text: Summarize my workflow and execution counts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/step/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a single workflow step
      effect: write
      questions:
      - Can I run just one step of a workflow to debug it?
      - How do I test a step with a mocked context before running the whole workflow?
      instructions:
      - text: Test step {stepId} of workflow YAML {workflowYaml} with context {contextOverride}.
        slots:
          stepId: requestBody.stepId
          workflowYaml: requestBody.workflowYaml
          contextOverride: requestBody.contextOverride
      - text: Run only step {stepId} from {workflowYaml} using overridden context {contextOverride}.
        slots:
          stepId: requestBody.stepId
          workflowYaml: requestBody.workflowYaml
          contextOverride: requestBody.contextOverride
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test run a whole workflow
      effect: write
      questions:
      - Can I try out a workflow definition before saving it?
      - How do I test-run a draft workflow with sample inputs?
      instructions:
      - text: Test workflow YAML {workflowYaml} with inputs {inputs}.
        slots:
          workflowYaml: requestBody.workflowYaml
          inputs: requestBody.inputs
      - text: Do a test run of saved workflow {workflowId} using inputs {inputs}.
        slots:
          workflowId: requestBody.workflowId
          inputs: requestBody.inputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/workflow'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workflow
      effect: write
      questions:
      - How do I create a new automation workflow from YAML?
      - Can I choose the ID of a workflow when I create it?
      instructions:
      - text: Create a workflow from YAML {yaml}.
        slots:
          yaml: requestBody.yaml
      - text: Create workflow {id} defined by {yaml}.
        slots:
          id: requestBody.id
          yaml: requestBody.yaml
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/workflow/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow
      effect: read
      questions:
      - How do I view a single workflow's definition and settings?
      - Can I see the YAML behind a workflow by its ID?
      instructions:
      - text: Get workflow {id}.
        slots:
          id: path.id
      - text: Show the definition of workflow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/workflow/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a workflow
      effect: write
      questions:
      - How do I edit the YAML or name of a workflow I created?
      - Can I turn one of my workflows off without deleting it?
      instructions:
      - text: Update workflow {id} with YAML {yaml}.
        slots:
          id: path.id
          yaml: requestBody.yaml
      - text: Rename workflow {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Disable my workflow {id} by setting enabled to {enabled}.
        slots:
          id: path.id
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/workflow/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workflow
      effect: destructive
      questions:
      - How do I delete one workflow permanently?
      - Can I force the deletion of a single workflow?
      instructions:
      - text: Delete workflow {id}.
        slots:
          id: path.id
      - text: Remove workflow {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/workflow/{id}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a workflow
      effect: write
      questions:
      - Can I duplicate an existing workflow as a starting point for a new one?
      - How do I make a copy of a workflow?
      instructions:
      - text: Clone workflow {id}.
        slots:
          id: path.id
      - text: Make a copy of workflow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/workflow/{id}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a workflow
      effect: write
      questions:
      - How do I trigger a saved workflow manually?
      - Can I pass inputs and metadata when starting a workflow run?
      instructions:
      - text: Run workflow {id} with inputs {inputs}.
        slots:
          id: path.id
          inputs: requestBody.inputs
      - text: Start workflow {id} using inputs {inputs} and metadata {metadata}.
        slots:
          id: path.id
          inputs: requestBody.inputs
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/workflow/{workflowId}/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List executions of one workflow
      effect: read
      questions:
      - How do I see the run history of one particular workflow?
      - Can I filter a workflow's executions to only failed ones in a date range?
      instructions:
      - text: List executions of workflow {workflowId}.
        slots:
          workflowId: path.workflowId
      - text: Show runs of workflow {workflowId} with status {statuses} started after {startedAfter}.
        slots:
          workflowId: path.workflowId
          statuses: query.statuses
          startedAfter: query.startedAfter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/workflow/{workflowId}/executions/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel all active runs of a workflow
      effect: destructive
      questions:
      - How do I stop every running execution of one workflow at once?
      - Can I halt all in-progress runs of a workflow that's misbehaving?
      instructions:
      - text: Cancel all active executions of workflow {workflowId}.
        slots:
          workflowId: path.workflowId
      - text: Stop every in-flight run of {workflowId}.
        slots:
          workflowId: path.workflowId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/workflow/{workflowId}/executions/steps'].get
  update:
    x-apievangelist-phrasing:
      intent: List step executions across a workflow's runs
      effect: read
      questions:
      - How do I see how one step has performed across all runs of a workflow?
      - Can I pull the step-level execution history of a workflow with inputs and outputs?
      instructions:
      - text: List step executions for workflow {workflowId}.
        slots:
          workflowId: path.workflowId
      - text: Show every run of step {stepId} in workflow {workflowId} including output.
        slots:
          stepId: query.stepId
          workflowId: path.workflowId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/workflows/workflow/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: Search executions across all workflows
      effect: read
      questions:
      - How do I search workflow runs across every workflow in the space?
      - Can I query all executions with KQL, for example everything that failed yesterday?
      instructions:
      - text: Search all workflow executions matching KQL {kql}.
        slots:
          kql: query.kql
      - text: Find executions across all workflows with status {statuses} finished before {finishedBefore}.
        slots:
          statuses: query.statuses
          finishedBefore: query.finishedBefore
      method: generated
      generated: '2026-09-26'