API Evangelist conversational phrasing for BigPanda Alert Filters API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BigPanda Alert Filters API
  version: 1.0.0
extends: openapi/bigpanda-alert-filters-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: 20
- target: $.paths['/resources/v1.0/plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert filters (v1, org token)
      effect: read
      questions:
      - Can I list alert filters with an organization token on the older v1 endpoint?
      - Which v1 alert filters are currently active?
      instructions:
      - text: List all alert filters using the v1 org-token endpoint.
      - text: Get v1 alert filters where active is {active}.
        slots:
          active: query.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v1.0/plans'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alert filter (v1, org token)
      effect: write
      questions:
      - How do I create an alert filter with my org token on the v1 API?
      - Does a v1 alert filter need a BPQL condition and an active flag?
      instructions:
      - text: Create a v1 alert filter named {name} matching BPQL {bpql}, active {active}.
        slots:
          name: requestBody.name
          bpql: requestBody.bpql
          active: requestBody.active
      - text: Using the org token, add filter {name} for {bpql} on schedule {schedule}.
        slots:
          name: requestBody.name
          bpql: requestBody.bpql
          schedule: requestBody.schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert filters (v2, user API key)
      effect: read
      questions:
      - Which alert filters exist in my organization under the current v2 API?
      - Can I see only inactive alert filters with a user API key?
      instructions:
      - text: List every v2 alert filter with my user API key.
      - text: Show v2 alert filters with active set to {active}.
        slots:
          active: query.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/plans'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alert filter (v2, user API key)
      effect: write
      questions:
      - How do I suppress noisy alerts with a new filter in BigPanda?
      - Can a new alert filter exclude certain alert statuses?
      instructions:
      - text: Create an alert filter {name} that drops alerts matching {bpql}, active {active}.
        slots:
          name: requestBody.name
          bpql: requestBody.bpql
          active: requestBody.active
      - text: Add filter {name} for {bpql} excluding statuses {exclude_status}.
        slots:
          name: requestBody.name
          bpql: requestBody.bpql
          exclude_status: requestBody.exclude_status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v1.0/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert filter schedules (v1, org token)
      effect: read
      questions:
      - Can I list maintenance-style filter schedules with the v1 org token API?
      - Which schedules exist on the legacy v1 schedules endpoint?
      instructions:
      - text: List all alert filter schedules via the v1 org-token API.
      - text: Fetch v1 filter schedules for my organization.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v1.0/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alert filter schedule (v1, org token)
      effect: write
      questions:
      - How do I create a filter schedule with a start and end date using the org token?
      - Can I create an inactive schedule on the v1 API?
      instructions:
      - text: With the v1 org-token API, create schedule {name} from {starts_on} to {ends_on}.
        slots:
          name: requestBody.name
          starts_on: requestBody.starts_on
          ends_on: requestBody.ends_on
      - text: Add a v1 filter schedule {name} with active {active}.
        slots:
          name: requestBody.name
          active: requestBody.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List alert filter schedules (v2, user API key)
      effect: read
      questions:
      - What schedules control when my alert filters are applied?
      - Can I list all filter schedules with my user API key?
      instructions:
      - text: List all v2 alert filter schedules.
      - text: Show every schedule my alert filters can use.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an alert filter schedule (v2, user API key)
      effect: write
      questions:
      - How do I schedule an alert filter to run only during a maintenance window?
      - Can I describe a filter schedule when creating it?
      instructions:
      - text: Create filter schedule {name} starting {starts_on} and ending {ends_on}.
        slots:
          name: requestBody.name
          starts_on: requestBody.starts_on
          ends_on: requestBody.ends_on
      - text: Add a v2 schedule {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v1.0/plans/{filter_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an alert filter (v1, org token)
      effect: read
      questions:
      - Can I read a single alert filter's definition with the org token?
      - What BPQL does a given filter use, via the v1 endpoint?
      instructions:
      - text: Get alert filter {filter_id} via the v1 org-token API.
        slots:
          filter_id: path.filter_id
      - text: Show the v1 definition of filter {filter_id}.
        slots:
          filter_id: path.filter_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v1.0/plans/{filter_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alert filter (v1, org token)
      effect: destructive
      questions:
      - Can I delete an alert filter using only an organization token?
      - Is deleting a filter on the v1 endpoint permanent?
      instructions:
      - text: Delete alert filter {filter_id} via the v1 org-token API.
        slots:
          filter_id: path.filter_id
      - text: Remove v1 filter {filter_id} from the system.
        slots:
          filter_id: path.filter_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v1.0/plans/{filter_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an alert filter (v1, org token)
      effect: write
      questions:
      - Can I change a filter's BPQL condition with the org token API?
      - Do I have to resend the name, active flag and BPQL when updating a v1 filter?
      instructions:
      - text: Using the v1 org token, update filter {filter_id} to name {name}, BPQL {bpql}, active {active}.
        slots:
          filter_id: path.filter_id
          name: requestBody.name
          bpql: requestBody.bpql
          active: requestBody.active
      - text: Change v1 filter {filter_id} custom tags to {custom_tags}.
        slots:
          filter_id: path.filter_id
          custom_tags: requestBody.custom_tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/plans/{filter_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an alert filter (v2, user API key)
      effect: read
      questions:
      - What condition and schedule does one of my alert filters use?
      - Can I look up a single filter by ID with a user API key?
      instructions:
      - text: Get alert filter {filter_id}.
        slots:
          filter_id: path.filter_id
      - text: Show the BPQL and schedule of filter {filter_id}.
        slots:
          filter_id: path.filter_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/plans/{filter_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alert filter (v2, user API key)
      effect: destructive
      questions:
      - How do I get rid of an alert filter I no longer need?
      - Will deleting a filter let the previously suppressed alerts through?
      instructions:
      - text: Delete alert filter {filter_id}.
        slots:
          filter_id: path.filter_id
      - text: Permanently remove filter {filter_id} with my user API key.
        slots:
          filter_id: path.filter_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/plans/{filter_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an alert filter (v2, user API key)
      effect: write
      questions:
      - Can I deactivate an alert filter without deleting it?
      - How do I attach a schedule to an existing alert filter?
      instructions:
      - text: 'Update filter {filter_id}: name {name}, condition {bpql}, active {active}.'
        slots:
          filter_id: path.filter_id
          name: requestBody.name
          bpql: requestBody.bpql
          active: requestBody.active
      - text: Attach schedule {schedule} to alert filter {filter_id}.
        slots:
          schedule: requestBody.schedule
          filter_id: path.filter_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v1.0/schedules/{schedule_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a filter schedule (v1, org token)
      effect: read
      questions:
      - Can I read one schedule's start and end with the org token API?
      - Which v1 call shows a single filter schedule?
      instructions:
      - text: Get filter schedule {schedule_id} via the v1 org-token API.
        slots:
          schedule_id: path.schedule_id
      - text: Show v1 schedule {schedule_id} details.
        slots:
          schedule_id: path.schedule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v1.0/schedules/{schedule_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a filter schedule (v1, org token)
      effect: destructive
      questions:
      - Can I delete a filter schedule using the organization token?
      - Is there a v1 route to remove a schedule from the system?
      instructions:
      - text: Delete filter schedule {schedule_id} via the v1 org-token API.
        slots:
          schedule_id: path.schedule_id
      - text: Remove v1 schedule {schedule_id}.
        slots:
          schedule_id: path.schedule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v1.0/schedules/{schedule_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a filter schedule (v1, org token)
      effect: write
      questions:
      - Can I extend a schedule's end date with the org token API?
      - Which v1 call edits an existing filter schedule?
      instructions:
      - text: Using the v1 org token, set schedule {schedule_id} to end on {ends_on}.
        slots:
          schedule_id: path.schedule_id
          ends_on: requestBody.ends_on
      - text: Update v1 schedule {schedule_id} active flag to {active}.
        slots:
          schedule_id: path.schedule_id
          active: requestBody.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/schedules/{schedule_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a filter schedule (v2, user API key)
      effect: read
      questions:
      - When does a particular alert filter schedule start and end?
      - Can I look up one schedule by ID with my user API key?
      instructions:
      - text: Get alert filter schedule {schedule_id}.
        slots:
          schedule_id: path.schedule_id
      - text: Show the start and end dates of schedule {schedule_id}.
        slots:
          schedule_id: path.schedule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/schedules/{schedule_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a filter schedule (v2, user API key)
      effect: destructive
      questions:
      - How do I remove a filter schedule I no longer use?
      - Can I delete a schedule with a user API key?
      instructions:
      - text: Delete alert filter schedule {schedule_id}.
        slots:
          schedule_id: path.schedule_id
      - text: Permanently remove schedule {schedule_id} with my user API key.
        slots:
          schedule_id: path.schedule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/schedules/{schedule_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a filter schedule (v2, user API key)
      effect: write
      questions:
      - Can I move a maintenance window's start date on an existing schedule?
      - How do I rename or pause a filter schedule?
      instructions:
      - text: Change schedule {schedule_id} to start {starts_on} and end {ends_on}.
        slots:
          schedule_id: path.schedule_id
          starts_on: requestBody.starts_on
          ends_on: requestBody.ends_on
      - text: Rename filter schedule {schedule_id} to {name}.
        slots:
          schedule_id: path.schedule_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'