# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BigPanda AI Settings API
  version: 1.0.0
extends: openapi/bigpanda-ai-settings-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['/resources/v2.1/ai-analysis/configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: List AI Analysis configurations
      effect: read
      questions:
      - Which AI Analysis configurations are set up for our incidents?
      - Can I see every AI Analysis configuration and whether it's enabled?
      instructions:
      - text: List all AI Analysis configurations.
      - text: Show every AI Analysis configuration we have.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/ai-analysis/configuration'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an AI Analysis configuration
      effect: write
      questions:
      - How do I set up AI Analysis to run automatically on incidents in certain environments?
      - Can I add my own instructions to the AI Analysis prompt?
      instructions:
      - text: Create AI Analysis config {name} on {environments} for tags {alertTags}, enabled {enabled}, auto-run {isAutoTriggerEnabled}, addendum {promptAddendum}.
        slots:
          name: requestBody.name
          environments: requestBody.environments
          alertTags: requestBody.alertTags
          enabled: requestBody.enabled
          isAutoTriggerEnabled: requestBody.isAutoTriggerEnabled
          promptAddendum: requestBody.promptAddendum
      - text: Set up a new AI Analysis configuration named {name} for environments {environments}.
        slots:
          name: requestBody.name
          environments: requestBody.environments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/ai-analysis/configuration/{aia_config_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an AI Analysis configuration
      effect: read
      questions:
      - What environments and alert tags does a specific AI Analysis configuration use?
      - Is auto-trigger on for a particular AI Analysis configuration?
      instructions:
      - text: Get AI Analysis configuration {aia_config_id}.
        slots:
          aia_config_id: path.aia_config_id
      - text: Show the prompt addendum and settings of AI Analysis config {aia_config_id}.
        slots:
          aia_config_id: path.aia_config_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/ai-analysis/configuration/{aia_config_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an AI Analysis configuration
      effect: destructive
      questions:
      - Can I delete an AI Analysis configuration we no longer want?
      - What removes an AI Analysis configuration permanently?
      instructions:
      - text: Delete AI Analysis configuration {aia_config_id}.
        slots:
          aia_config_id: path.aia_config_id
      - text: Remove the AI Analysis config {aia_config_id}.
        slots:
          aia_config_id: path.aia_config_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/ai-analysis/configuration/{aia_config_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an AI Analysis configuration
      effect: write
      questions:
      - Can I turn off auto-trigger on an existing AI Analysis configuration?
      - Can I change the prompt addendum of an AI Analysis config after creating it?
      instructions:
      - text: 'Update AI config {aia_config_id}: {name}, enabled {enabled}, on {environments}, tags {alertTags}, auto-run {isAutoTriggerEnabled}, addendum {promptAddendum}.'
        slots:
          aia_config_id: path.aia_config_id
          name: requestBody.name
          enabled: requestBody.enabled
          environments: requestBody.environments
          alertTags: requestBody.alertTags
          isAutoTriggerEnabled: requestBody.isAutoTriggerEnabled
          promptAddendum: requestBody.promptAddendum
      - text: Change the prompt addendum on AI Analysis config {aia_config_id} to {promptAddendum}.
        slots:
          aia_config_id: path.aia_config_id
          promptAddendum: requestBody.promptAddendum
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/environments/{environment_id}/incidents/{incident_id}/ai/analysis'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate an AI analysis for an incident
      effect: write
      questions:
      - Can I ask BigPanda to generate an AI analysis for a specific incident on demand?
      - How do I regenerate the AI analysis after new alerts join an incident?
      instructions:
      - text: Generate an AI analysis for incident {incident_id} in environment {environment_id}.
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      - text: Regenerate the AI analysis on incident {incident_id} ({environment_id}).
        slots:
          incident_id: path.incident_id
          environment_id: path.environment_id
      method: generated
      generated: '2026-09-26'