API Evangelist conversational phrasing for Chef Automate API Documentation Datafeed 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 Datafeed Service API
  version: 1.0.0
extends: openapi/progress-software-datafeedservice-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: 8
- target: $.paths['/api/v0/datafeed/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the global data feed configuration
      effect: read
      questions:
      - What are the global data feed settings in Chef Automate?
      - How is the data feed configured overall, before any destination?
      instructions:
      - text: Show the global data feed configuration.
      - text: Get the data feed's system-wide settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/datafeed/destination'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a data feed destination
      effect: write
      questions:
      - How do I send Automate node and compliance data to an external webhook URL?
      - Can I choose which services and integration types a new data feed destination receives?
      instructions:
      - text: Add data feed destination {name} sending to {url} with secret {secret}.
        slots:
          name: requestBody.name
          url: requestBody.url
          secret: requestBody.secret
      - text: Create a destination {name} at {url} for services {services}.
        slots:
          name: requestBody.name
          url: requestBody.url
          services: requestBody.services
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/datafeed/destination/enable/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Turn a data feed destination on or off
      effect: write
      questions:
      - How do I pause a data feed destination without deleting it?
      - Can I re-enable a destination I disabled earlier?
      instructions:
      - text: Set enabled to {enable} for data feed destination {id}.
        slots:
          enable: requestBody.enable
          id: path.id
      - text: Disable destination {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/datafeed/destination/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one data feed destination
      effect: read
      questions:
      - Where is a specific data feed destination sending data?
      - Can I see one destination's URL and enabled state?
      instructions:
      - text: Get data feed destination {id}.
        slots:
          id: path.id
      - text: Show the settings of destination {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/datafeed/destination/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data feed destination
      effect: destructive
      questions:
      - How do I remove a data feed destination entirely?
      - Can I delete a destination that points at a retired endpoint?
      instructions:
      - text: Delete data feed destination {id}.
        slots:
          id: path.id
      - text: Remove destination {id} so no more data is sent there.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/datafeed/destination/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a data feed destination
      effect: write
      questions:
      - How do I point an existing data feed destination at a new URL?
      - Can I change a destination's credentials secret after creating it?
      instructions:
      - text: Change the URL of destination {id} to {url}.
        slots:
          id: path.id
          url: requestBody.url
      - text: Update destination {id} to use secret {secret} and name {name}.
        slots:
          id: path.id
          secret: requestBody.secret
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/datafeed/destinations'].post
  update:
    x-apievangelist-phrasing:
      intent: List all data feed destinations
      effect: read
      questions:
      - Which data feed destinations are configured?
      - Where is Automate currently forwarding its data?
      instructions:
      - text: List all data feed destinations.
      - text: Show me every endpoint the data feed sends to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/datafeed/destinations/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test connectivity to a data feed destination
      effect: read
      questions:
      - Can I check that a webhook URL accepts data before adding it as a destination?
      - Does the test call support username/password, header and AWS credentials?
      instructions:
      - text: Test the data feed connection to {url} using secret {secret_id}.
        slots:
          url: requestBody.url
          secret_id: requestBody.secret_id
      - text: Send a test to {url} with username and password {username_password}.
        slots:
          url: requestBody.url
          username_password: requestBody.username_password
      method: generated
      generated: '2026-10-01'