Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhatsUp Gold Device Group Report API

13 actions 13 updates phrasing extends openapi/progress-software-devicegroupreport-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 13

$.info
$.paths['/api/v1/device-groups/{groupId}/devices/reports/cpu-utilization'].get
$.paths['/api/v1/device-groups/{groupId}/devices/reports/disk-free-space'].get
$.paths['/api/v1/device-groups/{groupId}/devices/reports/disk-utilization'].get
$.paths['/api/v1/device-groups/{groupId}/devices/reports/interface-discards'].get
$.paths['/api/v1/device-groups/{groupId}/devices/reports/interface-errors'].get
$.paths['/api/v1/device-groups/{groupId}/devices/reports/interface-traffic'].get
$.paths['/api/v1/device-groups/{groupId}/devices/reports/interface-utilization'].get
$.paths['/api/v1/device-groups/{groupId}/devices/reports/memory-utilization'].get
$.paths['/api/v1/device-groups/{groupId}/devices/reports/ping-availability'].get
$.paths['/api/v1/device-groups/{groupId}/devices/reports/ping-response-time'].get
$.paths['/api/v1/device-groups/{groupId}/devices/reports/state-change'].get
$.paths['/api/v1/device-groups/{groupId}/devices/reports/device-maintenance-mode'].get

OpenAPI Overlay

Raw ↑ 
# 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 Group Report API
  version: 1.0.0
