Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Chef Automate API Documentation Applications Service API

3 actions 3 updates phrasing extends openapi/progress-software-applicationsservice-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/applications/telemetry/services/count'].get

$.paths['/api/v0/applications/telemetry/services/count/updated'].put

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 Applications Service API
  version: 1.0.0
extends: openapi/progress-software-applicationsservice-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/applications/telemetry/services/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the services usage count for telemetry
      effect: read
      questions:
      - How many application services are counted for telemetry?
      - What services usage count does Applications report?
      instructions:
      - text: Show the applications services usage count.
      - text: Get the telemetry count of services.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/applications/telemetry/services/count/updated'].put
  update:
    x-apievangelist-phrasing:
      intent: Record when services telemetry was last reported
      effect: write
      questions:
      - How do I record the time services telemetry was last sent?
      - Can I update the last telemetry reported timestamp for applications?
      instructions:
      - text: Set the services telemetry last reported time to {last_telemetry_reported_at}.
        slots:
          last_telemetry_reported_at: requestBody.last_telemetry_reported_at
      - text: Mark services telemetry as reported at {last_telemetry_reported_at}.
        slots:
          last_telemetry_reported_at: requestBody.last_telemetry_reported_at
      method: generated
      generated: '2026-10-01'