ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for VDI & DAAS Applications API

4 actions 4 updates phrasing extends openapi/controlup-applications-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 4

$.info

$.paths['/v1/applications/usage/single'].get

$.paths['/v1/applications/usage/all'].get

$.paths['/v1/applications/statistics'].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 Applications API
  version: 1.0.0
extends: openapi/controlup-applications-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: 3
- target: $.paths['/v1/applications/usage/single'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage details for one application
      effect: read
      questions:
      - Which machines and users ran a specific application, and what was its peak concurrency?
      - Can I see usage for just one version of an application?
      instructions:
      - text: Get usage of {appName} from {_timeFrom} to {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
          appName: query.appName
      - text: Show per-user and per-machine usage of {appName} version {appVersion} between {_timeFrom} and {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
          appName: query.appName
          appVersion: query.appVersion
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/usage/all'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage for all applications
      effect: read
      questions:
      - How many unique users and peak concurrent users did each application have?
      - Which applications were used most across the organization last month?
      instructions:
      - text: Get usage for all applications from {_timeFrom} to {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      - text: Rank every application by unique users between {_timeFrom} and {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/statistics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get weekly or monthly application resource statistics
      effect: read
      questions:
      - How much CPU and memory does each application version consume per week?
      - Can I limit application statistics to one folder?
      instructions:
      - text: Get {timeFrame} application statistics around {datetime}.
        slots:
          datetime: query.datetime
          timeFrame: query.timeFrame
      - text: Show {timeFrame} resource consumption per application version in folder {folderPath} around {datetime}.
        slots:
          datetime: query.datetime
          folderPath: query.folderPath
          timeFrame: query.timeFrame
      method: generated
      generated: '2026-09-26'