BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Lifecycles API

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

$.paths['/lifecycles/{lifecycle}'].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 Lifecycles API
  version: 1.0.0
extends: openapi/blueconic-lifecycles-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['/lifecycles'].get
  update:
    x-apievangelist-phrasing:
      intent: List all lifecycles
      effect: read
      questions:
      - Which customer lifecycles are defined in BlueConic?
      - Can I page through the lifecycles list?
      instructions:
      - text: List every lifecycle.
      - text: Show {count} lifecycles starting at index {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lifecycles/{lifecycle}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single lifecycle
      effect: read
      questions:
      - What stages make up one particular lifecycle?
      - Can I retrieve a lifecycle's details by ID?
      instructions:
      - text: Get lifecycle {lifecycle}.
        slots:
          lifecycle: path.lifecycle
      - text: Show the stages and setup of lifecycle {lifecycle}.
        slots:
          lifecycle: path.lifecycle
      method: generated
      generated: '2026-10-01'