Xquik · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Xquik Events API

3 actions 3 updates phrasing extends openapi/xquik-api-events-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 3

$.info
$.paths['/api/v1/events'].get
$.paths['/api/v1/events/{id}'].get

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 Events API
  version: 1.0.0
extends: openapi/xquik-api-events-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: 2
- target: $.paths['/api/v1/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events captured by my monitors
      effect: read
      questions:
      - What events have my monitors picked up lately?
      - Can I filter events to one monitor or one event type?
      instructions:
      - text: List recent monitor events.
      - text: Show events from account monitor {monitorId}.
        slots:
          monitorId: query.monitorId
      - text: List {eventType} events from keyword monitor {keywordMonitorId}.
        slots:
          eventType: query.eventType
          keywordMonitorId: query.keywordMonitorId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one monitor event
      effect: read
      questions:
      - Can I look up one specific monitor event by ID?
      - What details are stored for a single event?
      instructions:
      - text: Get event {id}.
        slots:
          id: path.id
      - text: Show me the full details of event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'