# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bigpanda Maintenance Plans API
  version: 1.0.0
extends: openapi/bigpanda-maintenance-plans-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/maintenance-plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List all maintenance plans
      effect: read
      questions:
      - Which maintenance plans do we have set up in BigPanda?
      - Can I get every maintenance plan in one unfiltered list?
      instructions:
      - text: List all maintenance plans.
      - text: Give me the complete, unfiltered list of maintenance plans.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/maintenance-plans'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a maintenance window to suppress alerts
      effect: write
      questions:
      - How do I suppress alerts from certain hosts during a planned maintenance window?
      - Can I schedule a maintenance plan with a start and end time ahead of a deploy?
      instructions:
      - text: Create a maintenance plan {name} for alerts matching {condition} from {start} to {end}.
        slots:
          name: requestBody.name
          condition: requestBody.condition
          start: requestBody.start
          end: requestBody.end
      - text: Suppress alerts where {condition} between {start} and {end}, calling the plan {name}.
        slots:
          condition: requestBody.condition
          start: requestBody.start
          end: requestBody.end
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/maintenance-plans/{maintenance_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a maintenance plan
      effect: read
      questions:
      - What condition and window does a particular maintenance plan cover?
      - How long after it ends can I still retrieve a maintenance plan?
      instructions:
      - text: Get maintenance plan {maintenance_id}.
        slots:
          maintenance_id: path.maintenance_id
      - text: Show the definition of maintenance plan {maintenance_id}.
        slots:
          maintenance_id: path.maintenance_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/maintenance-plans/{maintenance_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a maintenance plan
      effect: destructive
      questions:
      - Can I delete a maintenance plan that was scheduled by mistake?
      - What removes a maintenance plan from the system entirely?
      instructions:
      - text: Delete maintenance plan {maintenance_id}.
        slots:
          maintenance_id: path.maintenance_id
      - text: Remove maintenance plan {maintenance_id} from the system.
        slots:
          maintenance_id: path.maintenance_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/maintenance-plans/{maintenance_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a maintenance plan
      effect: write
      questions:
      - Can I extend the end time of a maintenance plan that's already running?
      - Which fields of a maintenance plan can I change once it has started?
      instructions:
      - text: 'Update maintenance plan {maintenance_id}: name {name}, condition {condition}, from {start} to {end}.'
        slots:
          maintenance_id: path.maintenance_id
          name: requestBody.name
          condition: requestBody.condition
          start: requestBody.start
          end: requestBody.end
      - text: Make maintenance plan {maintenance_id} recur {frequency} in time zone {time_zone}.
        slots:
          maintenance_id: path.maintenance_id
          frequency: requestBody.frequency
          time_zone: requestBody.time_zone
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/ordered-maintenance-plans'].get
  update:
    x-apievangelist-phrasing:
      intent: Search and filter maintenance plans
      effect: read
      questions:
      - Can I search maintenance plans by text and filter them by status?
      - Which recurring maintenance plans are currently active?
      instructions:
      - text: Search maintenance plans for {search_text} with status {status}.
        slots:
          search_text: query.search_text
          status: query.status
      - text: List maintenance plans with frequency {frequency}, sorted by {sort_by} {order}.
        slots:
          frequency: query.frequency
          sort_by: query.sort_by
          order: query.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/maintenance-plans/{maintenance_id}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop an active maintenance plan
      effect: destructive
      questions:
      - Can I end a maintenance window early once the work is done?
      - Can a maintenance plan that hasn't started yet be stopped?
      instructions:
      - text: Stop maintenance plan {maintenance_id} now.
        slots:
          maintenance_id: path.maintenance_id
      - text: End the active maintenance window {maintenance_id} early so alerts flow again.
        slots:
          maintenance_id: path.maintenance_id
      method: generated
      generated: '2026-09-26'