ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for VDI & DAAS User API

2 actions 2 updates phrasing extends openapi/controlup-user-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 2

$.info

$.paths['/v1/users/activity'].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 User API
  version: 1.0.0
extends: openapi/controlup-user-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: 1
- target: $.paths['/v1/users/activity'].get
  update:
    x-apievangelist-phrasing:
      intent: Get user activity status over time
      effect: read
      questions:
      - Was a given user active or idle during each five-minute window yesterday?
      - Can I see activity status for all users over a period?
      instructions:
      - text: Show user activity at {granularity} granularity from {_timeFrom} to {_timeTo}.
        slots:
          granularity: query.granularity
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      - text: Get activity for user {userAccount} in {granularity} windows between {_timeFrom} and {_timeTo}.
        slots:
          userAccount: query.userAccount
          granularity: query.granularity
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      method: generated
      generated: '2026-09-26'