# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BigPanda Correlation Patterns API
  version: 1.0.0
extends: openapi/bigpanda-correlation-patterns-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: 7
- target: $.paths['/resources/v2.0/correlation-patterns'].get
  update:
    x-apievangelist-phrasing:
      intent: List correlation patterns
      effect: read
      questions:
      - Which correlation patterns group my alerts into incidents?
      - Can I list only the active correlation patterns?
      instructions:
      - text: List all correlation patterns.
      - text: Show correlation patterns where active is {active}.
        slots:
          active: query.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/correlation-patterns'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a correlation pattern
      effect: write
      questions:
      - How do I make BigPanda correlate alerts that share the same host within a time window?
      - Can a correlation pattern group alerts across different sources?
      instructions:
      - text: Create a correlation pattern on tags {tags} with a {time_window} window for {filter}.
        slots:
          tags: requestBody.tags
          time_window: requestBody.time_window
          filter: requestBody.filter
      - text: Add a cross-source pattern with time window {time_window} and filter {filter}, cross_source {cross_source}.
        slots:
          time_window: requestBody.time_window
          filter: requestBody.filter
          cross_source: requestBody.cross_source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/correlation-patterns/{pattern_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a correlation pattern
      effect: read
      questions:
      - What tags and time window does a specific correlation pattern use?
      - Can I read one correlation pattern's configuration by ID?
      instructions:
      - text: Get correlation pattern {pattern_id}.
        slots:
          pattern_id: path.pattern_id
      - text: Show the tags and window of pattern {pattern_id}.
        slots:
          pattern_id: path.pattern_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/correlation-patterns/{pattern_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a correlation pattern
      effect: destructive
      questions:
      - How do I remove a correlation rule that's merging unrelated alerts?
      - Can I delete a correlation pattern by ID?
      instructions:
      - text: Delete correlation pattern {pattern_id}.
        slots:
          pattern_id: path.pattern_id
      - text: Remove the correlation rule {pattern_id}.
        slots:
          pattern_id: path.pattern_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/correlation-patterns/{pattern_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a correlation pattern
      effect: write
      questions:
      - Can I widen the time window on an existing correlation pattern?
      - How do I disable a correlation pattern without deleting it?
      instructions:
      - text: Set the time window of pattern {pattern_id} to {time_window}.
        slots:
          pattern_id: path.pattern_id
          time_window: requestBody.time_window
      - text: Set active to {active} on correlation pattern {pattern_id}.
        slots:
          active: requestBody.active
          pattern_id: path.pattern_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/correlation-patterns-order/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset correlation pattern order to time window
      effect: write
      questions:
      - Can I undo a custom rule order and go back to ordering by time window?
      - What does resetting the correlation pattern order do?
      instructions:
      - text: Reset the correlation pattern run order to sort by time window.
      - text: Restore the default correlation rule ordering.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.1/correlation-patterns-order'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the run order of correlation patterns
      effect: write
      questions:
      - Can I control which correlation rule gets evaluated first?
      - How do I reorder my correlation patterns?
      instructions:
      - text: Set the correlation rule execution order to {execution_order}.
        slots:
          execution_order: requestBody.execution_order
      - text: Reorder correlation patterns as {execution_order}.
        slots:
          execution_order: requestBody.execution_order
      method: generated
      generated: '2026-09-26'