ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DaaS IQ Session hosts API

3 actions 3 updates phrasing extends openapi/controlup-session-hosts-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['/cloud/session-hosts/{sessionHostId}/actions'].post

$.paths['/cloud/session-hosts/{sessionHostId}/user-sessions'].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 DaaS IQ Session hosts API
  version: 1.0.0
extends: openapi/controlup-session-hosts-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['/cloud/session-hosts/{sessionHostId}/actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Restart, stop, drain or remove a session host
      effect: destructive
      questions:
      - How do I put a session host into drain mode before maintenance?
      - Can I restart or stop a session host VM and track the job's progress?
      instructions:
      - text: Run action {actionType} on session host {sessionHostId}.
        slots:
          actionType: requestBody.actionType
          sessionHostId: path.sessionHostId
      - text: Put session host {sessionHostId} into drain mode.
        slots:
          sessionHostId: path.sessionHostId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/session-hosts/{sessionHostId}/user-sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List users logged in to a session host
      effect: read
      questions:
      - Who is logged in to a specific session host right now?
      - Are there disconnected sessions on a host I want to restart?
      instructions:
      - text: List the user sessions on session host {sessionHostId}.
        slots:
          sessionHostId: path.sessionHostId
      - text: Show who is connected to session host {sessionHostId}, sorted by {sort}.
        slots:
          sessionHostId: path.sessionHostId
          sort: query.sort
      method: generated
      generated: '2026-09-26'