# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DoiT Support Requests API
  version: 1.0.0
extends: openapi/doit-support-requests-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/support/v1/tickets'].get
  update:
    x-apievangelist-phrasing:
      intent: List support requests
      effect: read
      questions:
      - What support tickets have we opened with DoiT?
      - Can I list support requests from a certain date onward?
      instructions:
      - text: List all our support requests.
      - text: List support requests created since {since}.
        slots:
          since: query.minCreationTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/support/v1/tickets'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a support request
      effect: write
      questions:
      - How do I open a new support ticket?
      - What do I need to include when filing a request?
      instructions:
      - text: Open a support request with {ticket}.
        slots:
          ticket: requestBody.ticket
      - text: 'File a new ticket: {ticket}.'
        slots:
          ticket: requestBody.ticket
      method: generated
      generated: '2026-10-01'
- target: $.paths['/support/v1/tickets/{ticketId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a support request
      effect: read
      questions:
      - How do I check the details of one support ticket?
      - What's the current status of a ticket?
      instructions:
      - text: Get support request {ticketId}.
        slots:
          ticketId: path.ticketId
      - text: Show me ticket {ticketId}.
        slots:
          ticketId: path.ticketId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/support/v1/tickets/{ticketId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a request's status or assignee
      effect: write
      questions:
      - How do I close or reopen a support ticket?
      - Can I reassign a ticket to someone else?
      instructions:
      - text: Set ticket {ticketId} status to {status}.
        slots:
          ticketId: path.ticketId
          status: requestBody.status
      - text: Assign ticket {ticketId} to {assignee}.
        slots:
          ticketId: path.ticketId
          assignee: requestBody.assignee
      method: generated
      generated: '2026-10-01'
- target: $.paths['/support/v1/tickets/{ticketId}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: Read comments on a request
      effect: read
      questions:
      - What replies have been posted on my ticket?
      - Will I see internal comments on a support request?
      instructions:
      - text: List comments on ticket {ticketId}.
        slots:
          ticketId: path.ticketId
      - text: Show the conversation on request {ticketId}.
        slots:
          ticketId: path.ticketId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/support/v1/tickets/{ticketId}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on a support request
      effect: write
      questions:
      - How do I reply to an open support ticket?
      - Are my comments on a ticket visible to everyone?
      instructions:
      - text: Add comment {body} to ticket {ticketId}.
        slots:
          body: requestBody.body
          ticketId: path.ticketId
      - text: 'Reply to request {ticketId}: {body}.'
        slots:
          ticketId: path.ticketId
          body: requestBody.body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/support/v1/tickets/{ticketId}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List tags on a request
      effect: read
      questions:
      - Which tags are on a given support ticket?
      - Can I see how a ticket has been tagged?
      instructions:
      - text: List tags on ticket {ticketId}.
        slots:
          ticketId: path.ticketId
      - text: Show the tags set on request {ticketId}.
        slots:
          ticketId: path.ticketId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/support/v1/tickets/{ticketId}/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Add tags to a request
      effect: write
      questions:
      - How do I tag a support ticket?
      - Does adding tags overwrite the existing ones?
      instructions:
      - text: Add tags {tags} to ticket {ticketId}.
        slots:
          tags: requestBody.tags
          ticketId: path.ticketId
      - text: Tag request {ticketId} with {tags}.
        slots:
          tags: requestBody.tags
          ticketId: path.ticketId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/support/v1/tickets/{ticketId}/tags'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove tags from a request
      effect: destructive
      questions:
      - How do I take a tag off a support ticket?
      - Will removing one tag affect the ticket's other tags?
      instructions:
      - text: Remove tags {tags} from ticket {ticketId}.
        slots:
          tags: requestBody.tags
          ticketId: path.ticketId
      - text: Untag request {ticketId} of {tags}.
        slots:
          tags: requestBody.tags
          ticketId: path.ticketId
      method: generated
      generated: '2026-10-01'