# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cumulocity Device Bootstrap New Device Requests API
  version: 1.0.0
extends: openapi/cumulocity-new-device-requests-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['/devicecontrol/newDeviceRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending device registrations
      effect: read
      questions:
      - Which devices are waiting for registration approval?
      - What new device requests are pending in my tenant?
      instructions:
      - text: List all new device requests.
      - text: Show devices waiting to be registered.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devicecontrol/newDeviceRequests'].post
  update:
    x-apievangelist-phrasing:
      intent: Start registering a new device
      effect: write
      questions:
      - How do I start registering a device by its serial ID?
      - Can I pre-register a device before it connects for the first time?
      instructions:
      - text: Create a new device request for device ID {id}.
        slots:
          id: requestBody.id
      - text: Register device {id} so it can request credentials.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devicecontrol/newDeviceRequests/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one device registration request
      effect: read
      questions:
      - What is the status of a particular device registration request?
      - Has a device I registered connected and asked for credentials yet?
      instructions:
      - text: Show the registration request for device {id}.
        slots:
          id: path.id
      - text: Check the status of new device request {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devicecontrol/newDeviceRequests/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Accept or reject a device registration
      effect: write
      questions:
      - How do I accept a device that's waiting to be registered?
      - Can I reject a device registration request?
      instructions:
      - text: Accept the registration request for device {id}.
        slots:
          id: path.id
      - text: Set new device request {id} to status {status}.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devicecontrol/newDeviceRequests/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a device registration request
      effect: destructive
      questions:
      - How do I cancel a device registration I started?
      - Can I delete a stale new device request?
      instructions:
      - text: Delete the new device request {id}.
        slots:
          id: path.id
      - text: Cancel the registration of device {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'