Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CRM Subpackage Tasks API

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

$.info
$.paths['/crm/v1/tasks'].get
$.paths['/crm/v1/tasks'].post
$.paths['/crm/v1/tasks/{id}'].get
$.paths['/crm/v1/tasks/meta/patch/{id}'].get
$.paths['/crm/v1/tasks/meta/post'].get
$.paths['/crm/v1/tasks/remote-field-classes'].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 Tasks API
  version: 1.0.0
extends: openapi/merge-subpackage-tasks-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: 6
- target: $.paths['/crm/v1/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM tasks
      effect: read
      questions:
      - Can I pull every to-do from a customer's CRM?
      - Which CRM tasks were modified recently?
      instructions:
      - text: List CRM tasks modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      - text: Show tasks created before {created_before}.
        slots:
          created_before: query.created_before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a CRM task
      effect: write
      questions:
      - How do I add a follow-up task in a customer's CRM?
      - Can I create a CRM task with debug logs returned?
      instructions:
      - text: Create task {task} in the CRM.
        slots:
          task: requestBody.model
      - text: Add follow-up task {task} asynchronously {run_async}.
        slots:
          task: requestBody.model
          run_async: query.run_async
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/tasks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CRM task
      effect: read
      questions:
      - Can I look up one CRM task by its ID?
      - What's recorded on a single to-do in the CRM?
      instructions:
      - text: Get task {id}.
        slots:
          id: path.id
      - text: Show me CRM task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/tasks/meta/patch/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields allowed when updating a task
      effect: read
      questions:
      - Which fields on a particular CRM task can be changed?
      - What does the CRM let me edit on an existing task?
      instructions:
      - text: Show editable fields for task {id}.
        slots:
          id: path.id
      - text: Get update metadata for CRM task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/tasks/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fields required to create a task
      effect: read
      questions:
      - Which fields are required to create a CRM task?
      - What does the CRM accept when posting a new to-do?
      instructions:
      - text: Show task creation fields for account token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get the create metadata for CRM tasks.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/tasks/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions on tasks
      effect: read
      questions:
      - What custom fields does the CRM define on tasks?
      - Can I list only custom task field classes?
      instructions:
      - text: List task field classes where custom is {is_custom}.
        slots:
          is_custom: query.is_custom
      - text: Show task field classes that are common model fields {is_common_model_field}.
        slots:
          is_common_model_field: query.is_common_model_field
      method: generated
      generated: '2026-09-26'