Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Chat Subpackage Conversations API

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

$.info

$.paths['/conversations'].get

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

$.paths['/conversations/{conversation_id}/members'].get

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 Chat Subpackage Conversations API
  version: 1.0.0
extends: openapi/merge-subpackage-conversations-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: 3
- target: $.paths['/conversations'].get
  update:
    x-apievangelist-phrasing:
      intent: List chat conversations
      effect: read
      questions:
      - Which channels and conversations exist in a linked chat workspace?
      - Can I list conversations changed since yesterday?
      instructions:
      - text: List chat conversations modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      - text: Show conversations for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chat conversation
      effect: read
      questions:
      - How do I pull the details of one channel or conversation?
      - What does the chat platform return for a single conversation?
      instructions:
      - text: Get conversation {id}.
        slots:
          id: path.id
      - text: Fetch chat channel {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/{conversation_id}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of a chat conversation
      effect: read
      questions:
      - Who is in a particular chat channel?
      - Can I page through the members of a large conversation?
      instructions:
      - text: List members of conversation {conversation_id}.
        slots:
          conversation_id: path.conversation_id
      - text: Show {page_size} participants at a time in channel {conversation_id}.
        slots:
          page_size: query.page_size
          conversation_id: path.conversation_id
      method: generated
      generated: '2026-09-26'