# 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 Chef Ingester API
  version: 1.0.0
extends: openapi/progress-software-chefingester-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: 6
- target: $.paths['/api/v0/ingest/events/chef/action'].post
  update:
    x-apievangelist-phrasing:
      intent: Ingest a Chef server action event
      effect: write
      questions:
      - How do I send a Chef server action, like a cookbook upload, into the event feed?
      - What fields does an ingested Chef action event carry, such as entity type and requestor?
      instructions:
      - text: Ingest a Chef action on {entity_type} {entity_name} by {requestor_name}.
        slots:
          entity_type: requestBody.entity_type
          entity_name: requestBody.entity_name
          requestor_name: requestBody.requestor_name
      - text: Record action task {task} for org {organization_name}.
        slots:
          task: requestBody.task
          organization_name: requestBody.organization_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/ingest/events/chef/liveness'].post
  update:
    x-apievangelist-phrasing:
      intent: Ingest a node liveness ping
      effect: write
      questions:
      - How does a node report that it's still alive when it isn't running a full converge?
      - Can I post a liveness ping for a node to keep it from looking missing?
      instructions:
      - text: Send a liveness ping for node {node_name} in org {organization_name}.
        slots:
          node_name: requestBody.node_name
          organization_name: requestBody.organization_name
      - text: Report node {entity_uuid} alive from Chef server {chef_server_fqdn}.
        slots:
          entity_uuid: requestBody.entity_uuid
          chef_server_fqdn: requestBody.chef_server_fqdn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/ingest/events/chef/node-multiple-deletes'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete several ingested nodes at once
      effect: destructive
      questions:
      - How do I remove a batch of nodes from the infrastructure data in one call?
      - Can I delete multiple nodes by passing a list of node IDs?
      instructions:
      - text: Delete the nodes {node_ids}.
        slots:
          node_ids: requestBody.node_ids
      - text: Remove this list of node IDs {node_ids} from ingested infra data.
        slots:
          node_ids: requestBody.node_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/ingest/events/chef/nodedelete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete one ingested node
      effect: destructive
      questions:
      - How do I delete a single node that's been decommissioned?
      - Can I remove a node by name within a Chef organization?
      instructions:
      - text: Delete node {node_name} from organization {organization_name}.
        slots:
          node_name: requestBody.node_name
          organization_name: requestBody.organization_name
      - text: Remove the single node {node_id}.
        slots:
          node_id: requestBody.node_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/ingest/events/chef/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Ingest a Chef client run report
      effect: write
      questions:
      - How do I submit a Chef client run report with its resources and status?
      - Can an ingested run include the run list, policy name and updated resource count?
      instructions:
      - text: Ingest a Chef run for node {node_name} with status {status}.
        slots:
          node_name: requestBody.node_name
          status: requestBody.status
      - text: Submit run {run_id} for node {node_name} using policy {policy_name}.
        slots:
          run_id: requestBody.run_id
          node_name: requestBody.node_name
          policy_name: requestBody.policy_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/ingest/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the ingest service version
      effect: read
      questions:
      - Which version of the ingest service is running?
      - Is the Chef event ingester up and what build is it?
      instructions:
      - text: Show the ingest service version.
      - text: Check which build of the event ingester is deployed.
      method: generated
      generated: '2026-10-01'