# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Audits API
  version: 1.0.0
extends: openapi/optimizely-audits-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/api/v1/admin/Audits'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin audit log entries
      effect: read
      questions:
      - What actions have admins taken in Optimizely Commerce recently?
      - Can I filter the audit log by user name or IP address?
      instructions:
      - text: List all audit log entries.
      - text: Show audit entries matching {filter}, newest first by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Audits'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an audit log entry
      effect: write
      questions:
      - Can I write my own entry into the audit trail?
      - Which details, like user, IP and action, does a new audit record need?
      instructions:
      - text: Log audit action {action} by {userName} from {ipAddress} described as {description}.
        slots:
          action: requestBody.action
          userName: requestBody.userName
          ipAddress: requestBody.ipAddress
          description: requestBody.description
      - text: 'Record an audit entry dated {auditDate} for user {userName} doing {action} from {ipAddress}: {description}.'
        slots:
          auditDate: requestBody.auditDate
          userName: requestBody.userName
          action: requestBody.action
          ipAddress: requestBody.ipAddress
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Audits({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one audit log entry
      effect: read
      questions:
      - Who performed a particular audited action, and from where?
      - Can I pull up a single audit record by id?
      instructions:
      - text: Fetch audit entry {id}.
        slots:
          id: path.id
      - text: Show the user, action and IP of audit record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Audits({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an audit log entry
      effect: write
      questions:
      - Can an audit record be overwritten in full?
      - Does replacing an audit entry require resending the user, IP and action?
      instructions:
      - text: Replace audit entry {id} with action {action} by {userName}.
        slots:
          id: path.id
          action: requestBody.action
          userName: requestBody.userName
      - text: Overwrite the full record of audit entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Audits({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one audit log entry
      effect: destructive
      questions:
      - Is it possible to delete a single audit trail record?
      - Can deleting an audit entry be guarded by its ETag?
      instructions:
      - text: Delete audit entry {id}.
        slots:
          id: path.id
      - text: Delete audit record {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Audits({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit fields of an audit log entry
      effect: write
      questions:
      - Can I correct just the description on an existing audit record?
      - Is a partial update allowed on audit entries?
      instructions:
      - text: Change the description of audit entry {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      - text: Set the audit date of entry {id} to {auditDate}.
        slots:
          id: path.id
          auditDate: requestBody.auditDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/Audits/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for an audit entry
      effect: read
      questions:
      - What defaults does a new audit record start with?
      - Is there a blank audit entry template?
      instructions:
      - text: Get the default field values for a new audit entry.
      - text: Show the empty audit record template.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/audits/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete audit log entries
      effect: destructive
      questions:
      - Can I purge many audit records in one request?
      - Is there a batch delete for audit entries by id list?
      instructions:
      - text: Bulk delete audit entries {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every audit record in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/audits({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an audit entry
      effect: read
      questions:
      - How can I read a custom property stored on an audit record?
      - Can I fetch one custom field value from an audit entry?
      instructions:
      - text: Get custom property {custompropertyKey} of audit entry {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on audit record {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'