ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DaaS IQ Host pool VM settings API

5 actions 5 updates phrasing extends openapi/controlup-host-pool-vm-settings-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['/cloud/host-pools/{hostPoolId}/vm-settings'].get
$.paths['/cloud/host-pools/{hostPoolId}/vm-settings'].put
$.paths['/cloud/host-pools/{hostPoolId}/vm-settings'].delete
$.paths['/cloud/host-pools/{hostPoolId}/vm-settings/validation'].post

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 DaaS IQ Host pool VM settings API
  version: 1.0.0
extends: openapi/controlup-host-pool-vm-settings-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['/cloud/host-pools/{hostPoolId}/vm-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a host pool's VM template
      effect: read
      questions:
      - What VM size and image will new session hosts in my pool use?
      - Which region and resource group does a host pool deploy new VMs into?
      instructions:
      - text: Show the VM settings for host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      - text: Get the new-host template of pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}/vm-settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Save a host pool's VM template
      effect: write
      questions:
      - Can I set the VM size, image and network that future session hosts are built from?
      - Does saving VM settings replace fields I leave out?
      instructions:
      - text: Save VM settings for host pool {hostPoolId} with primary size {primaryVmSize} in {deploymentRegion}.
        slots:
          hostPoolId: path.hostPoolId
          primaryVmSize: requestBody.primaryVmSize
          deploymentRegion: requestBody.deploymentRegion
      - text: Replace pool {hostPoolId}'s VM template using naming prefix {vmNamingPrefix} and subnet {subnetResourceId}.
        slots:
          hostPoolId: path.hostPoolId
          vmNamingPrefix: requestBody.vmNamingPrefix
          subnetResourceId: requestBody.subnetResourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}/vm-settings'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a host pool's VM template
      effect: destructive
      questions:
      - Can I discard the stored VM template for a host pool?
      - Will deleting VM settings affect my existing session hosts?
      instructions:
      - text: Delete the VM settings of host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      - text: Discard the new-host template for pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}/vm-settings/validation'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate VM settings without saving
      effect: read
      questions:
      - Can I check a VM settings payload for errors before committing it?
      - Is there a dry run that resolves lookup details for my VM template?
      instructions:
      - text: Validate VM settings for host pool {hostPoolId} without saving.
        slots:
          hostPoolId: path.hostPoolId
      - text: Test whether VM size {primaryVmSize} in {deploymentRegion} is valid for pool {hostPoolId}.
        slots:
          primaryVmSize: requestBody.primaryVmSize
          deploymentRegion: requestBody.deploymentRegion
          hostPoolId: path.hostPoolId
      method: generated
      generated: '2026-09-26'