ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DaaS IQ Host pool scaling policies API

5 actions 5 updates phrasing extends openapi/controlup-host-pool-scaling-policies-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}/scaling-policy'].get
$.paths['/cloud/host-pools/{hostPoolId}/scaling-policy'].put
$.paths['/cloud/host-pools/{hostPoolId}/scaling-policy'].delete
$.paths['/cloud/host-pools/{hostPoolId}/scaling-policy/active-profile'].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 DaaS IQ Host pool scaling policies API
  version: 1.0.0
extends: openapi/controlup-host-pool-scaling-policies-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}/scaling-policy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a host pool's weekly autoscale schedule
      effect: read
      questions:
      - Which scaling profile is assigned to each time block in a host pool's week?
      - What does the autoscale schedule for a host pool look like?
      instructions:
      - text: Get the scaling policy for host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      - text: Show the weekly schedule of profile assignments for host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}/scaling-policy'].put
  update:
    x-apievangelist-phrasing:
      intent: Save a host pool's autoscale schedule
      effect: write
      questions:
      - How do I set up an autoscale schedule with time blocks for a host pool?
      - Can I set an off-hours default profile and scale-in restriction windows?
      instructions:
      - text: Save a scaling policy for host pool {hostPoolId} in time zone {timeZoneId} with schedules {schedules}.
        slots:
          hostPoolId: path.hostPoolId
          schedules: requestBody.schedules
          timeZoneId: requestBody.timeZoneId
      - text: Set host pool {hostPoolId} off-hours profile to {defaultScalingProfileId}, time zone {timeZoneId}, schedules {schedules}.
        slots:
          defaultScalingProfileId: requestBody.defaultScalingProfileId
          hostPoolId: path.hostPoolId
          schedules: requestBody.schedules
          timeZoneId: requestBody.timeZoneId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}/scaling-policy'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a host pool's autoscale schedule
      effect: destructive
      questions:
      - How do I turn off autoscaling on a host pool by removing its policy?
      - Can I delete the scaling schedule for one host pool?
      instructions:
      - text: Delete the scaling policy from host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      - text: Remove autoscaling from host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}/scaling-policy/active-profile'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the scaling profile in effect right now
      effect: read
      questions:
      - Which scaling profile is active on a host pool at this moment?
      - What autoscale settings apply to a host pool right now?
      instructions:
      - text: Get the active scaling profile for host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      - text: Tell me which profile host pool {hostPoolId} is using now.
        slots:
          hostPoolId: path.hostPoolId
      method: generated
      generated: '2026-09-26'