# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cumulocity Audit Audit Records API
  version: 1.0.0
extends: openapi/cumulocity-audit-records-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: 3
- target: $.paths['/audit/auditRecords'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit log records
      effect: read
      questions:
      - Who changed what in my tenant last week?
      - Can I filter audit records by user or application?
      - What audit entries exist for one device?
      instructions:
      - text: List audit records by user {user} since {dateFrom}.
        slots:
          user: query.user
          dateFrom: query.dateFrom
      - text: Show audit records for device {source} of type {type}.
        slots:
          source: query.source
          type: query.type
      - text: List audit entries from application {application} between {dateFrom} and {dateTo}.
        slots:
          application: query.application
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audit/auditRecords'].post
  update:
    x-apievangelist-phrasing:
      intent: Write a custom audit log entry
      effect: write
      questions:
      - How do I write my own entry into the audit log?
      - Can an application record an audit entry for a change it made?
      instructions:
      - text: Create an audit record for activity {activity} with text {text}.
        slots:
          activity: requestBody.activity
          text: requestBody.text
      - text: Log a {severity} audit entry of type {type} for user {user}.
        slots:
          severity: requestBody.severity
          type: requestBody.type
          user: requestBody.user
      method: generated
      generated: '2026-10-01'
- target: $.paths['/audit/auditRecords/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one audit record
      effect: read
      questions:
      - How do I see the full details of one audit entry?
      - What changes did a specific audit record capture?
      instructions:
      - text: Show me audit record {id}.
        slots:
          id: path.id
      - text: Get the user, activity and changes of audit record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'