ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for VDI & DAAS Host API

3 actions 3 updates phrasing extends openapi/controlup-host-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for ControlUp's API. It is a proposal applied on top of the contract, not a document ControlUp publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/hosts/metrics'].get

$.paths['/v1/hosts/counts'].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 VDI & DAAS Host API
  version: 1.0.0
extends: openapi/controlup-host-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v1/hosts/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get average host resource use per folder
      effect: read
      questions:
      - What was the average host CPU or memory consumption per folder last week?
      - Can I compare host resource usage across folders over a period?
      instructions:
      - text: Get host {metrics} per folder from {_timeFrom} to {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
          metrics: query.metrics
      - text: Show average {metrics} by folder for hosts between {_timeFrom} and {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
          metrics: query.metrics
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/hosts/counts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage statistics per host
      effect: read
      questions:
      - What usage counts does each host report over a period?
      - Can I get the statistics for a single host by name?
      instructions:
      - text: Get {entity} counts per host from {_timeFrom} to {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
          entity: query.entity
      - text: Show {entity} statistics for host {hostName} between {_timeFrom} and {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
          entity: query.entity
          hostName: query.hostName
      method: generated
      generated: '2026-09-26'