Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Chef Automate API Documentation Telemetry API

2 actions 2 updates phrasing extends openapi/progress-software-telemetry-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/v0/telemetry/config'].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 Chef Automate API Documentation Telemetry API
  version: 1.0.0
extends: openapi/progress-software-telemetry-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/v0/telemetry/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the telemetry configuration
      effect: read
      questions:
      - Is telemetry enabled on my Chef Automate install?
      - What telemetry settings are configured?
      instructions:
      - text: Show the telemetry configuration.
      - text: Check whether telemetry is turned on.
      method: generated
      generated: '2026-10-01'