Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Chat Subpackage Messages API

4 actions 4 updates phrasing extends openapi/merge-subpackage-messages-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['/messages'].get

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

$.paths['/messages/{message_id}/replies'].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 Messages API
  version: 1.0.0
extends: openapi/merge-subpackage-messages-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['/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List chat messages
      effect: read
      questions:
      - Can I pull messages from a conversation in a customer's chat tool?
      - Is there a way to get only top-level messages and skip thread replies?
      instructions:
      - text: List messages in conversation {conversation_id}.
        slots:
          conversation_id: query.conversation_id
      - text: Show only root messages {root_message} ordered by {order_by}.
        slots:
          root_message: query.root_message
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/messages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chat message
      effect: read
      questions:
      - Can I fetch one chat message by its ID?
      - What content and author details come back for a single message?
      instructions:
      - text: Get message {id}.
        slots:
          id: path.id
      - text: Show me chat message {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/messages/{message_id}/replies'].get
  update:
    x-apievangelist-phrasing:
      intent: List replies in a message thread
      effect: read
      questions:
      - Can I list every reply in a chat thread?
      - Which replies were posted to a given message, newest first?
      instructions:
      - text: List replies to message {message_id}.
        slots:
          message_id: path.message_id
      - text: Show the thread replies on message {message_id} ordered by {order_by}.
        slots:
          message_id: path.message_id
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'