Xquik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Xquik Support API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/v1/support/attachments/{id}'].get
$.paths['/api/v1/support/tickets'].get
$.paths['/api/v1/support/tickets'].post
$.paths['/api/v1/support/tickets/{id}'].get
$.paths['/api/v1/support/tickets/{id}'].patch
$.paths['/api/v1/support/tickets/{id}/messages'].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 Xquik Support API
  version: 1.0.0
extends: openapi/xquik-api-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: 6
- target: $.paths['/api/v1/support/attachments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a support ticket attachment
      effect: read
      questions:
      - Can I download an image or video attached to my support ticket?
      - Can I seek within a support video using a byte range?
      instructions:
      - text: Download support attachment {id}.
        slots:
          id: path.id
      - text: Stream support video {id} from byte range {Range}.
        slots:
          id: path.id
          Range: header.Range
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/support/tickets'].get
  update:
    x-apievangelist-phrasing:
      intent: List my support tickets
      effect: read
      questions:
      - What support tickets have I opened?
      - Can I see all my support requests in one place?
      instructions:
      - text: List my support tickets.
      - text: Show every support ticket I've filed.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/support/tickets'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a support ticket
      effect: write
      questions:
      - How do I contact support about a problem?
      - Can I attach screenshots to a new support ticket?
      instructions:
      - text: Open a support ticket titled {subject} saying {body}.
        slots:
          subject: requestBody.subject
          body: requestBody.body
      - text: 'File a support request: subject {subject}, details {body}, attachments {attachments}.'
        slots:
          subject: requestBody.subject
          body: requestBody.body
          attachments: requestBody.attachments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/support/tickets/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a support ticket and its messages
      effect: read
      questions:
      - Can I read the full conversation on a support ticket?
      - Has support replied to my ticket yet?
      instructions:
      - text: Get support ticket {id} with all messages.
        slots:
          id: path.id
      - text: Show the message thread for ticket {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/support/tickets/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a support ticket's status
      effect: write
      questions:
      - Can I close a support ticket once my issue is fixed?
      - Which way do I change a ticket's status?
      instructions:
      - text: Set ticket {id} status to {status}.
        slots:
          id: path.id
          status: requestBody.status
      - text: Mark support ticket {id} as {status}.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/support/tickets/{id}/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Reply to a support ticket
      effect: write
      questions:
      - How do I reply to support on an existing ticket?
      - Can I add a video to my reply on a ticket?
      instructions:
      - text: 'Reply to ticket {id}: {body}.'
        slots:
          id: path.id
          body: requestBody.body
      - text: Add a message {body} with attachments {attachments} to ticket {id}.
        slots:
          id: path.id
          body: requestBody.body
          attachments: requestBody.attachments
      method: generated
      generated: '2026-09-26'