Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Sync Status API

9 actions 9 updates phrasing extends openapi/merge-subpackage-syncstatus-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/sync-status'].get
$.paths['/ats/v1/sync-status'].get
$.paths['/sync-status'].get
$.paths['/crm/v1/sync-status'].get
$.paths['/filestorage/v1/sync-status'].get
$.paths['/hris/v1/sync-status'].get
$.paths['/knowledgebase/v1/sync-status'].get
$.paths['/ticketing/v1/sync-status'].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 Sync Status API
  version: 1.0.0
extends: openapi/merge-subpackage-syncstatus-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/sync-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check accounting sync status
      effect: read
      questions:
      - When did the accounting data for a linked account last finish syncing?
      - How can I tell whether the latest accounting sync is DONE or FAILED?
      instructions:
      - text: Show accounting sync status for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Tell me if the last accounting sync for {account_token} succeeded.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/sync-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check ATS sync status
      effect: read
      questions:
      - Is candidate and job data from the recruiting system up to date?
      - Which ATS models are still syncing for a linked account?
      instructions:
      - text: Get ATS sync status per model for {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Check whether recruiting data for {account_token} has finished syncing.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sync-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check sync status from the root endpoint
      effect: read
      questions:
      - Is there a top-level sync status endpoint not bound to a category?
      - Can I read last_sync_finished for a linked account from the root path?
      instructions:
      - text: Get sync status from the top-level endpoint for {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show root sync progress for linked account {account_token}, 50 per page.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/sync-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check CRM sync status
      effect: read
      questions:
      - Has the CRM finished pulling contacts and opportunities for my customer?
      - Can I see which CRM objects partially synced?
      instructions:
      - text: Show CRM sync status for {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: List CRM models that failed or partially synced for {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/sync-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check file storage sync status
      effect: read
      questions:
      - Are files and folders from the linked drive fully synced yet?
      - When did file storage last complete a sync?
      instructions:
      - text: Get file storage sync status for {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Check if file storage syncing is disabled for {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/sync-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check HRIS sync status
      effect: read
      questions:
      - Is employee data from the HR system current?
      - What does a PARTIALLY_SYNCED versus DONE result mean for HRIS models?
      instructions:
      - text: Show HRIS sync status for {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Tell me when HR data for {account_token} last synced successfully.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/sync-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check knowledge base sync status
      effect: read
      questions:
      - Have articles from the knowledge base finished syncing?
      - Can I see per-model sync results for a knowledge base link?
      instructions:
      - text: Get knowledge base sync status for {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Check the latest knowledge base sync result for {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/sync-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check ticketing sync status
      effect: read
      questions:
      - Are tickets from the help desk fully synced right now?
      - When did the ticketing sync last start and finish?
      instructions:
      - text: Show ticketing sync status for {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Tell me whether help desk data for {account_token} is still syncing.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'