Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CRM Subpackage Stages API

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

$.paths['/crm/v1/stages/{id}'].get

$.paths['/crm/v1/stages/remote-field-classes'].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 CRM Subpackage Stages API
  version: 1.0.0
extends: openapi/merge-subpackage-stages-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['/crm/v1/stages'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM pipeline stages
      effect: read
      questions:
      - What deal stages exist in a customer's CRM pipeline?
      - Can I get only the stages changed since a certain date?
      instructions:
      - text: List CRM stages for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show pipeline stages modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/stages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CRM pipeline stage
      effect: read
      questions:
      - What's the name of a specific opportunity stage?
      - Can I include custom remote fields when fetching one stage?
      instructions:
      - text: Get CRM stage {id}.
        slots:
          id: path.id
      - text: Fetch deal stage {id} with its remote data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/stages/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for stages
      effect: read
      questions:
      - Which custom fields are defined on pipeline stages in the CRM?
      - Can I list only the standard stage field classes?
      instructions:
      - text: List stage remote field classes for account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show stage field classes where common model field is {is_common_model_field}.
        slots:
          is_common_model_field: query.is_common_model_field
      method: generated
      generated: '2026-09-26'