Hilt · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hilt So Support API

5 actions 5 updates phrasing extends openapi/hilt-so-support-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hilt's API. It is a proposal applied on top of the contract, not a document Hilt publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/support/tickets'].get
$.paths['/v1/support/tickets'].post
$.paths['/v1/support/tickets/{ticket_id}'].get
$.paths['/v1/support/tickets/{ticket_id}/message'].post

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 Hilt So Support API
  version: 1.0.0
extends: openapi/hilt-so-support-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['/v1/support/tickets'].get
  update:
    x-apievangelist-phrasing:
      intent: List my support tickets
      effect: read
      questions:
      - Which support tickets have I opened?
      - Can I see only my open tickets?
      instructions:
      - text: List my support tickets.
      - text: Show my {status} support tickets.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/support/tickets'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a support ticket
      effect: write
      questions:
      - How do I contact Hilt support about a problem?
      - Can I categorize a new support request?
      instructions:
      - text: Open a support ticket titled {subject} saying {body}.
        slots:
          subject: requestBody.subject
          body: requestBody.body
      - text: 'File a {category} ticket: {subject} - {body}.'
        slots:
          category: requestBody.category
          subject: requestBody.subject
          body: requestBody.body
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/support/tickets/{ticket_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a support ticket thread
      effect: read
      questions:
      - Has support replied to my ticket?
      - Where can I read the full conversation on a ticket?
      instructions:
      - text: Show ticket {ticket_id}.
        slots:
          ticket_id: path.ticket_id
      - text: Read the message thread on ticket {ticket_id}.
        slots:
          ticket_id: path.ticket_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/support/tickets/{ticket_id}/message'].post
  update:
    x-apievangelist-phrasing:
      intent: Reply to a support ticket
      effect: write
      questions:
      - Can I add more details to a ticket I already opened?
      - What's the way to reply to support on an existing thread?
      instructions:
      - text: Reply to ticket {ticket_id} with {body}.
        slots:
          ticket_id: path.ticket_id
          body: requestBody.body
      - text: Add message {body} to support ticket {ticket_id}.
        slots:
          body: requestBody.body
          ticket_id: path.ticket_id
      method: generated
      generated: '2026-09-26'