ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for VDI & DaaS Configuration Triggers API

3 actions 3 updates phrasing extends openapi/controlup-triggers-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/Triggers'].get
$.paths['/v1/Triggers/{triggerId}'].get

OpenAPI Overlay

Raw ↑ 
# 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 Configuration Triggers API
  version: 1.0.0
extends: openapi/controlup-triggers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v1/Triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: List the organization's triggers
      effect: read
      questions:
      - Which alert triggers are set up in my organization, and which are disabled?
      - Can I find the triggers that apply to a particular machine or folder?
      - Can I search triggers by name and filter them by type?
      instructions:
      - text: List all {enabled} triggers of type {type}.
        slots:
          enabled: query.enabled
          type: query.type
      - text: Show triggers that apply to machine {machine}.
        slots:
          machine: query.machine
      - text: Search triggers for {search}, sorted by {sort}.
        slots:
          search: query.search
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Triggers/{triggerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get full details of one trigger
      effect: read
      questions:
      - What actions, scope and schedule does a specific trigger have?
      - Can I fetch only some sections of a trigger, like its filter?
      instructions:
      - text: Get full details of trigger {triggerId}.
        slots:
          triggerId: path.triggerId
      - text: Show only the {include} sections of trigger {triggerId}.
        slots:
          include: query.include
          triggerId: path.triggerId
      method: generated
      generated: '2026-10-01'