# 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 Comments API
  version: 1.0.0
extends: openapi/merge-subpackage-comments-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['/ticketing/v1/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List ticket comments
      effect: read
      questions:
      - What comments have been left on a particular ticket?
      - Can I list helpdesk comments posted after a certain time?
      instructions:
      - text: List comments on ticket {ticket_id}.
        slots:
          ticket_id: query.ticket_id
      - text: Show comments created remotely after {remote_created_after}.
        slots:
          remote_created_after: query.remote_created_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a ticket
      effect: write
      questions:
      - How do I post a reply on a ticket in a connected helpdesk?
      - Can I add an internal note to a ticket through the integration?
      instructions:
      - text: Add comment {model} to a ticket.
        slots:
          model: requestBody.model
      - text: 'Post this ticket comment: {model}.'
        slots:
          model: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/comments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ticket comment
      effect: read
      questions:
      - How do I retrieve one specific ticket comment?
      - Who wrote a given comment and on which ticket?
      instructions:
      - text: Get comment {id}.
        slots:
          id: path.id
      - text: Fetch ticket comment {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/comments/meta/post'].get
  update:
    x-apievangelist-phrasing:
      intent: See which fields a ticket comment needs
      effect: read
      questions:
      - What fields are required to post a comment in this ticketing system?
      - Before commenting, how do I check the supported comment fields?
      instructions:
      - text: Get comment creation metadata for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show the fields needed to add a ticket comment.
      method: generated
      generated: '2026-09-26'