Cogny · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cogny Tickets API

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

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/tickets'].get
$.paths['/tickets/{ticket_id}'].get
$.paths['/tickets/{ticket_id}'].patch
$.paths['/tickets/bulk-update'].post
$.paths['/tickets/{ticket_id}/dismiss'].post
$.paths['/tickets/stats'].get
$.paths['/tickets/export'].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 Cogny Tickets API
  version: 1.0.0
extends: openapi/cogny-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: 7
- target: $.paths['/tickets'].get
  update:
    x-apievangelist-phrasing:
      intent: List growth tickets
      effect: read
      questions:
      - Which growth tickets are open for my team right now?
      - Can I filter growth tickets by priority and category?
      - What tickets changed since a certain date, sorted the way I want?
      instructions:
      - text: List my growth tickets.
      - text: List {priority} priority tickets in category {category} with status {status}.
        slots:
          priority: query.priority
          category: query.category
          status: query.status
      - text: Show tickets for warehouse {warehouse_id} updated after {updated_after}.
        slots:
          warehouse_id: query.warehouse_id
          updated_after: query.updated_after
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/{ticket_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one growth ticket
      effect: read
      questions:
      - How do I look up the details of a single growth ticket?
      - What does one specific ticket say, including its notes and action items?
      instructions:
      - text: Get ticket {ticket_id}.
        slots:
          ticket_id: path.ticket_id
      - text: Show me the full details of growth ticket {ticket_id}.
        slots:
          ticket_id: path.ticket_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/{ticket_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a growth ticket
      effect: write
      questions:
      - Can I reassign a single growth ticket to someone else on my team?
      - How would I change one ticket's priority or add notes to it?
      instructions:
      - text: Set the status of ticket {ticket_id} to {status}.
        slots:
          ticket_id: path.ticket_id
          status: requestBody.status
      - text: Assign ticket {ticket_id} to {assignee} and make it {priority} priority.
        slots:
          ticket_id: path.ticket_id
          assignee: requestBody.assignee
          priority: requestBody.priority
      - text: Add the note "{notes}" to ticket {ticket_id}.
        slots:
          ticket_id: path.ticket_id
          notes: requestBody.notes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/bulk-update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update many tickets at once
      effect: write
      questions:
      - Is there a way to change a whole batch of tickets in one call?
      - Can I apply the same change to several growth tickets together?
      instructions:
      - text: Apply {updates} to tickets {ticket_ids} in one bulk update.
        slots:
          updates: requestBody.updates
          ticket_ids: requestBody.ticket_ids
      - text: 'Bulk-update tickets {ticket_ids} with these changes: {updates}.'
        slots:
          ticket_ids: requestBody.ticket_ids
          updates: requestBody.updates
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/{ticket_id}/dismiss'].post
  update:
    x-apievangelist-phrasing:
      intent: Dismiss a growth ticket
      effect: write
      questions:
      - How do I dismiss a growth ticket that isn't relevant to us?
      - Can I record a reason when I dismiss a ticket?
      instructions:
      - text: Dismiss ticket {ticket_id}.
        slots:
          ticket_id: path.ticket_id
      - text: Dismiss ticket {ticket_id} with the reason {reason}.
        slots:
          ticket_id: path.ticket_id
          reason: requestBody.reason
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get growth ticket statistics
      effect: read
      questions:
      - What do my growth tickets look like in aggregate?
      - Where can I see summary counts across all my tickets?
      instructions:
      - text: Show me statistics for my growth tickets.
      - text: Summarize ticket totals across the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tickets/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export growth tickets to a file
      effect: read
      questions:
      - Can I download my growth tickets as a file to share outside the app?
      - Which fields can I include when exporting tickets?
      instructions:
      - text: Export my tickets in {format} format.
        slots:
          format: requestBody.format
      - text: Export tickets matching {filters} with only the fields {include_fields}.
        slots:
          filters: requestBody.filters
          include_fields: requestBody.include_fields
      method: generated
      generated: '2026-10-01'