Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Flow Service API - Destinations Dataflows API

6 actions 6 updates phrasing extends openapi/adobe-suite-dataflows-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 6

$.info

$.paths['/flows'].get

$.paths['/flows'].post

$.paths['/flows/{id}'].get

$.paths['/flows/{id}'].delete

$.paths['/flows/{id}'].patch

OpenAPI Overlay

# 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 - Destinations Dataflows API
  version: 1.0.0
extends: openapi/adobe-suite-dataflows-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['/flows'].get
  update:
    x-apievangelist-phrasing:
      intent: List destination dataflows
      effect: read
      questions:
      - Which destination dataflows are set up for my organization?
      - Can I get just a count of destination dataflows instead of the full list?
      instructions:
      - text: List all destination dataflows in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show {limit} destination dataflows filtered by {property}.
        slots:
          limit: query.limit
          property: query.property
      - text: Get the next page of dataflows using token {continuationToken}.
        slots:
          continuationToken: query.continuationToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a destination dataflow
      effect: write
      questions:
      - How do I set up a dataflow to activate data to a destination?
      - Can I connect Experience Platform audiences to a new destination through the API?
      instructions:
      - text: Create a destination dataflow in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Set up a new dataflow that activates data to a destination.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flows/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a destination dataflow
      effect: read
      questions:
      - What's the configuration of a specific destination dataflow?
      - Can I inspect one dataflow by its ID?
      instructions:
      - text: Show destination dataflow {id}.
        slots:
          id: path.id
      - text: Get the details of dataflow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flows/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a destination dataflow
      effect: destructive
      questions:
      - How do I stop and remove a destination dataflow?
      - Can I delete a dataflow I no longer need?
      instructions:
      - text: Delete destination dataflow {id}.
        slots:
          id: path.id
      - text: Remove dataflow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flows/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a destination dataflow
      effect: write
      questions:
      - Can I change the configuration of an existing destination dataflow?
      - Why do I need the eTag to update a dataflow?
      instructions:
      - text: Update destination dataflow {id} using eTag {etag}.
        slots:
          id: path.id
          etag: header.if-match
      - text: Patch the configuration of dataflow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'