BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Notebooks API

4 actions 4 updates phrasing extends openapi/blueconic-notebooks-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 4

$.info

$.paths['/notebooks'].get

$.paths['/notebooks/{notebook}'].get

$.paths['/notebooks/{notebook}/runs'].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 Notebooks API
  version: 1.0.0
extends: openapi/blueconic-notebooks-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: 3
- target: $.paths['/notebooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List all notebooks
      effect: read
      questions:
      - Which notebooks exist in our BlueConic account?
      - Can I page through the notebooks list?
      instructions:
      - text: List all notebooks.
      - text: Show {count} notebooks starting at index {startIndex}.
        slots:
          count: query.count
          startIndex: query.startIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notebooks/{notebook}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a single notebook
      effect: read
      questions:
      - What's configured on one specific notebook?
      - Can I retrieve a notebook's details by its ID?
      instructions:
      - text: Get notebook {notebook}.
        slots:
          notebook: path.notebook
      - text: Show me the setup of notebook {notebook}.
        slots:
          notebook: path.notebook
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notebooks/{notebook}/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: Review a notebook's batch run history
      effect: read
      questions:
      - When did a notebook last run in batch, and did it succeed?
      - How do I see past executions of a scheduled notebook?
      instructions:
      - text: Show the run history of notebook {notebook}.
        slots:
          notebook: path.notebook
      - text: Get the last {count} runs of notebook {notebook}.
        slots:
          count: query.count
          notebook: path.notebook
      method: generated
      generated: '2026-10-01'