Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Chef Automate API Documentation Deployment API

3 actions 3 updates phrasing extends openapi/progress-software-deployment-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/deployment/service_versions'].get

$.paths['/api/v0/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 Deployment API
  version: 1.0.0
extends: openapi/progress-software-deployment-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/deployment/service_versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions of each deployed service
      effect: read
      questions:
      - Which version of each internal service is my Automate deployment running?
      - Can I see per-service build versions to check an upgrade landed?
      instructions:
      - text: List the versions of all deployed Automate services.
      - text: Show each service's installed version in this deployment.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Automate deployment version
      effect: read
      questions:
      - What overall version of Chef Automate is installed?
      - Which build is this Automate server on?
      instructions:
      - text: Get the Automate version.
      - text: Tell me the installed build number of Automate.
      method: generated
      generated: '2026-10-01'