Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for WhatsUp Gold Error API

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

$.info
$.paths['/api/v1/errors/{errorType}'].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 Error API
  version: 1.0.0
extends: openapi/progress-software-error-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: 1
- target: $.paths['/api/v1/errors/{errorType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Trigger a test error
      effect: read
      questions:
      - Can I deliberately trigger an error to test my client's error handling?
      - What format do API error responses use?
      instructions:
      - text: Trigger a {errorType} test error.
        slots:
          errorType: path.errorType
      - text: Induce error type {errorType} to test error handling.
        slots:
          errorType: path.errorType
      method: generated
      generated: '2026-10-01'