BigPanda · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BigPanda Reporting API

4 actions 4 updates phrasing extends openapi/bigpanda-reporting-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 4

$.info
$.paths['/multi-context-generation/generate'].post
$.paths['/resources/v2.1/integration-alerts'].get
$.paths['/resources/v2.0/troubleshooting/logs'].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 BigPanda Reporting API
  version: 1.0.0
extends: openapi/bigpanda-reporting-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: 3
- target: $.paths['/multi-context-generation/generate'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a report from transcripts and tickets
      effect: write
      questions:
      - Can I generate a post-incident report from meeting transcripts and ServiceNow records together?
      - Can the generated report stream back as it's written?
      instructions:
      - text: Generate a report titled {title} from transcripts {transcripts} using prompt {prompt}.
        slots:
          title: requestBody.title
          transcripts: requestBody.transcripts
          prompt: requestBody.prompt
      - text: Build a {format} report from ServiceNow records {serviceNow} with reasoning effort {reasoningEffort}.
        slots:
          format: requestBody.format
          serviceNow: requestBody.serviceNow
          reasoningEffort: requestBody.reasoningEffort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/integration-alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: See raw alerts an integration recently sent
      effect: read
      questions:
      - What exactly did BigPanda receive from an integration before enrichment?
      - Can I debug why a source field isn't mapping to a tag by looking at raw payloads?
      instructions:
      - text: Show the raw alerts recently received from integration {app_key}.
        slots:
          app_key: query.app_key
      - text: Get the last {limit} normalized payloads from app key {app_key} since {since}.
        slots:
          limit: query.limit
          app_key: query.app_key
          since: query.since
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/troubleshooting/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Search troubleshooting logs
      effect: read
      questions:
      - Are there error logs explaining why an enrichment or integration misbehaved?
      - Can I filter troubleshooting logs by component and time window?
      instructions:
      - text: List {level} troubleshooting logs of type {log_type}.
        slots:
          level: query.level
          log_type: query.log_type
      - text: Show troubleshooting logs for component {component_name} between {start} and {end}.
        slots:
          component_name: query.component_name
          start: query.start
          end: query.end
      method: generated
      generated: '2026-09-26'