BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Timeline event rollups API

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

$.paths['/timelineEventRollups/{rollup}'].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 Timeline event rollups API
  version: 1.0.0
extends: openapi/blueconic-timeline-event-rollups-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['/timelineEventRollups'].get
  update:
    x-apievangelist-phrasing:
      intent: List all timeline event rollups
      effect: read
      questions:
      - Which timeline event rollups are configured?
      - Can I page through the rollup configurations?
      instructions:
      - text: List all timeline event rollups.
      - text: Show {count} rollups starting at index {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/timelineEventRollups/{rollup}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a timeline event rollup
      effect: read
      questions:
      - How is one particular timeline event rollup configured?
      - Can I get a rollup's configuration by ID?
      instructions:
      - text: Get timeline event rollup {rollup}.
        slots:
          rollup: path.rollup
      - text: Show the configuration of rollup {rollup}.
        slots:
          rollup: path.rollup
      method: generated
      generated: '2026-10-01'