Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Issues API

17 actions 17 updates phrasing extends openapi/merge-subpackage-issues-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/issues'].get
$.paths['/accounting/v1/issues/{id}'].get
$.paths['/ats/v1/issues'].get
$.paths['/ats/v1/issues/{id}'].get
$.paths['/issues'].get
$.paths['/issues/{id}'].get
$.paths['/crm/v1/issues'].get
$.paths['/crm/v1/issues/{id}'].get
$.paths['/filestorage/v1/issues'].get
$.paths['/filestorage/v1/issues/{id}'].get
$.paths['/hris/v1/issues'].get
$.paths['/hris/v1/issues/{id}'].get
$.paths['/knowledgebase/v1/issues'].get
$.paths['/knowledgebase/v1/issues/{id}'].get
$.paths['/ticketing/v1/issues'].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 Issues API
  version: 1.0.0
extends: openapi/merge-subpackage-issues-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/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration issues from the accounting API
      effect: read
      questions:
      - How do I see which accounting integrations are throwing errors for my organization?
      - Can I list accounting-side issues for one linked account only?
      instructions:
      - text: List open integration issues via the accounting endpoint for linked account {linked_account_id}.
        slots:
          linked_account_id: query.linked_account_id
      - text: Show accounting API issues first seen after {first_incident_time_after}.
        slots:
          first_incident_time_after: query.first_incident_time_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/issues/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one issue via the accounting API
      effect: read
      questions:
      - Where can I read the details of a single sync problem reported under accounting?
      - Can I fetch one accounting integration issue by its id?
      instructions:
      - text: Get accounting integration issue {id}.
        slots:
          id: path.id
      - text: Pull the details of issue {id} through the accounting category.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration issues from the ATS API
      effect: read
      questions:
      - Which of my recruiting (ATS) integrations currently have problems?
      - Can I filter ATS issues by integration name, like a specific applicant tracking system?
      instructions:
      - text: List ATS integration issues for integration {integration_name}.
        slots:
          integration_name: query.integration_name
      - text: Show recruiting-side issues with status {status}, including muted ones.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/issues/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one issue via the ATS API
      effect: read
      questions:
      - How can I look at a single recruiting integration issue in detail?
      - Is one ATS issue retrievable by id from the recruiting endpoints?
      instructions:
      - text: Get ATS issue {id}.
        slots:
          id: path.id
      - text: Open recruiting integration issue {id} and tell me what went wrong.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration issues from the root endpoint
      effect: read
      questions:
      - Is there an unscoped endpoint that lists all integration issues for my organization?
      - Can I list issues for one end-user organization from the top-level issues path?
      instructions:
      - text: List issues from the top-level endpoint for end user organization {end_user_organization_name}.
        slots:
          end_user_organization_name: query.end_user_organization_name
      - text: Show root-level issues whose last incident happened before {last_incident_time_before}.
        slots:
          last_incident_time_before: query.last_incident_time_before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/issues/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one issue from the root endpoint
      effect: read
      questions:
      - Can I fetch an issue by id without going through a category-specific path?
      - What does the top-level single-issue lookup return?
      instructions:
      - text: Get issue {id} from the top-level issues endpoint.
        slots:
          id: path.id
      - text: Look up root issue {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration issues from the CRM API
      effect: read
      questions:
      - Which CRM connections are reporting sync errors right now?
      - Can I list CRM issues that were active within a date window?
      instructions:
      - text: List CRM integration issues with activity between {start_date} and {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Show CRM issues for linked account {linked_account_id}.
        slots:
          linked_account_id: query.linked_account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/issues/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one issue via the CRM API
      effect: read
      questions:
      - How do I get details on one CRM sync issue?
      - Can the CRM endpoints return a single issue record by id?
      instructions:
      - text: Get CRM issue {id}.
        slots:
          id: path.id
      - text: Explain the CRM integration problem recorded as issue {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration issues from the file storage API
      effect: read
      questions:
      - Are any of my file storage integrations failing to sync?
      - Can I page through file storage issues 100 at a time?
      instructions:
      - text: List file storage integration issues with status {status}.
        slots:
          status: query.status
      - text: Show file storage issues first seen before {first_incident_time_before}.
        slots:
          first_incident_time_before: query.first_incident_time_before
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/issues/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one issue via the file storage API
      effect: read
      questions:
      - How do I inspect a single file storage integration issue?
      - Can I read one file storage sync error by id?
      instructions:
      - text: Get file storage issue {id}.
        slots:
          id: path.id
      - text: Show me what file storage issue {id} is about.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration issues from the HRIS API
      effect: read
      questions:
      - Which HR and payroll integrations have open issues?
      - Can I include muted issues when listing HRIS problems?
      instructions:
      - text: List HRIS integration issues for account token {account_token}.
        slots:
          account_token: query.account_token
      - text: Show HR system issues whose last incident was after {last_incident_time_after}.
        slots:
          last_incident_time_after: query.last_incident_time_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/issues/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one issue via the HRIS API
      effect: read
      questions:
      - How can I see the details of one HR integration issue?
      - Does the HRIS category let me fetch a specific issue?
      instructions:
      - text: Get HRIS issue {id}.
        slots:
          id: path.id
      - text: Fetch HR integration issue {id} and summarize it.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration issues from the knowledge base API
      effect: read
      questions:
      - Are my knowledge base connections reporting any issues?
      - Can I narrow knowledge base issues to one integration?
      instructions:
      - text: List knowledge base integration issues for {integration_name}.
        slots:
          integration_name: query.integration_name
      - text: Show knowledge base issues for end user organization {end_user_organization_name}.
        slots:
          end_user_organization_name: query.end_user_organization_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/issues/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one issue via the knowledge base API
      effect: read
      questions:
      - How do I open a single knowledge base integration issue?
      - Can I get one knowledge base sync problem by its id?
      instructions:
      - text: Get knowledge base issue {id}.
        slots:
          id: path.id
      - text: Describe knowledge base integration issue {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List integration issues from the ticketing API
      effect: read
      questions:
      - Which help desk integrations are having sync trouble?
      - Can I list ticketing issues with a given status?
      instructions:
      - text: List ticketing integration issues with status {status}.
        slots:
          status: query.status
      - text: Show help desk connection issues for linked account {linked_account_id}.
        slots:
          linked_account_id: query.linked_account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/issues/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one issue via the ticketing API
      effect: read
      questions:
      - Where do I read one help desk integration issue in full?
      - Can I fetch a ticketing-category issue by id?
      instructions:
      - text: Get ticketing issue {id}.
        slots:
          id: path.id
      - text: Pull up help desk integration issue {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'