Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Chef Automate API Documentation Legacy Data Collector API

2 actions 2 updates phrasing extends openapi/progress-software-legacydatacollector-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/events/data-collector'].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 Legacy Data Collector API
  version: 1.0.0
extends: openapi/progress-software-legacydatacollector-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/events/data-collector'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the legacy data collector endpoint
      effect: read
      questions:
      - How does a Chef server check that Automate's data collector is reachable?
      - Is the legacy data-collector endpoint up?
      instructions:
      - text: Check the status of the legacy data collector.
      - text: Ping the data-collector endpoint the Chef server uses.
      method: generated
      generated: '2026-10-01'