Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CRM Subpackage Custom Object Classes API

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

$.info
$.paths['/crm/v1/custom-object-classes'].get
$.paths['/crm/v1/custom-object-classes/{id}'].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 CRM Subpackage Custom Object Classes API
  version: 1.0.0
extends: openapi/merge-subpackage-customobjectclasses-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: 2
- target: $.paths['/crm/v1/custom-object-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM custom object classes
      effect: read
      questions:
      - What custom object types has a customer defined in their CRM?
      - Can I see which custom object classes were added recently?
      instructions:
      - text: List custom object classes for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show custom object classes created after {created_after}.
        slots:
          created_after: query.created_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/custom-object-classes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CRM custom object class
      effect: read
      questions:
      - Which fields make up a specific custom object class in the CRM?
      - Can I expand the field definitions on one custom object class?
      instructions:
      - text: Get custom object class {id}.
        slots:
          id: path.id
      - text: Fetch custom object class {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'