Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data Access Files API

3 actions 3 updates phrasing extends openapi/adobe-suite-files-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['/files/{dataSetFileId}'].get
$.paths['/files/{dataSetFileId}'].head

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 Data Access Files API
  version: 1.0.0
extends: openapi/adobe-suite-files-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['/files/{dataSetFileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a dataset file or list its chunks
      effect: read
      questions:
      - How do I download a dataset file from Experience Platform?
      - Can I list the chunked parts that make up a dataset file?
      instructions:
      - text: Retrieve dataset file {dataSetFileId}.
        slots:
          dataSetFileId: path.dataSetFileId
      - text: Download the file at {path} within dataset file {dataSetFileId}.
        slots:
          path: query.path
          dataSetFileId: path.dataSetFileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/files/{dataSetFileId}'].head
  update:
    x-apievangelist-phrasing:
      intent: Get a dataset file's headers only
      effect: read
      questions:
      - Can I check a dataset file's size and type without downloading it?
      - How do I read just the headers of a file in a dataset?
      instructions:
      - text: Get the headers of {path} in dataset file {dataSetFileId}.
        slots:
          path: query.path
          dataSetFileId: path.dataSetFileId
      - text: Check the metadata headers for file {path} of {dataSetFileId} without downloading it.
        slots:
          path: query.path
          dataSetFileId: path.dataSetFileId
      method: generated
      generated: '2026-09-26'