Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Linked Accounts API

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

$.info
$.paths['/accounting/v1/linked-accounts'].get
$.paths['/ats/v1/linked-accounts'].get
$.paths['/linked-accounts'].get
$.paths['/crm/v1/linked-accounts'].get
$.paths['/filestorage/v1/linked-accounts'].get
$.paths['/hris/v1/linked-accounts'].get
$.paths['/knowledgebase/v1/linked-accounts'].get
$.paths['/ticketing/v1/linked-accounts'].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 Merge Subpackage Linked Accounts API
  version: 1.0.0
extends: openapi/merge-subpackage-linkedaccounts-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: 8
- target: $.paths['/accounting/v1/linked-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounting linked accounts
      effect: read
      questions:
      - Which customers have connected an accounting system to our product?
      - Can I find accounting linked accounts that are in a broken or incomplete status?
      instructions:
      - text: List accounting linked accounts with status {status}.
        slots:
          status: query.status
      - text: Find the accounting linked account for end user email {end_user_email_address}.
        slots:
          end_user_email_address: query.end_user_email_address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/linked-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List recruiting linked accounts
      effect: read
      questions:
      - Which of our customers have linked an applicant tracking system?
      - Can I list only the test ATS linked accounts?
      instructions:
      - text: List ATS linked accounts for the integration {integration_name}.
        slots:
          integration_name: query.integration_name
      - text: Show recruiting linked accounts where test account is {is_test_account}.
        slots:
          is_test_account: query.is_test_account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/linked-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List chat linked accounts
      effect: read
      questions:
      - Which customers have connected a chat platform through us?
      - Can I look up chat linked accounts by the end user's organization name?
      instructions:
      - text: List chat linked accounts for organization {end_user_organization_name}.
        slots:
          end_user_organization_name: query.end_user_organization_name
      - text: Show chat linked accounts for our end user origin ID {end_user_origin_id}.
        slots:
          end_user_origin_id: query.end_user_origin_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/linked-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM linked accounts
      effect: read
      questions:
      - Which customers have hooked up a CRM, and which one?
      - Can I include duplicate CRM linked accounts in the list?
      instructions:
      - text: List CRM linked accounts for category {category}.
        slots:
          category: query.category
      - text: Show CRM linked accounts including duplicates {include_duplicates}.
        slots:
          include_duplicates: query.include_duplicates
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/linked-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List file storage linked accounts
      effect: read
      questions:
      - Which customers have connected a file storage provider?
      - Can I fetch several file storage linked accounts by their IDs at once?
      instructions:
      - text: List file storage linked accounts with IDs {ids}.
        slots:
          ids: query.ids
      - text: Show storage linked accounts for end user origin IDs {end_user_origin_ids}.
        slots:
          end_user_origin_ids: query.end_user_origin_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/linked-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List HRIS linked accounts
      effect: read
      questions:
      - Which customers have linked an HR or payroll system?
      - Can I filter HRIS linked accounts to one specific integration?
      instructions:
      - text: List HRIS linked accounts using integration {integration_name}.
        slots:
          integration_name: query.integration_name
      - text: Get the HRIS linked account with ID {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/linked-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List knowledge base linked accounts
      effect: read
      questions:
      - Which customers have connected a knowledge base or help center?
      - Can I see knowledge base linked accounts by status?
      instructions:
      - text: List knowledge base linked accounts in status {status}.
        slots:
          status: query.status
      - text: Find knowledge base linked accounts for organization {end_user_organization_name}.
        slots:
          end_user_organization_name: query.end_user_organization_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/linked-accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List ticketing linked accounts
      effect: read
      questions:
      - Which customers have linked a helpdesk or ticketing tool?
      - Can I look up a ticketing linked account by the end user's email?
      instructions:
      - text: List ticketing linked accounts for email {end_user_email_address}.
        slots:
          end_user_email_address: query.end_user_email_address
      - text: Show ticketing linked accounts on the {integration_name} integration.
        slots:
          integration_name: query.integration_name
      method: generated
      generated: '2026-09-26'