Cumulocity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cumulocity Digital Twin Manager Asset Models API

6 actions 6 updates phrasing extends openapi/cumulocity-asset-models-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 6

$.info
$.paths['/service/dtm/asset-models'].get
$.paths['/service/dtm/asset-models'].post
$.paths['/service/dtm/asset-models/{id}'].get
$.paths['/service/dtm/asset-models/{id}'].put
$.paths['/service/dtm/asset-models/{id}'].delete

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 Digital Twin Manager Asset Models API
  version: 1.0.0
extends: openapi/cumulocity-asset-models-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['/service/dtm/asset-models'].get
  update:
    x-apievangelist-phrasing:
      intent: List digital twin asset models
      effect: read
      questions:
      - What asset models are defined in my digital twin manager?
      - Which asset types can I build instances from?
      instructions:
      - text: List all asset models.
      - text: Show every asset model definition.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/dtm/asset-models'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new asset model
      effect: write
      questions:
      - How do I define a new asset type with its own properties?
      - Can I restrict which subtypes are allowed under a new asset model?
      instructions:
      - text: Create an asset model named {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: Define asset model {name} allowing subtypes {allowedSubtypes}.
        slots:
          name: requestBody.name
          allowedSubtypes: requestBody.allowedSubtypes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/dtm/asset-models/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one asset model
      effect: read
      questions:
      - How do I see the property definitions of one asset model?
      - Which subtypes and smart functions does a given asset model have?
      instructions:
      - text: Show me asset model {id}.
        slots:
          id: path.id
      - text: Get the properties and allowed subtypes of asset model {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/dtm/asset-models/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an asset model definition
      effect: write
      questions:
      - Can I add properties to an asset model that already exists?
      - How do I rename or re-describe an asset model?
      instructions:
      - text: Rename asset model {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the properties of asset model {id} to {properties}.
        slots:
          id: path.id
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/service/dtm/asset-models/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an asset model
      effect: destructive
      questions:
      - How do I remove an asset model I no longer need?
      - Can I delete an asset type definition?
      instructions:
      - text: Delete asset model {id}.
        slots:
          id: path.id
      - text: Remove the asset model with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'