# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Showpad Tickets API
  version: 1.0.0
extends: openapi/showpad-tickets-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: 10
- target: $.paths['/tickets.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List tickets
      effect: read
      questions:
      - Which tickets are still unfinished in our Showpad account?
      - Can I filter tickets by status or by division?
      instructions:
      - text: List all tickets.
      - text: List tickets with status {status}.
        slots:
          status: query.status
      - text: Show unfinished tickets in division {divisionId}.
        slots:
          divisionId: query.divisionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel tickets (no ID in path)
      effect: destructive
      questions:
      - Is there a bulk-style endpoint to cancel tickets without putting an ID in the URL?
      - Can I cancel tickets through the collection-level cancel call?
      instructions:
      - text: Call the collection-level ticket cancel endpoint.
      - text: Cancel tickets using the cancel call that takes no ticket ID in the path.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count tickets
      effect: read
      questions:
      - How many tickets are currently open?
      - What's the number of tickets with a given status?
      instructions:
      - text: Count all tickets.
      - text: Count tickets with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/description.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the ticket data model
      effect: read
      questions:
      - What fields does a ticket object have?
      - Where can I see the API calls available for tickets?
      instructions:
      - text: Describe the ticket model and its available API calls.
      - text: Show me the property definitions for the ticket resource.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/force-use'].post
  update:
    x-apievangelist-phrasing:
      intent: Force-use failed tickets (no ID in path)
      effect: write
      questions:
      - Is there a collection-level call to force using the related element of failed tickets?
      - Can I force-use without naming a ticket ID in the URL?
      instructions:
      - text: Call the collection-level force-use endpoint for failed tickets.
      - text: Force use on failed tickets via the call that takes no ticket ID in the path.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/{ids}/processingtime.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get processing time for tickets
      effect: read
      questions:
      - How long did a set of tickets take to process?
      - Can I check processing time for several tickets at once?
      instructions:
      - text: Get the processing time for tickets {ids}.
        slots:
          ids: path.ids
      - text: Show how long tickets {ids} took to process.
        slots:
          ids: path.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/{id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ticket
      effect: read
      questions:
      - How do I look up a single ticket's status?
      - What details are returned for one ticket?
      instructions:
      - text: Get ticket {id}.
        slots:
          id: path.id
      - text: Show the status of ticket {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/{id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a ticket
      effect: destructive
      questions:
      - How do I delete a ticket entirely?
      - Can I remove a ticket record instead of just cancelling it?
      instructions:
      - text: Delete ticket {id}.
        slots:
          id: path.id
      - text: Remove the ticket record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/{id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a specific ticket
      effect: destructive
      questions:
      - How do I cancel one ticket that's still pending?
      - Can I stop a single ticket without deleting it?
      instructions:
      - text: Cancel ticket {id}.
        slots:
          id: path.id
      - text: Stop pending ticket {id} by cancelling it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/{id}/force-use'].post
  update:
    x-apievangelist-phrasing:
      intent: Force-use a specific failed ticket
      effect: write
      questions:
      - How do I force using the related element of one failed ticket?
      - Does force-use work on a ticket that hasn't failed?
      instructions:
      - text: Force use on failed ticket {id}.
        slots:
          id: path.id
      - text: Make ticket {id} use its related element even though it failed.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'