Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Tags API

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

$.info
$.paths['/ats/v1/tags'].get
$.paths['/tags'].get
$.paths['/ticketing/v1/tags'].get
$.paths['/ticketing/v1/tags/{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 Tags API
  version: 1.0.0
extends: openapi/merge-subpackage-tags-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: 4
- target: $.paths['/ats/v1/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List candidate tags from the ATS
      effect: read
      questions:
      - How do I get the tags recruiters use on candidates in an applicant tracking system?
      - Can I list ATS tags that changed since my last sync?
      instructions:
      - text: List ATS tags modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      - text: Show recruiting tags for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List my organization's available tags
      effect: read
      questions:
      - Which tags are available to my organization, both global and org-scoped?
      - Is there one place to see every tag my Merge organization can apply?
      instructions:
      - text: List all global and organization-scoped tags.
      - text: Show the tags my organization is allowed to use.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List help desk ticket tags
      effect: read
      questions:
      - How do I pull the labels used to tag tickets in a help desk?
      - Can I list ticketing tags created before a certain date?
      instructions:
      - text: List ticketing tags created before {created_before}.
        slots:
          created_before: query.created_before
      - text: Find the help desk tag with remote id {remote_id}.
        slots:
          remote_id: query.remote_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/tags/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one help desk ticket tag
      effect: read
      questions:
      - Can I read a single ticket tag by its id?
      - What does one help desk tag record hold?
      instructions:
      - text: Get ticketing tag {id}.
        slots:
          id: path.id
      - text: Fetch help desk tag {id} with its remote data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'