Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhatsUp Gold Product API

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

$.info

$.paths['/api/v1/product/api'].get

$.paths['/api/v1/product/version'].get

$.paths['/api/v1/product/whoAmI'].get

$.paths['/api/v1/product/installationId'].get

$.paths['/api/v1/product/timezone'].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 Product API
  version: 1.0.0
extends: openapi/progress-software-product-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: 5
- target: $.paths['/api/v1/product/api'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the API version
      effect: read
      questions:
      - What version of the WhatsUp Gold REST API am I talking to?
      - Where can I check API version information?
      instructions:
      - text: Get the current API version.
      - text: Show API version details.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/product/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the product version
      effect: read
      questions:
      - Which product version is installed on the server?
      - What build of the monitoring product is running?
      instructions:
      - text: Get the product version.
      - text: Show which product release is installed.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/product/whoAmI'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current user
      effect: read
      questions:
      - Which user am I authenticated as?
      - Can I check my own account info with my token?
      instructions:
      - text: Tell me who I'm logged in as.
      - text: Show the current user's information.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/product/installationId'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the installation ID
      effect: read
      questions:
      - Is there an ID that uniquely identifies this install?
      - What is the installation identifier of my server?
      instructions:
      - text: Get the installation ID.
      - text: Show the unique ID for this install.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/product/timezone'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the server's local time zone
      effect: read
      questions:
      - What time zone is the server set to?
      - Can I find the server's local timezone to interpret timestamps?
      instructions:
      - text: Get the server's local time zone.
      - text: Show which timezone the monitoring server uses.
      method: generated
      generated: '2026-10-01'