Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Users API

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

$.info
$.paths['/ats/v1/users'].get
$.paths['/ats/v1/users/{id}'].get
$.paths['/users'].get
$.paths['/users/{id}'].get
$.paths['/crm/v1/users'].get
$.paths['/crm/v1/users/{id}'].get
$.paths['/crm/v1/users/ignore/{model_id}'].post
$.paths['/crm/v1/users/remote-field-classes'].get
$.paths['/filestorage/v1/users'].get
$.paths['/filestorage/v1/users/{id}'].get
$.paths['/knowledgebase/v1/users'].get
$.paths['/knowledgebase/v1/users/{id}'].get
$.paths['/ticketing/v1/users'].get
$.paths['/ticketing/v1/users/{id}'].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 Users API
  version: 1.0.0
extends: openapi/merge-subpackage-users-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: 14
- target: $.paths['/ats/v1/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List recruiting system users
      effect: read
      questions:
      - How do I see every recruiter and hiring manager account in a linked ATS?
      - Can I find an ATS user by their email address?
      - Which applicant tracking users were added after a given date?
      instructions:
      - text: List ATS users with email {email}.
        slots:
          email: query.email
      - text: Show recruiting-team users created after {created_after}.
        slots:
          created_after: query.created_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a recruiting system user
      effect: read
      questions:
      - What details does the ATS hold about one specific recruiter?
      - Can I pull a single hiring-team member's record with its remote data?
      instructions:
      - text: Get ATS user {id}.
        slots:
          id: path.id
      - text: Fetch recruiter {id} including the original remote data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List chat workspace users
      effect: read
      questions:
      - Who are the members of a connected messaging workspace?
      - Can I page through all chat users modified since last week?
      instructions:
      - text: List chat users modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      - text: Show the first {page_size} people in the linked messaging workspace.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a chat workspace user
      effect: read
      questions:
      - How do I look up one person in a linked chat workspace?
      - What profile does the messaging platform return for a given user?
      instructions:
      - text: Get chat user {id}.
        slots:
          id: path.id
      - text: Fetch messaging workspace member {id} with related objects expanded.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List CRM users
      effect: read
      questions:
      - Which sales reps have logins in the connected CRM?
      - Can I look up a CRM user by email?
      instructions:
      - text: List CRM users with email {email}.
        slots:
          email: query.email
      - text: Show sales-system users created after {created_after}, including remote fields.
        slots:
          created_after: query.created_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a CRM user
      effect: read
      questions:
      - How do I retrieve one CRM user's record?
      - What remote fields does the CRM store on a particular rep?
      instructions:
      - text: Get CRM user {id}.
        slots:
          id: path.id
      - text: Fetch sales rep {id} from the CRM with remote fields.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/users/ignore/{model_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop syncing a CRM user
      effect: destructive
      questions:
      - How do I exclude a CRM user from future syncs?
      - What happens to a CRM user's data once I ignore it?
      instructions:
      - text: Ignore CRM user {model_id} because {reason}.
        slots:
          model_id: path.model_id
          reason: requestBody.reason
      - text: Stop syncing sales rep {model_id} with reason {reason} and note {message}.
        slots:
          model_id: path.model_id
          reason: requestBody.reason
          message: requestBody.message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/users/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for CRM users
      effect: read
      questions:
      - What custom fields exist on users in the connected CRM?
      - Can I list only the custom user fields, not the common model ones?
      instructions:
      - text: List CRM user remote field classes where custom is {is_custom}.
        slots:
          is_custom: query.is_custom
      - text: Show the field definitions available on CRM users for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List file storage users
      effect: read
      questions:
      - Who has an account on a connected cloud drive?
      - Can I find which file storage user is the one whose token I'm using?
      instructions:
      - text: List file storage users with email address {email_address}.
        slots:
          email_address: query.email_address
      - text: Show only the drive user that is me, using is_me {is_me}.
        slots:
          is_me: query.is_me
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file storage user
      effect: read
      questions:
      - How do I fetch one cloud drive user's details?
      - What does the file storage platform know about a given account holder?
      instructions:
      - text: Get file storage user {id}.
        slots:
          id: path.id
      - text: Fetch drive account {id} with its remote data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List knowledge base users
      effect: read
      questions:
      - Who are the authors and editors in a linked knowledge base?
      - Can I list help-center users created before a certain date?
      instructions:
      - text: List knowledge base users created before {created_before}.
        slots:
          created_before: query.created_before
      - text: Show wiki users for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a knowledge base user
      effect: read
      questions:
      - How do I look up a single knowledge base author?
      - What details come back for one help-center user?
      instructions:
      - text: Get knowledge base user {id}.
        slots:
          id: path.id
      - text: Fetch wiki author {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List ticketing system users
      effect: read
      questions:
      - Which agents belong to a particular team in the helpdesk?
      - Can I filter ticketing users by role or email address?
      instructions:
      - text: List ticketing users on team {team}.
        slots:
          team: query.team
      - text: Find helpdesk agents with email address {email_address}.
        slots:
          email_address: query.email_address
      - text: Show issue tracker users with role {roles}.
        slots:
          roles: query.roles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ticketing system user
      effect: read
      questions:
      - How do I pull one helpdesk agent's profile?
      - What does the ticketing platform return for a single user, with teams expanded?
      instructions:
      - text: Get ticketing user {id}.
        slots:
          id: path.id
      - text: Fetch helpdesk agent {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'