Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Firefly Services - InDesign Data Merge API

3 actions 3 updates phrasing extends openapi/adobe-suite-data-merge-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 3

$.info
$.paths['/v3/merge-data'].post
$.paths['/v3/merge-data-tags'].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 Firefly Services - InDesign Data Merge API
  version: 1.0.0
extends: openapi/adobe-suite-data-merge-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: 2
- target: $.paths['/v3/merge-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge CSV data into an InDesign template
      effect: write
      questions:
      - How do I generate personalized PDFs by merging a CSV into an InDesign template?
      - Which output formats can an InDesign data merge produce?
      instructions:
      - text: Run a data merge with {params}.
        slots:
          params: requestBody.params
      - text: Merge my CSV into the InDesign template and output PDFs using {params}.
        slots:
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/merge-data-tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the data merge tags in a document
      effect: read
      questions:
      - Which data merge fields does my InDesign template expect?
      - Can I inspect a document's merge tags before running a merge?
      instructions:
      - text: List the data merge tags in {assets}.
        slots:
          assets: requestBody.assets
      - text: Read merge tags from document {assets} with {params}.
        slots:
          assets: requestBody.assets
          params: requestBody.params
      method: generated
      generated: '2026-09-26'