Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhatsUp Gold Device Report API

12 actions 12 updates phrasing extends openapi/progress-software-devicereport-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Progress Software's API. It is a proposal applied on top of the contract, not a document Progress Software publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 12

$.info

$.paths['/api/v1/devices/{deviceId}/reports/cpu-utilization'].get

$.paths['/api/v1/devices/{deviceId}/reports/disk-free-space'].get

$.paths['/api/v1/devices/{deviceId}/reports/disk-utilization'].get

$.paths['/api/v1/devices/{deviceId}/reports/interface-discards'].get

$.paths['/api/v1/devices/{deviceId}/reports/interface-errors'].get

$.paths['/api/v1/devices/{deviceId}/reports/interface-traffic'].get

$.paths['/api/v1/devices/{deviceId}/reports/interface-utilization'].get

$.paths['/api/v1/devices/{deviceId}/reports/memory-utilization'].get

$.paths['/api/v1/devices/{deviceId}/reports/ping-availability'].get

$.paths['/api/v1/devices/{deviceId}/reports/ping-response-time'].get

$.paths['/api/v1/devices/{deviceId}/reports/state-change'].get

OpenAPI Overlay

# 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 Device Report API
  version: 1.0.0
extends: openapi/progress-software-devicereport-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: 11
- target: $.paths['/api/v1/devices/{deviceId}/reports/cpu-utilization'].get
  update:
    x-apievangelist-phrasing:
      intent: Report a device's CPU utilization
      effect: read
      questions:
      - How busy has a device's CPU been today?
      - Can I flag only processors running over a CPU percentage threshold?
      - Is it possible to roll CPU usage up to the device level instead of per core?
      instructions:
      - text: Show CPU utilization for device {deviceId} over {range}.
        slots:
          deviceId: path.deviceId
          range: query.range
      - text: List CPUs on device {deviceId} running above {thresholdValue} percent.
        slots:
          deviceId: path.deviceId
          thresholdValue: query.thresholdValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/devices/{deviceId}/reports/disk-free-space'].get
  update:
    x-apievangelist-phrasing:
      intent: Report a device's free disk space
      effect: read
      questions:
      - How much free disk space is left on a server?
      - Which volumes on a device are below a free-space threshold?
      instructions:
      - text: Show free disk space on device {deviceId} for {range}.
        slots:
          deviceId: path.deviceId
          range: query.range
      - text: Find drives on device {deviceId} with less than {thresholdValue} free.
        slots:
          deviceId: path.deviceId
          thresholdValue: query.thresholdValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/devices/{deviceId}/reports/disk-utilization'].get
  update:
    x-apievangelist-phrasing:
      intent: Report a device's disk utilization
      effect: read
      questions:
      - What percentage of each disk is used on a device?
      - Can I see disk usage for a device over last month sorted by the fullest volume?
      instructions:
      - text: Get the disk utilization report for device {deviceId} covering {range}.
        slots:
          deviceId: path.deviceId
          range: query.range
      - text: Show disks on device {deviceId} more than {thresholdValue} percent used.
        slots:
          deviceId: path.deviceId
          thresholdValue: query.thresholdValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/devices/{deviceId}/reports/interface-discards'].get
  update:
    x-apievangelist-phrasing:
      intent: Report packet discards on a device's interfaces
      effect: read
      questions:
      - Are any network interfaces on a switch discarding packets?
      - Can I limit interface discard counts to business hours?
      instructions:
      - text: Show interface discards for device {deviceId} over {range}.
        slots:
          deviceId: path.deviceId
          range: query.range
      - text: Report dropped packets on device {deviceId}'s interfaces during business hours {businessHoursId}.
        slots:
          deviceId: path.deviceId
          businessHoursId: query.businessHoursId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/devices/{deviceId}/reports/interface-errors'].get
  update:
    x-apievangelist-phrasing:
      intent: Report errors on a device's interfaces
      effect: read
      questions:
      - Which interfaces on a router are logging errors?
      - Can I pull interface error counts for a custom start and end date?
      instructions:
      - text: Show interface errors on device {deviceId} for {range}.
        slots:
          deviceId: path.deviceId
          range: query.range
      - text: Report interface errors for device {deviceId} between {rangeStartUtc} and {rangeEndUtc}.
        slots:
          deviceId: path.deviceId
          rangeStartUtc: query.rangeStartUtc
          rangeEndUtc: query.rangeEndUtc
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/devices/{deviceId}/reports/interface-traffic'].get
  update:
    x-apievangelist-phrasing:
      intent: Report traffic volume on a device's interfaces
      effect: read
      questions:
      - How much traffic has gone through each port on a device this week?
      - Can I sort interface traffic by the busiest port?
      instructions:
      - text: Show interface traffic for device {deviceId} over {range}.
        slots:
          deviceId: path.deviceId
          range: query.range
      - text: Report bandwidth throughput per interface on device {deviceId} sorted by {sortBy}.
        slots:
          deviceId: path.deviceId
          sortBy: query.sortBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/devices/{deviceId}/reports/interface-utilization'].get
  update:
    x-apievangelist-phrasing:
      intent: Report interface utilization percentages on a device
      effect: read
      questions:
      - Which interfaces on a device are close to saturating their link capacity?
      - Can I filter interface utilization to links running over a percentage?
      instructions:
      - text: Get interface utilization for device {deviceId} covering {range}.
        slots:
          deviceId: path.deviceId
          range: query.range
      - text: List interfaces on device {deviceId} with utilization over {thresholdValue} percent.
        slots:
          deviceId: path.deviceId
          thresholdValue: query.thresholdValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/devices/{deviceId}/reports/memory-utilization'].get
  update:
    x-apievangelist-phrasing:
      intent: Report a device's memory utilization
      effect: read
      questions:
      - How much RAM is a device using?
      - Is it possible to see memory usage for a device during last quarter?
      instructions:
      - text: Show memory utilization for device {deviceId} over {range}.
        slots:
          deviceId: path.deviceId
          range: query.range
      - text: Find memory on device {deviceId} that's above {thresholdValue} percent used.
        slots:
          deviceId: path.deviceId
          thresholdValue: query.thresholdValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/devices/{deviceId}/reports/ping-availability'].get
  update:
    x-apievangelist-phrasing:
      intent: Report a device's ping availability and packet loss
      effect: read
      questions:
      - What was a device's uptime percentage based on ping this month?
      - Can I flag a device whose ping packet loss went over a percentage?
      instructions:
      - text: Show ping availability for device {deviceId} over {range}.
        slots:
          deviceId: path.deviceId
          range: query.range
      - text: Report when device {deviceId} had packet loss above {packetLossPercentageThresholdValue} percent.
        slots:
          deviceId: path.deviceId
          packetLossPercentageThresholdValue: query.packetLossPercentageThresholdValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/devices/{deviceId}/reports/ping-response-time'].get
  update:
    x-apievangelist-phrasing:
      intent: Report a device's ping response time
      effect: read
      questions:
      - How fast has a device been answering pings?
      - Can I find ping latency spikes above a millisecond threshold?
      instructions:
      - text: Show ping response time for device {deviceId} over {range}.
        slots:
          deviceId: path.deviceId
          range: query.range
      - text: Report ping latency for device {deviceId} slower than {thresholdValue} ms.
        slots:
          deviceId: path.deviceId
          thresholdValue: query.thresholdValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/devices/{deviceId}/reports/state-change'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a device's up/down state change timeline
      effect: read
      questions:
      - When did a device go down and come back up?
      - Can I see a timeline of state changes for a device yesterday?
      instructions:
      - text: Show the state change timeline for device {deviceId} over {range}.
        slots:
          deviceId: path.deviceId
          range: query.range
      - text: List every up and down transition of device {deviceId} between {rangeStartUtc} and {rangeEndUtc}.
        slots:
          deviceId: path.deviceId
          rangeStartUtc: query.rangeStartUtc
          rangeEndUtc: query.rangeEndUtc
      method: generated
      generated: '2026-10-01'