Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Flow Service API - Sources Flows API

8 actions 8 updates phrasing extends openapi/adobe-suite-flows-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/flows'].get
$.paths['/flows'].post
$.paths['/flows/{FLOW_ID}'].get
$.paths['/flows/{FLOW_ID}'].delete
$.paths['/flows/{FLOW_ID}'].patch
$.paths['/flows/search'].post
$.paths['/flows/{FLOW_ID}/action'].post

OpenAPI Overlay

Raw ↑
# 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 Flows API
  version: 1.0.0
extends: openapi/adobe-suite-flows-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: 7
- target: $.paths['/flows'].get
  update:
    x-apievangelist-phrasing:
      intent: List dataflows in the organization
      effect: read
      questions:
      - How do I see all the dataflows set up in my Experience Platform organization?
      - Can I sort the flow list or cap how many come back?
      - Is there a way to get just the count of flows?
      instructions:
      - text: List the first {limit} flows.
        slots:
          limit: query.limit
      - text: List flows ordered by {orderby}.
        slots:
          orderby: query.orderby
      - text: Get the next page of flows using token {continuationToken}.
        slots:
          continuationToken: query.continuationToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dataflow
      effect: write
      questions:
      - What do I need to create a dataflow connecting a source to a target?
      - Can I give a new flow a schedule and transformations when I create it?
      instructions:
      - text: Create a flow named {name} using flow spec {flowSpec}.
        slots:
          name: requestBody.name
          flowSpec: requestBody.flowSpec
      - text: Set up a flow from source connections {sourceConnectionIds} to target connections {targetConnectionIds} with spec {flowSpec}.
        slots:
          sourceConnectionIds: requestBody.sourceConnectionIds
          targetConnectionIds: requestBody.targetConnectionIds
          flowSpec: requestBody.flowSpec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flows/{FLOW_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dataflow's details
      effect: read
      questions:
      - How can I check the configuration of one specific dataflow?
      - Can I see a single flow's schedule and connections?
      instructions:
      - text: Show the details of flow {FLOW_ID}.
        slots:
          FLOW_ID: path.FLOW_ID
      - text: Look up dataflow {FLOW_ID}.
        slots:
          FLOW_ID: path.FLOW_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flows/{FLOW_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dataflow
      effect: destructive
      questions:
      - Can I delete a dataflow I no longer need?
      - What removes a flow permanently from my sandbox?
      instructions:
      - text: Delete flow {FLOW_ID}.
        slots:
          FLOW_ID: path.FLOW_ID
      - text: Remove dataflow {FLOW_ID} from the sandbox.
        slots:
          FLOW_ID: path.FLOW_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flows/{FLOW_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a dataflow
      effect: write
      questions:
      - How do I change settings on an existing dataflow?
      - Why does updating a flow require an If-Match version tag?
      instructions:
      - text: Update flow {FLOW_ID} with the changes I describe.
        slots:
          FLOW_ID: path.FLOW_ID
      - text: Patch dataflow {FLOW_ID} at version {if-match}.
        slots:
          FLOW_ID: path.FLOW_ID
          if-match: header.if-match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flows/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search dataflows by filter criteria
      effect: read
      questions:
      - Can I search flows with a query string instead of listing them all?
      - Which flows match a filter across several active sandboxes?
      instructions:
      - text: Search flows matching {queryString}.
        slots:
          queryString: requestBody.queryString
      - text: Find up to {limit} flows where {queryString}, sorted by {orderby}.
        slots:
          limit: requestBody.limit
          queryString: requestBody.queryString
          orderby: requestBody.orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flows/{FLOW_ID}/action'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a dataflow's state
      effect: write
      questions:
      - How do I enable, disable or otherwise change the state of a dataflow?
      - Can I report progress or status on a flow as part of a state change?
      instructions:
      - text: Perform action {op} with sub-action {subOp} on flow {FLOW_ID}.
        slots:
          op: query.op
          subOp: query.subOp
          FLOW_ID: path.FLOW_ID
      - text: Transition flow {FLOW_ID} via {op}/{subOp} with status {status}.
        slots:
          FLOW_ID: path.FLOW_ID
          op: query.op
          subOp: query.subOp
          status: requestBody.status
      method: generated
      generated: '2026-09-26'