BigPanda · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BigPanda Email Parser Configuration API

7 actions 7 updates phrasing extends openapi/bigpanda-email-parser-configuration-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 7

$.info
$.paths['/configurations/alerts/{integration}/{app_key_p}/versions/diff'].get
$.paths['/configurations/alerts/emailparser/{app_key_p}'].get
$.paths['/configurations/alerts/emailparser/{app_key_p}'].post
$.paths['/configurations/alerts/{integration}/{app_key_p}/versions'].get
$.paths['/configurations/alerts/{integration}/{app_key_p}/versions/{version}/restore'].post
$.paths['/configurations/alerts/{integration}/{app_key_p}/versions/{version}'].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 Email Parser Configuration API
  version: 1.0.0
extends: openapi/bigpanda-email-parser-configuration-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: 6
- target: $.paths['/configurations/alerts/{integration}/{app_key_p}/versions/diff'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare two integration configuration versions
      effect: read
      questions:
      - What changed between two saved versions of my parser configuration?
      - Can I see which fields were added, removed or modified between versions?
      instructions:
      - text: Diff {integration} config for app key {app_key_p} from version {from} to {to}.
        slots:
          integration: path.integration
          app_key_p: path.app_key_p
          from: query.from
          to: query.to
      - text: Compare versions {from} and {to} of the {integration} integration with app key {app_key}.
        slots:
          from: query.from
          to: query.to
          integration: path.integration
          app_key: path.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configurations/alerts/emailparser/{app_key_p}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an email parser configuration
      effect: read
      questions:
      - What parsing rules does my email integration currently use?
      - Can I read back the active email parser config for an integration?
      instructions:
      - text: Get the email parser configuration for app key {app_key_p}.
        slots:
          app_key_p: path.app_key_p
      - text: Show the active email parsing rules of integration {app_key_p}.
        slots:
          app_key_p: path.app_key_p
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configurations/alerts/emailparser/{app_key_p}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update an email parser configuration
      effect: write
      questions:
      - How do I tell BigPanda how to parse alert emails into tags?
      - Can I include a sample email payload when saving the parser config?
      instructions:
      - text: Save email parser config {config} for app key {app_key_p}.
        slots:
          config: requestBody.config
          app_key_p: path.app_key_p
      - text: Update the email parser of {app_key_p} using sample payload {sample_payload}.
        slots:
          app_key_p: path.app_key_p
          sample_payload: requestBody.sample_payload
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configurations/alerts/{integration}/{app_key_p}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved configuration versions
      effect: read
      questions:
      - What's the history of saved configurations for my integration?
      - How far back does configuration version history go?
      instructions:
      - text: List saved config versions of {integration} integration {app_key_p}.
        slots:
          integration: path.integration
          app_key_p: path.app_key_p
      - text: Show version history for the {integration} integration with app key {app_key}.
        slots:
          integration: path.integration
          app_key: path.app_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configurations/alerts/{integration}/{app_key_p}/versions/{version}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a previous configuration version
      effect: write
      questions:
      - Can I roll my integration config back to an earlier saved version?
      - Does restoring an old version create a new entry in the history?
      instructions:
      - text: Restore version {version} of the {integration} config for app key {app_key_p}.
        slots:
          version: path.version
          integration: path.integration
          app_key_p: path.app_key_p
      - text: Roll back {integration} integration {app_key} to version {version}.
        slots:
          integration: path.integration
          app_key: path.app_key
          version: path.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/configurations/alerts/{integration}/{app_key_p}/versions/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one saved configuration version
      effect: read
      questions:
      - Can I view exactly what a past configuration version contained?
      - What did my parser configuration look like at a specific saved version?
      instructions:
      - text: Get version {version} of the {integration} config for app key {app_key_p}.
        slots:
          version: path.version
          integration: path.integration
          app_key_p: path.app_key_p
      - text: Show saved version {version} of {integration} integration {app_key}.
        slots:
          version: path.version
          integration: path.integration
          app_key: path.app_key
      method: generated
      generated: '2026-09-26'