Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CRM Subpackage Associations API

3 actions 3 updates phrasing extends openapi/merge-subpackage-associations-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/{custom_object_class_id}/custom-objects/{object_id}/associations'].get

$.paths['/crm/v1/custom-object-classes/{source_class_id}/custom-objects/{source_object_id}/associations/{target_class_id}/{target_object_id}/{association_type_id}'].put

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 Associations API
  version: 1.0.0
extends: openapi/merge-subpackage-associations-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/{custom_object_class_id}/custom-objects/{object_id}/associations'].get
  update:
    x-apievangelist-phrasing:
      intent: List associations of a custom object record
      effect: read
      questions:
      - What other records is a given custom object linked to in the CRM?
      - Can I filter a record's associations to one association type?
      instructions:
      - text: List associations for object {object_id} in class {class_id}.
        slots:
          object_id: path.object_id
          class_id: path.custom_object_class_id
      - text: Show links of type {association_type_id} for record {object_id} in class {class_id}.
        slots:
          association_type_id: query.association_type_id
          object_id: path.object_id
          class_id: path.custom_object_class_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/custom-object-classes/{source_class_id}/custom-objects/{source_object_id}/associations/{target_class_id}/{target_object_id}/{association_type_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Link two CRM records with an association
      effect: write
      questions:
      - How do I associate one CRM custom object record with another?
      - Can I create a typed relationship between records in different classes?
      instructions:
      - text: Associate {source_object_id} in class {source_class_id} with {target_object_id} in class {target_class_id} as type {association_type_id}.
        slots:
          source_object_id: path.source_object_id
          source_class_id: path.source_class_id
          target_object_id: path.target_object_id
          target_class_id: path.target_class_id
          association_type_id: path.association_type_id
      - text: Link record {source_object_id} ({source_class_id}) to {target_object_id} ({target_class_id}) using association {association_type_id}.
        slots:
          source_object_id: path.source_object_id
          source_class_id: path.source_class_id
          target_object_id: path.target_object_id
          target_class_id: path.target_class_id
          association_type_id: path.association_type_id
      method: generated
      generated: '2026-09-26'