API Evangelist conversational phrasing for Chef Automate API Documentation Node Manager Service API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Chef Automate API Documentation Node Manager Service API
  version: 1.0.0
extends: openapi/progress-software-nodemanagerservice-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: 11
- target: $.paths['/api/v0/nodemanagers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a node manager
      effect: write
      questions:
      - How do I connect a cloud account to Chef Automate as a node manager?
      - Can I create a node manager with an existing credential ID instead of raw credential data?
      instructions:
      - text: Create a {type} node manager named {name} using credential {credential_id}.
        slots:
          type: requestBody.type
          name: requestBody.name
          credential_id: requestBody.credential_id
      - text: Add a node manager of type {type} with credential data {credential_data}.
        slots:
          type: requestBody.type
          credential_data: requestBody.credential_data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodemanagers/id/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a node manager's details
      effect: read
      questions:
      - What type and status does a given node manager have?
      - Which credential is a particular node manager using?
      instructions:
      - text: Show node manager {id}.
        slots:
          id: path.id
      - text: Get the details and status of node manager {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodemanagers/id/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a node manager's settings
      effect: write
      questions:
      - How do I rotate the credential a node manager uses?
      - Does updating a node manager overwrite fields I leave out?
      instructions:
      - text: Update node manager {id} to use credential {credential_id}.
        slots:
          id: path.id
          credential_id: requestBody.credential_id
      - text: Rename node manager {id} to {name}, resending its full settings.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodemanagers/id/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a node manager and keep its nodes
      effect: destructive
      questions:
      - What happens to nodes when I delete their node manager?
      - Can I remove a node manager but hand its nodes back to the Automate manager?
      instructions:
      - text: Delete node manager {id} and reassign its nodes to the Automate manager.
        slots:
          id: path.id
      - text: Remove only the node manager {id}, keeping its nodes.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodemanagers/id/{id}/with-node-state/stopped'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a node manager and mark its nodes stopped
      effect: destructive
      questions:
      - Can I delete a node manager and set all its nodes to stopped?
      - Is there a way to retire a node manager while keeping nodes as stopped records?
      instructions:
      - text: Delete node manager {id} and mark its nodes as stopped.
        slots:
          id: path.id
      - text: Remove manager {id} and set every associated node to stopped.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodemanagers/id/{id}/with-node-state/terminated'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a node manager and mark its nodes terminated
      effect: destructive
      questions:
      - Can I delete a node manager and flag all its nodes as terminated?
      - How do I remove a decommissioned cloud account and record its nodes as terminated?
      instructions:
      - text: Delete node manager {id} and mark its nodes as terminated.
        slots:
          id: path.id
      - text: Remove manager {id} and set every associated node to terminated.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodemanagers/id/{id}/with-nodes'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a node manager and all of its nodes
      effect: destructive
      questions:
      - How do I delete a node manager together with every node it manages?
      - Can I wipe a node manager's nodes from Automate entirely when removing it?
      instructions:
      - text: Delete node manager {id} and all of its nodes.
        slots:
          id: path.id
      - text: Remove manager {id} along with every node it owns.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodemanagers/id/{node_manager_id}/search-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up field values across a node manager's nodes
      effect: read
      questions:
      - What distinct values does a field like region take across a node manager's nodes?
      - Can I autocomplete a node field value for one node manager?
      instructions:
      - text: List the values of field {field} across nodes of node manager {node_manager_id}.
        slots:
          field: requestBody.field
          node_manager_id: path.node_manager_id
      - text: Search field {field} values matching {query} for manager {node_manager_id}.
        slots:
          field: requestBody.field
          query: requestBody.query
          node_manager_id: path.node_manager_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodemanagers/id/{node_manager_id}/search-nodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the nodes under one node manager
      effect: read
      questions:
      - Which nodes does a given node manager know about?
      - Can I query the nodes for one cloud account node manager?
      instructions:
      - text: Search the nodes of node manager {node_manager_id}.
        slots:
          node_manager_id: path.node_manager_id
      - text: Find nodes under manager {node_manager_id} matching {query}.
        slots:
          node_manager_id: path.node_manager_id
          query: requestBody.query
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodemanagers/rerun/id/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a node manager's credentials
      effect: read
      questions:
      - How can I check that a node manager's credentials still work?
      - Is there a way to re-validate the connection to a node manager's API?
      instructions:
      - text: Test the connection for node manager {id}.
        slots:
          id: path.id
      - text: Re-validate the credentials of node manager {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodemanagers/search'].post
  update:
    x-apievangelist-phrasing:
      intent: List node managers
      effect: read
      questions:
      - Which node managers are configured in Chef Automate?
      - Can I filter node managers by manager type?
      instructions:
      - text: List all node managers.
      - text: List node managers filtered by {filter_map}, sorted by {sort}.
        slots:
          filter_map: requestBody.filter_map
          sort: requestBody.sort
      method: generated
      generated: '2026-10-01'