# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for dotCMS REST Cluster Management API
  version: 1.0.0
extends: openapi/dotcms-cluster-management-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: 5
- target: $.paths['/api/cluster/getESConfigProperties/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the cluster's Elasticsearch config properties
      effect: read
      questions:
      - What Elasticsearch configuration properties is the cluster running with?
      - How can I inspect ES settings for a cluster node?
      instructions:
      - text: Show the Elasticsearch config properties for {params}.
        slots:
          params: path.params
      - text: Get the cluster's ES settings using {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cluster/licenseRepoStatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the license repository status
      effect: read
      questions:
      - What is the current status of the cluster's license repository?
      - Is the cluster license pool healthy?
      instructions:
      - text: Check the license repository status with {params}.
        slots:
          params: path.params
      - text: Show license pool usage across the cluster for {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cluster/getNodesStatus/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status of every cluster node
      effect: read
      questions:
      - Which nodes are in my dotCMS cluster and are they healthy?
      - How do I get a status report for each server node in the cluster?
      instructions:
      - text: Show the status of all cluster nodes for {params}.
        slots:
          params: path.params
      - text: Report node health across the cluster using {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cluster/remove/{params}'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a node from the cluster
      effect: destructive
      questions:
      - How do I take a dead server out of the cluster?
      - Can I remove a node from the cluster remotely?
      instructions:
      - text: Remove the node identified by {params} from the cluster.
        slots:
          params: path.params
      - text: Drop server {params} out of cluster membership.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cluster/test'].get
  update:
    x-apievangelist-phrasing:
      intent: Test cluster communication
      effect: read
      questions:
      - Are the cluster nodes able to talk to each other?
      - How do I run a quick cluster connectivity test?
      instructions:
      - text: Run the cluster connectivity test.
      - text: Check that cluster messaging works.
      method: generated
      generated: '2026-09-26'