BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Listeners API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/listeners'].get
$.paths['/listeners/{listener}'].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 BlueConic REST API v2 Listeners API
  version: 1.0.0
extends: openapi/blueconic-listeners-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: 2
- target: $.paths['/listeners'].get
  update:
    x-apievangelist-phrasing:
      intent: List all listeners
      effect: read
      questions:
      - Which listeners are collecting data into profiles right now?
      - Can I page through all listeners?
      instructions:
      - text: List all listeners.
      - text: Show {count} listeners starting at index {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/listeners/{listener}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single listener
      effect: read
      questions:
      - What rules does one specific listener use?
      - Can I see a listener's configuration by its ID?
      instructions:
      - text: Get listener {listener}.
        slots:
          listener: path.listener
      - text: Show me how listener {listener} is configured.
        slots:
          listener: path.listener
      method: generated
      generated: '2026-10-01'