# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Flow Service API - Sources Runs API
  version: 1.0.0
extends: openapi/adobe-suite-runs-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: 5
- target: $.paths['/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List dataflow runs
      effect: read
      questions:
      - Which dataflow runs have happened in our organization?
      - Can I filter flow runs by a property like flow ID and get just a count?
      instructions:
      - text: List flow runs where {property}.
        slots:
          property: query.property
      - text: Show the latest {limit} flow runs ordered by {orderby}.
        slots:
          limit: query.limit
          orderby: query.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new run for a flow
      effect: write
      questions:
      - How do I trigger an on-demand run of an existing dataflow?
      - Can I pass parameters when kicking off a flow run?
      instructions:
      - text: Start a new run for flow {flowId}.
        slots:
          flowId: requestBody.flowId
      - text: Run flow {flowId} with params {params}.
        slots:
          flowId: requestBody.flowId
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/runs/{RUN_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one dataflow run
      effect: read
      questions:
      - What is the status and metrics of one specific flow run?
      - How do I check whether a particular dataflow run succeeded?
      instructions:
      - text: Show flow run {RUN_ID}.
        slots:
          RUN_ID: path.RUN_ID
      - text: Check the result of run {RUN_ID}.
        slots:
          RUN_ID: path.RUN_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/runs/{RUN_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a dataflow run
      effect: write
      questions:
      - Can I update the metrics or activities recorded on a flow run?
      - Why does updating a flow run need an If-Match etag?
      instructions:
      - text: Update run {RUN_ID} at version {etag} with metrics {metrics}.
        slots:
          RUN_ID: path.RUN_ID
          etag: header.If-Match
          metrics: requestBody.metrics
      - text: Set params {params} on flow run {RUN_ID} (etag {etag}).
        slots:
          params: requestBody.params
          RUN_ID: path.RUN_ID
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/runs/{RUN_ID}/action'].post
  update:
    x-apievangelist-phrasing:
      intent: Perform an action on a flow run
      effect: write
      questions:
      - Can I cancel or otherwise act on a running dataflow run?
      - Which operation does the flow run action endpoint expect?
      instructions:
      - text: Perform action {op} on flow run {RUN_ID}.
        slots:
          op: query.op
          RUN_ID: path.RUN_ID
      - text: Apply {op} to run {RUN_ID}.
        slots:
          op: query.op
          RUN_ID: path.RUN_ID
      method: generated
      generated: '2026-09-26'