# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cohesity REST Clusters API
  version: 1.0.0
extends: openapi/cohesity-clusters-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 18
- target: $.paths['/public/cluster/backgroundActivitySchedule'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the background activity throttling schedule
      effect: read
      questions:
      - When does the cluster throttle background tasks like garbage collection?
      - What Apollo throttling windows are set on my cluster right now?
      instructions:
      - text: Show the cluster's background activity throttling schedule.
      - text: Get the current Apollo throttling settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/cluster/backgroundActivitySchedule'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the background activity throttling schedule
      effect: write
      questions:
      - Can I move background maintenance work to off-hours so it doesn't slow backups?
      - How do I change when Apollo throttling kicks in?
      instructions:
      - text: Update the cluster's background activity throttling schedule.
      - text: Change the Apollo throttling windows to run only overnight.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/cluster/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List the cluster's public keys
      effect: read
      questions:
      - Where can I find the public keys my cluster uses?
      - Does the cluster expose its public keys for configuring trust?
      instructions:
      - text: List the cluster's public keys.
      - text: Show me the public keys for this cluster.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/clusters'].delete
  update:
    x-apievangelist-phrasing:
      intent: Destroy a Cohesity cluster
      effect: destructive
      questions:
      - Is it possible to completely tear down a cluster and wipe its nodes?
      - What does destroying a cluster report back about each node?
      instructions:
      - text: Destroy this Cohesity cluster.
      - text: Tear down the cluster and report the status of each node.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/clusters/cloudEdition'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Cloud Edition cluster
      effect: write
      questions:
      - How do I stand up a new Cloud Edition cluster on cloud VMs?
      - Can I enable encryption and set metadata fault tolerance when creating a Cloud Edition cluster?
      instructions:
      - text: Create a Cloud Edition cluster named {clusterName} on nodes {nodeIps}.
        slots:
          clusterName: requestBody.clusterName
          nodeIps: requestBody.nodeIps
      - text: Create Cloud Edition cluster {clusterName} with network config {networkConfig} and nodes {nodeIps}.
        slots:
          clusterName: requestBody.clusterName
          networkConfig: requestBody.networkConfig
          nodeIps: requestBody.nodeIps
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/clusters/cloudEdition/nodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add nodes to a Cloud Edition cluster
      effect: write
      questions:
      - Can I grow an existing Cloud Edition cluster by adding more cloud nodes?
      - What do I need to supply to expand a Cloud Edition cluster?
      instructions:
      - text: Expand the Cloud Edition cluster with nodes at {nodeIps}.
        slots:
          nodeIps: requestBody.nodeIps
      - text: Add cloud nodes {nodeIps} to my Cloud Edition cluster.
        slots:
          nodeIps: requestBody.nodeIps
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/clusters/creationProgress'].get
  update:
    x-apievangelist-phrasing:
      intent: Check cluster creation progress
      effect: read
      questions:
      - How far along is my new cluster's creation, and how long is left?
      - What percentage complete is the cluster setup?
      instructions:
      - text: Check the progress of the cluster that's being created.
      - text: Show the estimated time remaining for cluster creation.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/clusters/ioPreferentialTier'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the IO preferential storage tiers
      effect: read
      questions:
      - Which storage tiers does the cluster prefer for random versus sequential IO?
      - What are the current IO preferential tier settings?
      instructions:
      - text: Show the cluster's IO preferential tiers.
      - text: Get the preferred storage tiers for each IO workload.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/clusters/ioPreferentialTier'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the IO preferential storage tiers
      effect: write
      questions:
      - Can I make random IO prefer SSD over HDD on the cluster?
      - How do I set down-tier usage thresholds for each storage tier?
      instructions:
      - text: Set the random IO preferred tiers to {randomIOPreferentialTier}.
        slots:
          randomIOPreferentialTier: requestBody.randomIOPreferentialTier
      - text: Set the sequential IO preferred tier to {sequentialIOPreferentialTier}.
        slots:
          sequentialIOPreferentialTier: requestBody.sequentialIOPreferentialTier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/clusters/nodes/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a node from the cluster
      effect: destructive
      questions:
      - How do I decommission one node from my cluster?
      - Can I take a failing node out of the cluster?
      instructions:
      - text: Remove node {id} from the cluster.
        slots:
          id: path.id
      - text: Decommission cluster node {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/clusters/physicalEdition'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Physical Edition cluster
      effect: write
      questions:
      - How do I create a new cluster on physical appliances, including IPMI setup?
      - Can I allow the cluster to be destroyed later with an HMAC-validated OTP when I create it?
      instructions:
      - text: Create a Physical Edition cluster named {clusterName} from nodes {nodeConfigs}.
        slots:
          clusterName: requestBody.clusterName
          nodeConfigs: requestBody.nodeConfigs
      - text: Create physical cluster {clusterName} with IPMI config {ipmiConfig} and network config {networkConfig}.
        slots:
          clusterName: requestBody.clusterName
          ipmiConfig: requestBody.ipmiConfig
          networkConfig: requestBody.networkConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/clusters/physicalEdition/nodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add nodes to a Physical Edition cluster
      effect: write
      questions:
      - Can I add new physical nodes and virtual IPs to an existing appliance cluster?
      - How do I map chassis serials to racks when expanding a physical cluster?
      instructions:
      - text: Expand the physical cluster with nodes {nodeConfigs}.
        slots:
          nodeConfigs: requestBody.nodeConfigs
      - text: Add physical nodes {nodeConfigs} and virtual IPs {vips} to the cluster.
        slots:
          nodeConfigs: requestBody.nodeConfigs
          vips: requestBody.vips
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/clusters/services/states'].get
  update:
    x-apievangelist-phrasing:
      intent: List service states on the cluster
      effect: read
      questions:
      - Which cluster services are running and which are stopped?
      - Is every service on my cluster healthy and up?
      instructions:
      - text: List the states of all services on the cluster.
      - text: Show me which cluster services are stopped.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/clusters/services/states'].post
  update:
    x-apievangelist-phrasing:
      intent: Start, stop or restart cluster services
      effect: write
      questions:
      - Can I restart a single service on the cluster without rebooting nodes?
      - What happens if I stop services without naming any?
      instructions:
      - text: Restart cluster services {services}.
        slots:
          services: requestBody.services
      - text: Apply action {action} to services {services}.
        slots:
          action: requestBody.action
          services: requestBody.services
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/clusters/software'].put
  update:
    x-apievangelist-phrasing:
      intent: Upgrade the cluster software
      effect: write
      questions:
      - How do I upgrade my cluster to a newer software version?
      - Do I need to upload a package first before upgrading the cluster?
      instructions:
      - text: Upgrade the cluster to software version {targetSwVersion}.
        slots:
          targetSwVersion: requestBody.targetSwVersion
      - text: Start a cluster software upgrade to {targetSwVersion}.
        slots:
          targetSwVersion: requestBody.targetSwVersion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/clusters/virtualEdition'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Virtual Edition cluster
      effect: write
      questions:
      - How do I create a Virtual Edition cluster on hypervisor VMs?
      - Can I configure encryption when setting up a Virtual Edition cluster?
      instructions:
      - text: Create a Virtual Edition cluster named {clusterName} with nodes {nodeConfigs}.
        slots:
          clusterName: requestBody.clusterName
          nodeConfigs: requestBody.nodeConfigs
      - text: Create virtual cluster {clusterName} using network config {networkConfig}.
        slots:
          clusterName: requestBody.clusterName
          networkConfig: requestBody.networkConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/externalClientSubnets'].get
  update:
    x-apievangelist-phrasing:
      intent: List external client subnets
      effect: read
      questions:
      - Which external client subnets are allowed to reach the cluster?
      - What client subnets are configured on this cluster?
      instructions:
      - text: List the cluster's external client subnets.
      - text: Show the configured client subnets.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/externalClientSubnets'].put
  update:
    x-apievangelist-phrasing:
      intent: Update external client subnets
      effect: write
      questions:
      - Can I add a new client subnet so another network can access the cluster?
      - How do I change the external client subnets list?
      instructions:
      - text: Set the cluster's external client subnets to {clientSubnets}.
        slots:
          clientSubnets: requestBody.clientSubnets
      - text: Update the external client subnets on the cluster.
      method: generated
      generated: '2026-10-01'