Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Chef Automate API Documentation Gateway API

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

$.info

$.paths['/api/v0/gateway/health'].get

$.paths['/api/v0/gateway/version'].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 Gateway API
  version: 1.0.0
extends: openapi/progress-software-gateway-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: 2
- target: $.paths['/api/v0/gateway/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the gateway's health
      effect: read
      questions:
      - Is the Chef Automate gateway healthy?
      - Can I check whether the API gateway is up before making calls?
      instructions:
      - text: Check the gateway health.
      - text: Report whether the gateway service is healthy.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/gateway/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the gateway version
      effect: read
      questions:
      - Which version of the gateway is running?
      - What build is the API gateway on?
      instructions:
      - text: Show the gateway version.
      - text: Get the running gateway build number.
      method: generated
      generated: '2026-10-01'