# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Square Events API
  version: 1.0.0
extends: openapi/square-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: 4
- target: $.paths['/v2/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Search recent API events
      effect: read
      questions:
      - How do I find Square API events from the last few weeks?
      - Can I filter events by type or merchant within the 28-day window?
      instructions:
      - text: Search events matching {query}.
        slots:
          query: requestBody.query
      - text: Show the latest {limit} API events.
        slots:
          limit: requestBody.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/events/disable'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn off event searchability
      effect: write
      questions:
      - How do I stop events from being searchable?
      - What happens to events that occur while searching is disabled?
      instructions:
      - text: Disable events search.
      - text: Stop recording searchable events for my app.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/events/enable'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn on event searchability
      effect: write
      questions:
      - How do I make events searchable for my application?
      - Are events searchable by default, or must I enable them?
      instructions:
      - text: Enable events search.
      - text: Start making new events searchable.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/events/types'].get
  update:
    x-apievangelist-phrasing:
      intent: List event types
      effect: read
      questions:
      - What event types can I query or subscribe to?
      - Does the list of event types change with the API version?
      instructions:
      - text: List all event types for event search.
      - text: Show event types for API version {api_version} that I can query.
        slots:
          api_version: query.api_version
      method: generated
      generated: '2026-09-26'