BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Plugins API

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

$.paths['/plugins'].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 Plugins API
  version: 1.0.0
extends: openapi/blueconic-plugins-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['/plugins/{plugin}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single plugin
      effect: read
      questions:
      - What does one specific plugin do and how is it set up?
      - Can I get a plugin's details by its ID?
      instructions:
      - text: Get plugin {plugin}.
        slots:
          plugin: path.plugin
      - text: Show me the details of plugin {plugin}.
        slots:
          plugin: path.plugin
      method: generated
      generated: '2026-10-01'
- target: $.paths['/plugins'].get
  update:
    x-apievangelist-phrasing:
      intent: List installed plugins
      effect: read
      questions:
      - Which plugins are installed in our account?
      - Can I filter plugins by type or channel type, or include gallery plugins?
      - Is it possible to list only plugins I have permission to use?
      instructions:
      - text: List all plugins.
      - text: List plugins of type {filterType} for channel types {channelTypes}.
        slots:
          filterType: query.filterType
          channelTypes: query.channelTypes
      - text: Show plugins including the gallery, in locale {locale}.
        slots:
          locale: query.locale
      method: generated
      generated: '2026-10-01'