ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for VDI & DaaS Configuration Machines API

5 actions 5 updates phrasing extends openapi/controlup-machines-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 5

$.info

$.paths['/v1/machines'].get

$.paths['/v1/machines'].post

$.paths['/v1/machines'].delete

$.paths['/v1/machines/{objectGuid}'].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 Configuration Machines API
  version: 1.0.0
extends: openapi/controlup-machines-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: 4
- target: $.paths['/v1/machines'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitored machines
      effect: read
      questions:
      - Which machines does ControlUp know about in a given folder or site?
      - Can I search machines by FQDN and include deleted ones?
      - Which machines are ready for outbound connections?
      instructions:
      - text: List all machines.
      - text: Search machines for {search}.
        slots:
          search: query.search
      - text: List machines in folder {folderPath} at site {site}.
        slots:
          folderPath: query.folderPath
          site: query.site
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/machines'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk create or update machines
      effect: write
      questions:
      - How do I add many machines at once, matched by computer and domain name?
      - Will re-sending a machine that already exists update it instead of duplicating it?
      instructions:
      - text: Create or update the machines in the list I give you.
      - text: Bulk upsert these computers by FQDN into the machine inventory.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/machines'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete machines by FQDN
      effect: destructive
      questions:
      - How do I remove several machines at once by their FQDNs?
      - Can I delete decommissioned machines in bulk?
      instructions:
      - text: Delete the machines with the FQDNs I list.
      - text: Bulk remove these decommissioned machines from inventory.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/machines/{objectGuid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a machine's details
      effect: read
      questions:
      - What are the full details of one machine?
      - Can I fetch only selected fields for a specific machine?
      instructions:
      - text: Get machine {objectGuid}.
        slots:
          objectGuid: path.objectGuid
      - text: Show fields {fields} for machine {objectGuid}.
        slots:
          fields: query.fields
          objectGuid: path.objectGuid
      method: generated
      generated: '2026-09-26'