ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for VDI & DAAS Processes API

3 actions 3 updates phrasing extends openapi/controlup-processes-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/processes/usage/single'].get

$.paths['/v1/processes/usage/all'].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 Processes API
  version: 1.0.0
extends: openapi/controlup-processes-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/processes/usage/single'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage details for one process
      effect: read
      questions:
      - Which users and machines ran a particular application, and what was its peak concurrency?
      - How many unique users ran a specific process version last month?
      instructions:
      - text: Show usage for process {processName} from {_timeFrom} to {_timeTo}.
        slots:
          processName: query.processName
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      - text: Get usage of {processName} version {processVersion} on {computerNames} between {_timeFrom} and {_timeTo}.
        slots:
          processName: query.processName
          processVersion: query.processVersion
          computerNames: query.computerNames
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/processes/usage/all'].get
  update:
    x-apievangelist-phrasing:
      intent: Get daily usage across all processes
      effect: read
      questions:
      - What's the daily unique-user count across all processes?
      - Can I see peak concurrent users per day for every process over a period?
      instructions:
      - text: Show usage for all processes from {_timeFrom} to {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      - text: Get daily process usage for users {userAccounts} between {_timeFrom} and {_timeTo}.
        slots:
          userAccounts: query.userAccounts
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      method: generated
      generated: '2026-09-26'