# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cumulocity Inventory Managed Objects API
  version: 1.0.0
extends: openapi/cumulocity-managed-objects-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: 5
- target: $.paths['/inventory/managedObjects'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the device and asset inventory
      effect: read
      questions:
      - How do I list all devices in my Cumulocity inventory?
      - Can I search the inventory by text or by fragment type?
      - Which managed objects belong to a particular owner?
      instructions:
      - text: List inventory objects of type {type}.
        slots:
          type: query.type
      - text: Search the inventory for {text}, {pageSize} per page.
        slots:
          text: query.text
          pageSize: query.pageSize
      - text: List managed objects with fragment {fragmentType} owned by {owner}.
        slots:
          fragmentType: query.fragmentType
          owner: query.owner
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inventory/managedObjects'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a device or asset in the inventory
      effect: write
      questions:
      - How do I register a new device in the inventory?
      - Can I create a device group as a managed object?
      instructions:
      - text: Create a managed object named {name} of type {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      - text: Register a new device called {name} with hardware info {c8y_Hardware}.
        slots:
          name: requestBody.name
          c8y_Hardware: requestBody.c8y_Hardware
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inventory/managedObjects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one device or asset
      effect: read
      questions:
      - How do I fetch one device's inventory record by ID?
      - Can I include a device's parents and children when I look it up?
      instructions:
      - text: Show me managed object {id}.
        slots:
          id: path.id
      - text: Get managed object {id} including its children and parents.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inventory/managedObjects/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a device or asset record
      effect: write
      questions:
      - How do I rename a device in the inventory?
      - Can I update the firmware info stored on a device record?
      instructions:
      - text: Rename managed object {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the firmware fragment of device {id} to {c8y_Firmware}.
        slots:
          id: path.id
          c8y_Firmware: requestBody.c8y_Firmware
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inventory/managedObjects/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device or asset
      effect: destructive
      questions:
      - How do I remove a device from the inventory?
      - Can I delete a device together with all its child devices?
      instructions:
      - text: Delete managed object {id}.
        slots:
          id: path.id
      - text: Delete device {id} and cascade to its children.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'