BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Channels API

3 actions 3 updates phrasing extends openapi/blueconic-channels-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['/channels'].get

$.paths['/channels/{channelId}'].get

OpenAPI Overlay

# 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 Channels API
  version: 1.0.0
extends: openapi/blueconic-channels-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['/channels'].get
  update:
    x-apievangelist-phrasing:
      intent: List all channels
      effect: read
      questions:
      - Which channels (websites, apps, email) are set up in BlueConic?
      - Can I page through the channel list a few at a time?
      instructions:
      - text: List every channel configured in our account.
      - text: Show {count} channels starting at position {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/channels/{channelId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single channel
      effect: read
      questions:
      - What are the settings of one specific channel?
      - Can I see the details of a channel if I know its ID?
      instructions:
      - text: Get the details of channel {channelId}.
        slots:
          channelId: path.channelId
      - text: Show me how channel {channelId} is configured.
        slots:
          channelId: path.channelId
      method: generated
      generated: '2026-10-01'