# 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 Nodes Service API
  version: 1.0.0
extends: openapi/progress-software-nodesservice-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: 9
- target: $.paths['/api/v0/nodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a node to Chef Automate
      effect: write
      questions:
      - How do I register a single server as a node in Chef Automate?
      - Can I tag a node and assign it to projects when I create it?
      instructions:
      - text: Create a node named {name} with target config {target_config}.
        slots:
          name: requestBody.name
          target_config: requestBody.target_config
      - text: Add node {name} with tags {tags}.
        slots:
          name: requestBody.name
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodes/bulk-create'].post
  update:
    x-apievangelist-phrasing:
      intent: Add many nodes in one request
      effect: write
      questions:
      - Can I add a list of hosts as nodes all at once?
      - What do I need to send to bulk-create nodes from several hosts?
      instructions:
      - text: Bulk-create nodes {nodes}.
        slots:
          nodes: requestBody.nodes
      - text: 'Add these hosts as nodes in one batch: {nodes}.'
        slots:
          nodes: requestBody.nodes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodes/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete all nodes matching a filter
      effect: destructive
      questions:
      - How do I delete every node from a particular node manager?
      - Can I remove all nodes on a given platform in one call?
      instructions:
      - text: Delete all nodes matching filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Remove every node that matches {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodes/delete/ids'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete several nodes by ID
      effect: destructive
      questions:
      - Can I delete a specific list of nodes by their IDs?
      - What happens if some node IDs in a bulk delete are invalid?
      instructions:
      - text: Delete nodes with IDs {ids}.
        slots:
          ids: requestBody.ids
      - text: Bulk-remove the nodes {ids}.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodes/id/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a node's details
      effect: read
      questions:
      - What platform, status and last contact time does a node have?
      - Which manager and projects is a particular node attached to?
      instructions:
      - text: Show node {id}.
        slots:
          id: path.id
      - text: Get the full details of node {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodes/id/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a node's details
      effect: write
      questions:
      - How do I change a node's name or connection settings?
      - Does updating a node require me to resend every field?
      instructions:
      - text: Update node {id} with name {name} and target config {target_config}.
        slots:
          id: path.id
          name: requestBody.name
          target_config: requestBody.target_config
      - text: Overwrite the tags on node {id} with {tags}.
        slots:
          id: path.id
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodes/id/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single node
      effect: destructive
      questions:
      - How do I remove one node from Chef Automate?
      - Can I delete a node using just its ID?
      instructions:
      - text: Delete node {id}.
        slots:
          id: path.id
      - text: Remove the single node {id} from Automate.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodes/rerun/id/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Recheck whether a node is reachable
      effect: write
      questions:
      - How do I re-test whether a node is reachable?
      - Can I run a detect job to refresh a node's reachable status?
      instructions:
      - text: Run a detect job on node {id} to refresh its status.
        slots:
          id: path.id
      - text: Recheck reachability of node {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/nodes/search'].post
  update:
    x-apievangelist-phrasing:
      intent: List and filter nodes
      effect: read
      questions:
      - Which nodes are currently unreachable?
      - Can I list nodes filtered by platform or manager, a page at a time?
      instructions:
      - text: List all nodes.
      - text: List nodes matching {filters}, {per_page} per page.
        slots:
          filters: requestBody.filters
          per_page: requestBody.per_page
      method: generated
      generated: '2026-10-01'