Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for File Storage Subpackage Files API

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

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/filestorage/v1/files'].get
$.paths['/filestorage/v1/files'].post
$.paths['/filestorage/v1/files/{id}'].get
$.paths['/filestorage/v1/files/{id}/download'].get
$.paths['/filestorage/v1/files/{id}/download/request-meta'].get
$.paths['/filestorage/v1/files/download/request-meta'].get
$.paths['/filestorage/v1/files/meta/post'].get

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 File Storage Subpackage Files API
  version: 1.0.0
extends: openapi/merge-subpackage-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: 7
- target: $.paths['/filestorage/v1/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List files in connected file storage
      effect: read
      questions:
      - Can I list every file inside a particular folder of a customer's cloud drive?
      - Which files match a given name or MIME type across a connected drive?
      instructions:
      - text: List files in folder {folder_id}.
        slots:
          folder_id: query.folder_id
      - text: Find files named {name} on drive {drive_id}.
        slots:
          name: query.name
          drive_id: query.drive_id
      - text: List {mime_type} files modified after {modified_after}.
        slots:
          mime_type: query.mime_type
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to connected file storage
      effect: write
      questions:
      - How do I upload a new file into a customer's cloud drive?
      - Can a file upload run asynchronously?
      instructions:
      - text: Upload file {model} to linked account {account_token}.
        slots:
          model: requestBody.model
          account_token: header.X-Account-Token
      - text: Create a new file in storage with {model}.
        slots:
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/files/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file's metadata
      effect: read
      questions:
      - Which folder and drive does a specific file belong to?
      - Can I expand the parent folder and drive of a single file?
      instructions:
      - text: Get file {id} details.
        slots:
          id: path.id
      - text: Fetch metadata for file {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/files/{id}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a file's contents
      effect: read
      questions:
      - Can I download the actual bytes of a file from a customer's drive?
      - Can I pick an export format such as PDF when downloading a document?
      instructions:
      - text: Download file {id}.
        slots:
          id: path.id
      - text: Download file {id} converted to {mime_type}.
        slots:
          id: path.id
          mime_type: query.mime_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/files/{id}/download/request-meta'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a direct download request for one file
      effect: read
      questions:
      - Can I download a file straight from the third-party provider instead of streaming it through the unified API?
      - What URL and headers do I need to fetch one file directly from the source?
      instructions:
      - text: Get direct-download request metadata for file {id}.
        slots:
          id: path.id
      - text: Build an authenticated source download request for file {id} as {mime_type}.
        slots:
          id: path.id
          mime_type: query.mime_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/files/download/request-meta'].get
  update:
    x-apievangelist-phrasing:
      intent: Get direct download requests for many files
      effect: read
      questions:
      - Can I get direct third-party download requests for a batch of files at once?
      - Which files modified recently can I bulk download straight from the source?
      instructions:
      - text: Get direct download requests for files {ids}.
        slots:
          ids: query.ids
      - text: List source download requests for {mime_types} files changed since {modified_after}.
        slots:
          mime_types: query.mime_types
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/files/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields for uploading files
      effect: read
      questions:
      - Which fields does a storage integration require when uploading a file?
      - What must a new file request include for a given drive?
      instructions:
      - text: Show file POST metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Describe the create fields for new storage files.
      method: generated
      generated: '2026-09-26'