BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Timeline Event Types API

3 actions 3 updates phrasing extends openapi/blueconic-timeline-event-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 3

$.info
$.paths['/timelineEventTypes/{timelineEventType}'].get
$.paths['/timelineEventTypes'].get

OpenAPI Overlay

Raw ↑ 
# 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 Timeline Event Types API
  version: 1.0.0
extends: openapi/blueconic-timeline-event-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: 2
- target: $.paths['/timelineEventTypes/{timelineEventType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a timeline event type
      effect: read
      questions:
      - What fields does one specific timeline event type have?
      - Can I inspect a timeline event type by its ID?
      instructions:
      - text: Get timeline event type {timelineEventType}.
        slots:
          timelineEventType: path.timelineEventType
      - text: Show the definition of event type {timelineEventType}.
        slots:
          timelineEventType: path.timelineEventType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/timelineEventTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List all timeline event types
      effect: read
      questions:
      - Which timeline event types are defined, like orders or email clicks?
      - Can I page through the timeline event types?
      instructions:
      - text: List all timeline event types.
      - text: Show {count} timeline event types from index {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-10-01'