ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DaaS IQ Scaling profiles API

7 actions 7 updates phrasing extends openapi/controlup-scaling-profiles-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 7

$.info
$.paths['/cloud/scaling-profiles'].get
$.paths['/cloud/scaling-profiles'].post
$.paths['/cloud/scaling-profiles/{id}'].get
$.paths['/cloud/scaling-profiles/{id}'].put
$.paths['/cloud/scaling-profiles/{id}'].delete
$.paths['/cloud/scaling-profiles/{id}/color'].patch

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 Scaling profiles API
  version: 1.0.0
extends: openapi/controlup-scaling-profiles-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: 6
- target: $.paths['/cloud/scaling-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List autoscale scaling profiles
      effect: read
      questions:
      - Which reusable autoscale profiles are defined in my organization?
      - Can I filter or sort my scaling profiles by name?
      instructions:
      - text: List all scaling profiles.
      - text: Find scaling profiles matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/scaling-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scaling profile
      effect: write
      questions:
      - How do I define a new autoscale configuration I can assign to host pool schedules?
      - Can I set the provisioning strategy and user experience settings for a new scaling profile?
      instructions:
      - text: Create scaling profile {name} in color {color} with strategy {strategy} and experience {experience}.
        slots:
          color: requestBody.color
          experience: requestBody.experience
          name: requestBody.name
          strategy: requestBody.strategy
      - text: Add a new scaling profile {name} described as {description}, color {color}, strategy {strategy}, experience {experience}.
        slots:
          color: requestBody.color
          description: requestBody.description
          experience: requestBody.experience
          name: requestBody.name
          strategy: requestBody.strategy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/scaling-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a scaling profile's configuration
      effect: read
      questions:
      - What thresholds and host count rules does a scaling profile use?
      - Can I read one scaling profile's full nested configuration?
      instructions:
      - text: Get scaling profile {id}.
        slots:
          id: path.id
      - text: Show the thresholds and host count rules in scaling profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/scaling-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a scaling profile's configuration
      effect: write
      questions:
      - How do I change the scaling strategy of an existing profile?
      - Can I rename a scaling profile and update its experience settings together?
      instructions:
      - text: 'Update scaling profile {id}: name {name}, color {color}, strategy {strategy}, experience {experience}.'
        slots:
          color: requestBody.color
          experience: requestBody.experience
          id: path.id
          name: requestBody.name
          strategy: requestBody.strategy
      - text: Replace the strategy on existing profile {id} with {strategy}, keeping name {name}, color {color}, experience {experience}.
        slots:
          color: requestBody.color
          experience: requestBody.experience
          id: path.id
          name: requestBody.name
          strategy: requestBody.strategy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/scaling-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scaling profile
      effect: destructive
      questions:
      - How do I remove a scaling profile I no longer use?
      - Why can't I delete a scaling profile that a schedule still uses?
      instructions:
      - text: Delete scaling profile {id}.
        slots:
          id: path.id
      - text: Remove unused scaling profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/scaling-profiles/{id}/color'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a scaling profile's display color
      effect: write
      questions:
      - Can I change just the color a scaling profile shows on the schedule?
      - How do I recolor a profile without touching its settings?
      instructions:
      - text: Set the color of scaling profile {id} to {color}.
        slots:
          color: requestBody.color
          id: path.id
      - text: Recolor profile {id} as {color}.
        slots:
          color: requestBody.color
          id: path.id
      method: generated
      generated: '2026-09-26'