BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Connections API

4 actions 4 updates phrasing extends openapi/blueconic-connections-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 4

$.info

$.paths['/connections'].get

$.paths['/connections/{connection}'].get

$.paths['/connections/{connection}/runs'].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 Connections API
  version: 1.0.0
extends: openapi/blueconic-connections-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: 3
- target: $.paths['/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List all connections
      effect: read
      questions:
      - Which data connections and integrations do we have set up?
      - Can I fetch the connections in pages instead of all at once?
      instructions:
      - text: List all our connections.
      - text: Show {count} connections starting from index {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{connection}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single connection
      effect: read
      questions:
      - What is configured on one particular connection?
      - Can I inspect a connection's setup by its ID?
      instructions:
      - text: Get the configuration of connection {connection}.
        slots:
          connection: path.connection
      - text: Show me the details of connection {connection}.
        slots:
          connection: path.connection
      method: generated
      generated: '2026-10-01'
- target: $.paths['/connections/{connection}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: Review the run history of a batch connection
      effect: read
      questions:
      - When did my batch connection last run, and did it succeed?
      - Is there a history of past import/export runs for a connection?
      - How do I check whether a scheduled batch connection has been failing?
      instructions:
      - text: Show the run history of batch connection {connection}.
        slots:
          connection: path.connection
      - text: Get the last {count} runs of connection {connection}.
        slots:
          count: query.count
          connection: path.connection
      method: generated
      generated: '2026-10-01'