BigPanda · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BigPanda Changes API

2 actions 2 updates phrasing extends openapi/bigpanda-changes-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for BigPanda's API. It is a proposal applied on top of the contract, not a document BigPanda publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/data/changes'].post

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 BigPanda Changes API
  version: 1.0.0
extends: openapi/bigpanda-changes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/data/changes'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a change event for correlation
      effect: write
      questions:
      - How do I tell BigPanda about a deployment so it can correlate alerts with it?
      - Can I report a config change against specific hosts?
      instructions:
      - text: Send a {status} change event summarized as {summary}.
        slots:
          status: requestBody.status
          summary: requestBody.summary
      - text: Record change {identifier} ({summary}, status {status}) on hosts {hosts}.
        slots:
          identifier: requestBody.identifier
          summary: requestBody.summary
          status: requestBody.status
          hosts: requestBody.hosts
      method: generated
      generated: '2026-09-26'