ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for VDI & DaaS Configuration Trigger Schedules API

3 actions 3 updates phrasing extends openapi/controlup-triggerschedules-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/trigger-schedules'].get
$.paths['/v1/trigger-schedules/{scheduleId}'].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 Trigger Schedules API
  version: 1.0.0
extends: openapi/controlup-triggerschedules-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/trigger-schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List trigger schedules
      effect: read
      questions:
      - Which schedules are available for my triggers?
      - Can I filter trigger schedules by name or source?
      instructions:
      - text: List all trigger schedules.
      - text: Find trigger schedules named {name} from source {source}.
        slots:
          name: query.name
          source: query.source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/trigger-schedules/{scheduleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one trigger schedule and its usage
      effect: read
      questions:
      - What does a specific trigger schedule contain, and which triggers use it?
      - Can I look up a built-in schedule by its name?
      instructions:
      - text: Get trigger schedule {scheduleId}.
        slots:
          scheduleId: path.scheduleId
      - text: Show trigger schedule {scheduleId} with up to {usageLimit} usage entries.
        slots:
          scheduleId: path.scheduleId
          usageLimit: query.usageLimit
      method: generated
      generated: '2026-10-01'