Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Inventory Child References API

5 actions 5 updates phrasing extends openapi/cumulocity-child-references-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Cumulocity's API. It is a proposal applied on top of the contract, not a document Cumulocity publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/inventory/managedObjects/{id}/childDevices'].get
$.paths['/inventory/managedObjects/{id}/childDevices'].post
$.paths['/inventory/managedObjects/{id}/childAssets'].get
$.paths['/inventory/managedObjects/{id}/childAdditions'].get

OpenAPI Overlay

Raw ↑
# 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 Child References API
  version: 1.0.0
extends: openapi/cumulocity-child-references-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: 4
- target: $.paths['/inventory/managedObjects/{id}/childDevices'].get
  update:
    x-apievangelist-phrasing:
      intent: List a device's child devices
      effect: read
      questions:
      - Which child devices are connected under a gateway?
      - How do I see the devices that belong to a device group?
      instructions:
      - text: List the child devices of {id}.
        slots:
          id: path.id
      - text: Show devices attached under gateway {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inventory/managedObjects/{id}/childDevices'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a child device to a parent
      effect: write
      questions:
      - How do I put a device under a gateway or group?
      - Can I link an existing device as a child of another?
      instructions:
      - text: Add device {managedObject} as a child of {id}.
        slots:
          managedObject: requestBody.managedObject
          id: path.id
      - text: Attach child device {managedObject} to gateway {id}.
        slots:
          managedObject: requestBody.managedObject
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inventory/managedObjects/{id}/childAssets'].get
  update:
    x-apievangelist-phrasing:
      intent: List a managed object's child assets
      effect: read
      questions:
      - What assets sit under a particular asset or group in the hierarchy?
      - How do I list the child assets of a building or site?
      instructions:
      - text: List the child assets of {id}.
        slots:
          id: path.id
      - text: Show the asset hierarchy one level below {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/inventory/managedObjects/{id}/childAdditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a managed object's child additions
      effect: read
      questions:
      - What child additions are attached to a managed object?
      - How do I see the extra objects added beneath a device?
      instructions:
      - text: List the child additions of {id}.
        slots:
          id: path.id
      - text: Show additions attached to managed object {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'