ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DaaS IQ Host pool cost API

5 actions 5 updates phrasing extends openapi/controlup-host-pool-cost-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}/cost'].get
$.paths['/cloud/host-pools/{hostPoolId}/cost/savings'].get
$.paths['/cloud/host-pools/{hostPoolId}/session-hosts/cost'].get
$.paths['/cloud/host-pools/{hostPoolId}/cost/export'].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 cost API
  version: 1.0.0
extends: openapi/controlup-host-pool-cost-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}/cost'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a host pool's cost breakdown
      effect: read
      questions:
      - What did my host pool spend on compute, disk and network last month?
      - Can I see a day-by-day cost trend for a host pool?
      instructions:
      - text: Show the cost breakdown for host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      - text: Get host pool {hostPoolId} cost from {startDate} to {endDate} at {granularity} granularity.
        slots:
          hostPoolId: path.hostPoolId
          startDate: query.startDate
          endDate: query.endDate
          granularity: query.granularity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}/cost/savings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get autoscale savings for a host pool
      effect: read
      questions:
      - How much has autoscale saved compared with running the pool always-on?
      - What percentage did autoscaling cut from my host pool bill?
      instructions:
      - text: Show autoscale savings for host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      - text: Get host pool {hostPoolId} savings between {startDate} and {endDate}.
        slots:
          hostPoolId: path.hostPoolId
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}/session-hosts/cost'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cost per session host
      effect: read
      questions:
      - Which session hosts in my pool cost the most?
      - Are any hosts flagged for Premium SSD optimization?
      instructions:
      - text: Show per-host costs for host pool {hostPoolId}.
        slots:
          hostPoolId: path.hostPoolId
      - text: Rank session hosts in pool {hostPoolId} by cost, sorted {sort}.
        slots:
          hostPoolId: path.hostPoolId
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/host-pools/{hostPoolId}/cost/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export host pool cost as CSV
      effect: read
      questions:
      - Can I download per-host daily cost records as a CSV?
      - Does the cost export include hosts that were deleted?
      instructions:
      - text: Export cost data for host pool {hostPoolId} as CSV.
        slots:
          hostPoolId: path.hostPoolId
      - text: Download the daily cost CSV for pool {hostPoolId} from {startDate} to {endDate}.
        slots:
          hostPoolId: path.hostPoolId
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'