Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for File Storage Subpackage Folders API

5 actions 5 updates phrasing extends openapi/merge-subpackage-folders-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 5

$.info
$.paths['/filestorage/v1/folders'].get
$.paths['/filestorage/v1/folders'].post
$.paths['/filestorage/v1/folders/{id}'].get
$.paths['/filestorage/v1/folders/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 Folders API
  version: 1.0.0
extends: openapi/merge-subpackage-folders-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: 4
- target: $.paths['/filestorage/v1/folders'].get
  update:
    x-apievangelist-phrasing:
      intent: List folders
      effect: read
      questions:
      - Can I list the folders in a customer's cloud storage?
      - Which folders sit inside a given parent folder or drive?
      instructions:
      - text: List folders in parent folder {parent_folder_id}.
        slots:
          parent_folder_id: query.parent_folder_id
      - text: Show folders on drive {drive_id}.
        slots:
          drive_id: query.drive_id
      - text: Find folders named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/folders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a folder
      effect: write
      questions:
      - How do I create a new folder in a customer's file storage?
      - Can folder creation run asynchronously?
      instructions:
      - text: Create folder {folder}.
        slots:
          folder: requestBody.model
      - text: Make a new storage folder {folder} asynchronously {run_async}.
        slots:
          folder: requestBody.model
          run_async: query.run_async
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/folders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a folder
      effect: read
      questions:
      - Can I look up one folder by its ID?
      - What details come back for a single storage folder?
      instructions:
      - text: Get folder {id}.
        slots:
          id: path.id
      - text: Show me storage folder {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/folders/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields required to create a folder
      effect: read
      questions:
      - Which fields are required to create a folder in this storage provider?
      - What does the file storage integration accept when posting a folder?
      instructions:
      - text: Show folder creation fields for account token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get the create metadata for folders.
      method: generated
      generated: '2026-09-26'