Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Passthrough API

9 actions 9 updates phrasing extends openapi/merge-subpackage-passthrough-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/passthrough'].post
$.paths['/ats/v1/passthrough'].post
$.paths['/passthrough'].post
$.paths['/crm/v1/passthrough'].post
$.paths['/filestorage/v1/passthrough'].post
$.paths['/hris/v1/passthrough'].post
$.paths['/knowledgebase/v1/passthrough'].post
$.paths['/ticketing/v1/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 Passthrough API
  version: 1.0.0
extends: openapi/merge-subpackage-passthrough-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/passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Call an unsupported accounting endpoint directly
      effect: write
      questions:
      - How do I reach an accounting platform endpoint that Merge's common model doesn't cover?
      - Can I send a raw request to the linked accounting system with my own path and method?
      instructions:
      - text: Send a {method} passthrough request to accounting path {path}.
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Pass through to the accounting provider at {path} with body {data}.
        slots:
          path: requestBody.path
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Call an unsupported ATS endpoint directly
      effect: write
      questions:
      - Can I hit a recruiting system's native endpoint that the ATS model lacks?
      - What request format options exist for an ATS passthrough call?
      instructions:
      - text: Make a {method} passthrough call to the ATS at {path}.
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Forward {data} to recruiting platform path {path} as {request_format}.
        slots:
          data: requestBody.data
          path: requestBody.path
          request_format: requestBody.request_format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Call an unsupported endpoint via the root passthrough
      effect: write
      questions:
      - Is there a top-level passthrough not tied to a specific category?
      - Can I override the third party's base URL on a root passthrough request?
      instructions:
      - text: Send a root passthrough {method} request to {path}.
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Proxy {path} through the top-level passthrough using base URL {base_url_override}.
        slots:
          path: requestBody.path
          base_url_override: requestBody.base_url_override
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Call an unsupported CRM endpoint directly
      effect: write
      questions:
      - How can I read CRM data that isn't in the unified CRM model?
      - Can I get a normalized response shape back from a CRM passthrough?
      instructions:
      - text: Run a {method} CRM passthrough to {path}.
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Call CRM path {path} with extra headers {headers} and normalize the response.
        slots:
          path: requestBody.path
          headers: requestBody.headers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Call an unsupported file storage endpoint directly
      effect: write
      questions:
      - Can I upload through a file storage provider's native endpoint with multipart form data?
      - What do I pass to reach a file storage API path that Merge doesn't model?
      instructions:
      - text: Send a {method} file storage passthrough to {path}.
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Post multipart fields {multipart_form_data} to file storage path {path}.
        slots:
          multipart_form_data: requestBody.multipart_form_data
          path: requestBody.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Call an unsupported HRIS endpoint directly
      effect: write
      questions:
      - How do I get HR data the HRIS common model doesn't expose?
      - Can an HRIS passthrough send a JSON body to the payroll provider?
      instructions:
      - text: Issue a {method} HRIS passthrough request to {path}.
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Send {data} to HR system path {path} through passthrough.
        slots:
          data: requestBody.data
          path: requestBody.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Call an unsupported knowledge base endpoint directly
      effect: write
      questions:
      - Can I call a knowledge base tool's own API path through Merge?
      - What fields does a knowledge base passthrough require?
      instructions:
      - text: Make a {method} knowledge base passthrough to {path}.
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Query knowledge base path {path} directly with format {request_format}.
        slots:
          path: requestBody.path
          request_format: requestBody.request_format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Call an unsupported ticketing endpoint directly
      effect: write
      questions:
      - How do I reach a help desk endpoint that the ticketing model doesn't support?
      - Can I pass custom headers on a ticketing passthrough call?
      instructions:
      - text: Send a {method} ticketing passthrough to {path}.
        slots:
          method: requestBody.method
          path: requestBody.path
      - text: Call help desk path {path} with headers {headers}.
        slots:
          path: requestBody.path
          headers: requestBody.headers
      method: generated
      generated: '2026-09-26'