Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Async Passthrough API

17 actions 17 updates phrasing extends openapi/merge-subpackage-asyncpassthrough-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 17 · first 16 shown; the file carries all of them

$.info
$.paths['/accounting/v1/async-passthrough'].post
$.paths['/accounting/v1/async-passthrough/{async_passthrough_receipt_id}'].get
$.paths['/ats/v1/async-passthrough'].post
$.paths['/ats/v1/async-passthrough/{async_passthrough_receipt_id}'].get
$.paths['/async-passthrough'].post
$.paths['/async-passthrough/{async_passthrough_receipt_id}'].get
$.paths['/crm/v1/async-passthrough'].post
$.paths['/crm/v1/async-passthrough/{async_passthrough_receipt_id}'].get
$.paths['/filestorage/v1/async-passthrough'].post
$.paths['/filestorage/v1/async-passthrough/{async_passthrough_receipt_id}'].get
$.paths['/hris/v1/async-passthrough'].post
$.paths['/hris/v1/async-passthrough/{async_passthrough_receipt_id}'].get
$.paths['/knowledgebase/v1/async-passthrough'].post
$.paths['/knowledgebase/v1/async-passthrough/{async_passthrough_receipt_id}'].get
$.paths['/ticketing/v1/async-passthrough'].post

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 Async Passthrough API
  version: 1.0.0
extends: openapi/merge-subpackage-asyncpassthrough-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: 16
- target: $.paths['/accounting/v1/async-passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue an async passthrough to an accounting system
      effect: write
      questions:
      - How do I call an accounting endpoint that the unified API doesn't cover yet?
      - Can I send a raw request to the underlying bookkeeping platform asynchronously?
      instructions:
      - text: 'Queue an async accounting passthrough: {method} {path}.'
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Asynchronously send {method} to accounting endpoint {path} with body {data}.
        slots:
          method: requestBody.method
          path: requestBody.path
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/async-passthrough/{async_passthrough_receipt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an accounting async passthrough result
      effect: read
      questions:
      - Where do I pick up the response from an async accounting passthrough?
      - Has my queued ledger passthrough request finished?
      instructions:
      - text: Get the accounting passthrough result for receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      - text: Check async bookkeeping passthrough receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/async-passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue an async passthrough to a recruiting system
      effect: write
      questions:
      - Can I reach an applicant tracking system endpoint the common model lacks?
      - How would I send a raw request to the ATS in the background?
      instructions:
      - text: 'Queue an async ATS passthrough: {method} {path}.'
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: In the background, send {method} to recruiting endpoint {path}.
        slots:
          method: requestBody.method
          path: requestBody.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/async-passthrough/{async_passthrough_receipt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recruiting async passthrough result
      effect: read
      questions:
      - What did my queued ATS passthrough request return?
      - Is the async hiring-system passthrough done yet?
      instructions:
      - text: Get the ATS passthrough result for receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      - text: Retrieve recruiting passthrough output for receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/async-passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue an async passthrough to a chat platform
      effect: write
      questions:
      - How can I hit a chat platform endpoint that isn't in the unified model?
      - Can I proxy a raw messaging API call without waiting on it?
      instructions:
      - text: 'Queue an async chat passthrough: {method} {path}.'
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Send {method} to messaging endpoint {path} as a background passthrough.
        slots:
          method: requestBody.method
          path: requestBody.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/async-passthrough/{async_passthrough_receipt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chat async passthrough result
      effect: read
      questions:
      - Where is the output of my queued chat passthrough?
      - Did the async messaging passthrough complete?
      instructions:
      - text: Get the chat passthrough result for receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      - text: Fetch messaging passthrough receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/async-passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue an async passthrough to a CRM
      effect: write
      questions:
      - Can I call a CRM endpoint directly when the common model doesn't expose it?
      - How do I send a long-running raw request to a connected CRM?
      instructions:
      - text: 'Queue an async CRM passthrough: {method} {path}.'
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Asynchronously forward {method} {path} to the sales system with headers {headers}.
        slots:
          method: requestBody.method
          path: requestBody.path
          headers: requestBody.headers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/async-passthrough/{async_passthrough_receipt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CRM async passthrough result
      effect: read
      questions:
      - What response came back from my async CRM passthrough?
      - Is the queued sales-system passthrough finished?
      instructions:
      - text: Get the CRM passthrough result for receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      - text: Check the sales platform passthrough receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/async-passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue an async passthrough to a file storage app
      effect: write
      questions:
      - How do I reach a cloud drive endpoint the unified file model doesn't support?
      - Can I run a raw file storage request asynchronously?
      instructions:
      - text: 'Queue an async file storage passthrough: {method} {path}.'
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Send {method} to drive endpoint {path} in the background.
        slots:
          method: requestBody.method
          path: requestBody.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/async-passthrough/{async_passthrough_receipt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file storage async passthrough result
      effect: read
      questions:
      - Where can I read the result of a queued file storage passthrough?
      - Has the async drive passthrough request completed?
      instructions:
      - text: Get the file storage passthrough result for receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      - text: Fetch drive passthrough output for receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/async-passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue an async passthrough to an HRIS
      effect: write
      questions:
      - Can I pull HR data from an endpoint the unified HRIS model skips?
      - How do I send a slow raw request to a payroll or HR system?
      instructions:
      - text: 'Queue an async HRIS passthrough: {method} {path}.'
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: In the background, call HR endpoint {path} with {method}.
        slots:
          method: requestBody.method
          path: requestBody.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/async-passthrough/{async_passthrough_receipt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an HRIS async passthrough result
      effect: read
      questions:
      - What did the queued HRIS passthrough return?
      - Is my background HR system passthrough ready?
      instructions:
      - text: Get the HRIS passthrough result for receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      - text: Retrieve HR passthrough receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/async-passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue an async passthrough to a knowledge base
      effect: write
      questions:
      - How can I call a knowledge base endpoint not covered by the common model?
      - Can I send a raw help-center request without blocking on it?
      instructions:
      - text: 'Queue an async knowledge base passthrough: {method} {path}.'
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Forward {method} {path} to the wiki as a background passthrough.
        slots:
          method: requestBody.method
          path: requestBody.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/async-passthrough/{async_passthrough_receipt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a knowledge base async passthrough result
      effect: read
      questions:
      - Where is the response to my queued knowledge base passthrough?
      - Has the async help-center passthrough come back?
      instructions:
      - text: Get the knowledge base passthrough result for receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      - text: Fetch wiki passthrough receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/async-passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue an async passthrough to a ticketing system
      effect: write
      questions:
      - Can I hit a helpdesk endpoint that the ticketing model doesn't expose?
      - How do I run a raw issue tracker request asynchronously?
      instructions:
      - text: 'Queue an async ticketing passthrough: {method} {path}.'
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Send {method} to helpdesk endpoint {path} in the background.
        slots:
          method: requestBody.method
          path: requestBody.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/async-passthrough/{async_passthrough_receipt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ticketing async passthrough result
      effect: read
      questions:
      - What came back from my queued ticketing passthrough?
      - Is the background helpdesk passthrough complete?
      instructions:
      - text: Get the ticketing passthrough result for receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      - text: Check issue tracker passthrough receipt {receipt_id}.
        slots:
          receipt_id: path.async_passthrough_receipt_id
      method: generated
      generated: '2026-09-26'