Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhatsUp Gold Device Scan API

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

$.info
$.paths['/api/v1/device-scan/{scanId}/devices'].get
$.paths['/api/v1/device-scan/{scanId}/status'].get
$.paths['/api/v1/device-scan/{scanId}/cancel'].put
$.paths['/api/v1/device-scan/-/status'].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 Scan API
  version: 1.0.0
extends: openapi/progress-software-devicescan-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: 4
- target: $.paths['/api/v1/device-scan/{scanId}/devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List devices updated by a scan
      effect: read
      questions:
      - Which devices were added or changed by a discovery scan?
      - Can I search the devices a scan updated by hostname?
      instructions:
      - text: List devices updated by scan {scanId}.
        slots:
          scanId: path.scanId
      - text: Find devices from scan {scanId} matching {search}.
        slots:
          scanId: path.scanId
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-scan/{scanId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of a scan
      effect: read
      questions:
      - Is my device scan still running or has it finished?
      - How far along is a particular discovery scan?
      instructions:
      - text: Show the status of scan {scanId}.
        slots:
          scanId: path.scanId
      - text: Check whether scan {scanId} has completed.
        slots:
          scanId: path.scanId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-scan/{scanId}/cancel'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel an active scan
      effect: destructive
      questions:
      - How do I stop a device scan that's taking too long?
      - Can I cancel a scan I started by adding a device?
      instructions:
      - text: Cancel scan {scanId}.
        slots:
          scanId: path.scanId
      - text: Stop the running discovery scan {scanId}.
        slots:
          scanId: path.scanId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/device-scan/-/status'].get
  update:
    x-apievangelist-phrasing:
      intent: List the status of all scans
      effect: read
      questions:
      - What device scans are in progress right now?
      - Can I include finished scans when listing scan statuses?
      instructions:
      - text: List the status of all active scans.
      - text: Show scans of type {model}, activeOnly {activeOnly}.
        slots:
          model: query.model
          activeOnly: query.activeOnly
      method: generated
      generated: '2026-10-01'