# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Flows API
  version: 1.0.0
extends: openapi/moengage-flows-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v5/flows/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search journey flows
      effect: read
      questions:
      - How do I find flows by status, tag or name?
      - Can I include archived flows when searching?
      - Which flows did a particular person create in a date range?
      instructions:
      - text: Search flows with status {status}.
        slots:
          status: requestBody.status
      - text: Find flows named {name} tagged {tags}.
        slots:
          name: requestBody.name
          tags: requestBody.tags
      - text: List flows created by {created_by}, archived ones included.
        slots:
          created_by: requestBody.created_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/flows/{flow_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a flow's full structure
      effect: read
      questions:
      - How do I see a flow's settings, targeting and stage-by-stage structure?
      - Can I view a flow by its version number instead of the latest published one?
      instructions:
      - text: Get flow {flow_id}.
        slots:
          flow_id: path.flow_id
      - text: Show flow {flow_id} as it was in version number {version_no}.
        slots:
          flow_id: path.flow_id
          version_no: query.version_no
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/flows/{flow_id}/versions/{version_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a past version of a flow by version ID
      effect: read
      questions:
      - How do I audit what a flow looked like before a recent change, using its version ID?
      - What does a specific historical version of a flow contain?
      instructions:
      - text: Get version {version_id} of flow {flow_id}.
        slots:
          version_id: path.version_id
          flow_id: path.flow_id
      - text: Show me flow {flow_id} exactly as it was at version ID {version_id}.
        slots:
          flow_id: path.flow_id
          version_id: path.version_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/flows/{flow_id}/status'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a flow's lifecycle state
      effect: write
      questions:
      - How do I pause, resume or stop a flow through the API?
      - What happens if I request a status change the flow can't make from its current state?
      instructions:
      - text: Apply action {action} to flow {flow_id} as {updated_by}.
        slots:
          action: requestBody.action
          flow_id: path.flow_id
          updated_by: requestBody.updated_by
      - text: Pause flow {flow_id}, updated by {updated_by}.
        slots:
          flow_id: path.flow_id
          updated_by: requestBody.updated_by
      method: generated
      generated: '2026-10-01'