BigPanda · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BigPanda Audit Log API

3 actions 3 updates phrasing extends openapi/bigpanda-audit-log-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 3

$.info
$.paths['/audit-logs'].get
$.paths['/audit-logs/metadata'].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 Audit Log API
  version: 1.0.0
extends: openapi/bigpanda-audit-log-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: 2
- target: $.paths['/audit-logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Search audit log entries
      effect: read
      questions:
      - Who deleted configuration objects in my BigPanda org last week?
      - Can I filter audit entries by create, update or delete?
      - Are sensitive old and new values redacted in audit results?
      instructions:
      - text: Show audit log entries from {from} to {to}.
        slots:
          from: query.from
          to: query.to
      - text: List audit entries with change type {changeType}.
        slots:
          changeType: query.changeType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audit-logs/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get valid audit log filter values
      effect: read
      questions:
      - Which entity types and change types can I filter the audit log by?
      - What values are valid for audit log filters?
      instructions:
      - text: Get the audit log metadata for building filters.
      - text: List valid audit log filter values.
      method: generated
      generated: '2026-09-26'