Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ticketing Subpackage Collections API

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

$.info
$.paths['/ticketing/v1/collections'].get
$.paths['/ticketing/v1/collections/{collection_id}/viewers'].get
$.paths['/ticketing/v1/collections/{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 Ticketing Subpackage Collections API
  version: 1.0.0
extends: openapi/merge-subpackage-collections-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: 3
- target: $.paths['/ticketing/v1/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List ticketing collections such as projects
      effect: read
      questions:
      - How do I get the projects or lists that group tickets in a help desk?
      - Can I list collections nested under a parent collection?
      - Which ticketing collections are of a given type?
      instructions:
      - text: List ticketing collections of type {collection_type}.
        slots:
          collection_type: query.collection_type
      - text: Show collections whose parent is {parent_collection_id}.
        slots:
          parent_collection_id: query.parent_collection_id
      - text: Find the ticket collection named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/collections/{collection_id}/viewers'].get
  update:
    x-apievangelist-phrasing:
      intent: List who can view a ticketing collection
      effect: read
      questions:
      - Which users and teams have access to a particular ticket project?
      - Can I see the assignees and viewers on a collection?
      instructions:
      - text: List the viewers of collection {collection_id}.
        slots:
          collection_id: path.collection_id
      - text: Show users and teams with access to collection {collection_id}, expanding {relations}.
        slots:
          collection_id: path.collection_id
          relations: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/collections/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one ticketing collection
      effect: read
      questions:
      - How do I read a single ticket project or list?
      - Can I see a collection's parent when I fetch it?
      instructions:
      - text: Get ticketing collection {id}.
        slots:
          id: path.id
      - text: Fetch collection {id} with {relations} expanded.
        slots:
          id: path.id
          relations: query.expand
      method: generated
      generated: '2026-09-26'