BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Group Types API

2 actions 2 updates phrasing extends openapi/blueconic-group-types-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 2

$.info

$.paths['/groupTypes'].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 Group Types API
  version: 1.0.0
extends: openapi/blueconic-group-types-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: 1
- target: $.paths['/groupTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the available group types
      effect: read
      questions:
      - What kinds of groups (households, companies, accounts) are defined in BlueConic?
      - Which group types can I use when working with groups?
      instructions:
      - text: List all group types.
      - text: Show me which group types are defined in our account.
      method: generated
      generated: '2026-10-01'