extends: openapi/progress-software-devicegroupreport-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: 12
- target: $.paths['/api/v1/device-groups/{groupId}/devices/reports/cpu-utilization'].get
  update:
    x-apievangelist-phrasing:
      intent: Report CPU utilization for a device group
      effect: read
      questions:
      - Which devices in a group are running the hottest CPUs?
      - Can I see only devices whose CPU usage is over a threshold?
      - What was average CPU utilization across a group last month?
      instructions:
      - text: Run the CPU utilization report for device group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show CPU utilization for group {groupId} over {range}, including subgroups.
        slots:
          groupId: path.groupId
          range: query.range
      - text: List devices in group {groupId} with CPU above {thresholdValue} percent.
        slots:
          groupId: path.groupId
          thresholdValue: query.thresholdValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-groups/{groupId}/devices/reports/disk-free-space'].get
  update:
    x-apievangelist-phrasing:
      intent: Report free disk space for a device group
      effect: read
      questions:
      - Which servers in a group are running low on free disk space?
      - Can I filter the free-space report to disks under a certain amount?
      instructions:
      - text: Run the disk free space report for device group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show free disk space in group {groupId} for {range}.
        slots:
          groupId: path.groupId
          range: query.range
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-groups/{groupId}/devices/reports/disk-utilization'].get
  update:
    x-apievangelist-phrasing:
      intent: Report disk utilization for a device group
      effect: read
      questions:
      - What percentage of disk capacity is used across a device group?
      - Can I sort a group's disk usage report so the fullest disks come first?
      instructions:
      - text: Run the disk utilization report for device group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show disk utilization in group {groupId} sorted by {sortBy}.
        slots:
          groupId: path.groupId
          sortBy: query.sortBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-groups/{groupId}/devices/reports/interface-discards'].get
  update:
    x-apievangelist-phrasing:
      intent: Report interface discards for a device group
      effect: read
      questions:
      - Which interfaces in a group are discarding packets?
      - Can I limit the packet discards report to business hours?
      instructions:
      - text: Run the interface discards report for device group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show interface discards in group {groupId} during business hours {businessHoursId}.
        slots:
          groupId: path.groupId
          businessHoursId: query.businessHoursId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-groups/{groupId}/devices/reports/interface-errors'].get
  update:
    x-apievangelist-phrasing:
      intent: Report interface errors for a device group
      effect: read
      questions:
      - Which network interfaces in a group are logging errors?
      - Can I see interface errors for yesterday only?
      instructions:
      - text: Run the interface errors report for device group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show interface errors in group {groupId} for {range}.
        slots:
          groupId: path.groupId
          range: query.range
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-groups/{groupId}/devices/reports/interface-traffic'].get
  update:
    x-apievangelist-phrasing:
      intent: Report interface traffic for a device group
      effect: read
      questions:
      - How much traffic is flowing through the interfaces in a device group?
      - Can I pull interface traffic for a custom start and end date?
      instructions:
      - text: Run the interface traffic report for device group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show interface traffic in group {groupId} from {rangeStartUtc} to {rangeEndUtc}.
        slots:
          groupId: path.groupId
          rangeStartUtc: query.rangeStartUtc
          rangeEndUtc: query.rangeEndUtc
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-groups/{groupId}/devices/reports/interface-utilization'].get
  update:
    x-apievangelist-phrasing:
      intent: Report interface utilization for a device group
      effect: read
      questions:
      - Which links in a group are close to saturating their bandwidth?
      - Can I list interfaces whose utilization percentage is over a threshold?
      instructions:
      - text: Run the interface utilization report for device group {groupId}.
        slots:
          groupId: path.groupId
      - text: List interfaces in group {groupId} with utilization above {thresholdValue} percent.
        slots:
          groupId: path.groupId
          thresholdValue: query.thresholdValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-groups/{groupId}/devices/reports/memory-utilization'].get
  update:
    x-apievangelist-phrasing:
      intent: Report memory utilization for a device group
      effect: read
      questions:
      - Which devices in a group are short on memory?
      - What was memory usage across a group quarter to date?
      instructions:
      - text: Run the memory utilization report for device group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show devices in group {groupId} with memory use above {thresholdValue} percent.
        slots:
          groupId: path.groupId
          thresholdValue: query.thresholdValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-groups/{groupId}/devices/reports/ping-availability'].get
  update:
    x-apievangelist-phrasing:
      intent: Report ping availability and packet loss for a group
      effect: read
      questions:
      - What was ping uptime for every device in a group?
      - Can I find devices whose packet loss went above a set percentage?
      instructions:
      - text: Run the ping availability report for device group {groupId}.
        slots:
          groupId: path.groupId
      - text: List devices in group {groupId} with availability below {percentageAvailableThresholdValue} percent.
        slots:
          groupId: path.groupId
          percentageAvailableThresholdValue: query.percentageAvailableThresholdValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-groups/{groupId}/devices/reports/ping-response-time'].get
  update:
    x-apievangelist-phrasing:
      intent: Report ping response times for a device group
      effect: read
      questions:
      - Which devices in a group respond slowest to ping?
      - Can I flag devices whose ping latency exceeds a threshold?
      instructions:
      - text: Run the ping response time report for device group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show devices in group {groupId} with ping response time over {thresholdValue}.
        slots:
          groupId: path.groupId
          thresholdValue: query.thresholdValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-groups/{groupId}/devices/reports/state-change'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the up/down state change timeline for a group
      effect: read
      questions:
      - When did devices in a group go down or come back up?
      - Can I see the state change timeline for a group over the last week?
      instructions:
      - text: Show the state change timeline for device group {groupId}.
        slots:
          groupId: path.groupId
      - text: List state changes in group {groupId} for {range}.
        slots:
          groupId: path.groupId
          range: query.range
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-groups/{groupId}/devices/reports/device-maintenance-mode'].get
  update:
    x-apievangelist-phrasing:
      intent: Report which devices in a group are in maintenance
      effect: read
      questions:
      - Which devices in a group are currently in maintenance mode?
      - Can the maintenance mode report include devices in child groups?
      instructions:
      - text: Show the maintenance mode report for device group {groupId}.
        slots:
          groupId: path.groupId
      - text: List devices in maintenance under group {groupId} and its subgroups, {limit} per page.
        slots:
          groupId: path.groupId
          limit: query.limit
      method: generated
      generated: '2026-10-01'