ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DaaS IQ User sessions API

2 actions 2 updates phrasing extends openapi/controlup-user-sessions-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['/cloud/user-sessions/{userSessionId}/actions'].post

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 User sessions API
  version: 1.0.0
extends: openapi/controlup-user-sessions-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['/cloud/user-sessions/{userSessionId}/actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Message, sign out or disconnect a user session
      effect: destructive
      questions:
      - How do I send a warning message to a user before maintenance?
      - Can I sign out or disconnect a specific user's session remotely?
      instructions:
      - text: Run action {actionType} on user session {userSessionId}.
        slots:
          actionType: requestBody.actionType
          userSessionId: path.userSessionId
      - text: 'Send user session {userSessionId} the message {messageTitle}: {messageBody}.'
        slots:
          messageBody: requestBody.messageBody
          messageTitle: requestBody.messageTitle
          userSessionId: path.userSessionId
      - text: Sign out user session {userSessionId}.
        slots:
          userSessionId: path.userSessionId
      method: generated
      generated: '2026-09-26'