# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for WhatsUp Gold Pollers API
  version: 1.0.0
extends: openapi/progress-software-pollers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/api/v1/pollers'].get
  update:
    x-apievangelist-phrasing:
      intent: List pollers and their status
      effect: read
      questions:
      - Which pollers are configured and are they healthy?
      - What scalability pollers exist in WhatsUp Gold?
      instructions:
      - text: List all pollers with their status.
      - text: Show every configured poller.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/pollers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a poller
      effect: write
      questions:
      - How do I add a new poller and assign devices to it?
      - Can a new poller be assigned whole subnets and used for load balancing?
      instructions:
      - text: Create a poller named {name} for subnets {assignedSubnets}.
        slots:
          name: requestBody.name
          assignedSubnets: requestBody.assignedSubnets
      - text: Add poller {name} and assign devices {assignedDeviceIds}.
        slots:
          name: requestBody.name
          assignedDeviceIds: requestBody.assignedDeviceIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/pollers/{pollerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one poller
      effect: read
      questions:
      - What devices and subnets is a specific poller handling?
      - Is a given poller enabled?
      instructions:
      - text: Show poller {pollerId}.
        slots:
          pollerId: path.pollerId
      - text: Get the configuration of poller {pollerId}.
        slots:
          pollerId: path.pollerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/pollers/{pollerId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a poller's configuration
      effect: write
      questions:
      - How do I move devices onto an existing poller?
      - Can I disable an existing poller or take it out of load balancing?
      instructions:
      - text: Assign devices {assignedDeviceIds} to existing poller {pollerId}.
        slots:
          assignedDeviceIds: requestBody.assignedDeviceIds
          pollerId: path.pollerId
      - text: Set poller {pollerId} enabled to {isEnabled}.
        slots:
          pollerId: path.pollerId
          isEnabled: requestBody.isEnabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/pollers/{pollerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a poller
      effect: destructive
      questions:
      - How do I delete a poller I no longer need?
      - Can I remove a poller's configuration by its ID?
      instructions:
      - text: Delete poller {pollerId}.
        slots:
          pollerId: path.pollerId
      - text: Remove the configuration for poller {pollerId}.
        slots:
          pollerId: path.pollerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/pollers/by-name/{name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Get or create a poller by name
      effect: write
      questions:
      - Is there a way to ensure a poller with a given name exists without creating a duplicate?
      - What does the poller installer call to register its poller by name?
      instructions:
      - text: Ensure a poller named {name} exists, creating it if missing.
        slots:
          name: path.name
      - text: Get or create poller by name {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'