Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CRM Subpackage Association Types API

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

$.info
$.paths['/crm/v1/custom-object-classes/{custom_object_class_id}/association-types'].get
$.paths['/crm/v1/custom-object-classes/{custom_object_class_id}/association-types'].post
$.paths['/crm/v1/custom-object-classes/{custom_object_class_id}/association-types/{id}'].get
$.paths['/crm/v1/custom-object-classes/{custom_object_class_id}/association-types/meta/post'].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 Association Types API
  version: 1.0.0
extends: openapi/merge-subpackage-associationtypes-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: 4
- target: $.paths['/crm/v1/custom-object-classes/{custom_object_class_id}/association-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List association types for a custom object class
      effect: read
      questions:
      - What kinds of relationships can a CRM custom object type have?
      - Can I list the association types defined on one custom object class?
      instructions:
      - text: List association types for custom object class {class_id}.
        slots:
          class_id: path.custom_object_class_id
      - text: Show relationship types on class {class_id} created after {created_after}.
        slots:
          class_id: path.custom_object_class_id
          created_after: query.created_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/custom-object-classes/{custom_object_class_id}/association-types'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an association type on a custom object class
      effect: write
      questions:
      - How do I define a new relationship type between CRM custom objects?
      - Can I create an association type asynchronously?
      instructions:
      - text: Create association type {association_type} on class {class_id}.
        slots:
          association_type: requestBody.model
          class_id: path.custom_object_class_id
      - text: Define relationship type {association_type} for custom object class {class_id} with debug {is_debug_mode}.
        slots:
          association_type: requestBody.model
          class_id: path.custom_object_class_id
          is_debug_mode: query.is_debug_mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/custom-object-classes/{custom_object_class_id}/association-types/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an association type
      effect: read
      questions:
      - Can I look up one association type on a custom object class?
      - What cardinality and targets does a given relationship type have?
      instructions:
      - text: Get association type {id} on class {class_id}.
        slots:
          id: path.id
          class_id: path.custom_object_class_id
      - text: Show relationship type {id} for custom object class {class_id}.
        slots:
          id: path.id
          class_id: path.custom_object_class_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/custom-object-classes/{custom_object_class_id}/association-types/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields required to create an association type
      effect: read
      questions:
      - Which fields must I send to create an association type?
      - What does the CRM accept when posting a new relationship type?
      instructions:
      - text: Show association type creation fields for class {class_id}.
        slots:
          class_id: path.custom_object_class_id
      - text: Get the create metadata for relationship types on class {class_id}.
        slots:
          class_id: path.custom_object_class_id
      method: generated
      generated: '2026-09-26'