# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Cloud REST Audit API
  version: 1.0.0
extends: openapi/confluence-audit-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: 6
- target: $.paths['/wiki/rest/api/audit'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the audit log
      effect: read
      questions:
      - How do I see who exported a space or changed group membership?
      - Can I pull audit log records between two dates?
      - Is there a way to search audit records for a keyword?
      instructions:
      - text: Get audit records from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Search the audit log for {searchString}.
        slots:
          searchString: query.searchString
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/audit'].post
  update:
    x-apievangelist-phrasing:
      intent: Write a record to the audit log
      effect: write
      questions:
      - Can my app add its own entry to the Confluence audit log?
      - What details can I record when creating an audit entry?
      instructions:
      - text: Create an audit record from IP {remoteAddress} with summary {summary}.
        slots:
          remoteAddress: requestBody.remoteAddress
          summary: requestBody.summary
      - text: Log an audit event in category {category} from address {remoteAddress} described as {description}.
        slots:
          category: requestBody.category
          remoteAddress: requestBody.remoteAddress
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/audit/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export audit records to a file
      effect: read
      questions:
      - How do I download the audit log as a CSV?
      - Can I export audit records for a date range as a ZIP file?
      instructions:
      - text: Export the audit log as {format}.
        slots:
          format: query.format
      - text: Download audit records from {startDate} to {endDate} as a {format} file.
        slots:
          startDate: query.startDate
          endDate: query.endDate
          format: query.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/audit/retention'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the audit log retention period
      effect: read
      questions:
      - How long are audit records kept before they're deleted?
      - What is our current audit retention setting?
      instructions:
      - text: Get the audit log retention period.
      - text: Tell me how long audit records are retained.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/audit/retention'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the audit log retention period
      effect: write
      questions:
      - Can I keep audit records for longer, and what's the maximum?
      - How do I change how long the audit log keeps entries?
      instructions:
      - text: Set audit log retention to {number} {units}.
        slots:
          number: requestBody.number
          units: requestBody.units
      - text: Keep audit records for {number} {units} before deleting them.
        slots:
          number: requestBody.number
          units: requestBody.units
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/audit/since'].get
  update:
    x-apievangelist-phrasing:
      intent: Get recent audit records for a time window
      effect: read
      questions:
      - What happened in the audit log over the last few months?
      - Can I fetch audit records going back a set number of weeks from today?
      instructions:
      - text: Get audit records from the last {number} {units}.
        slots:
          number: query.number
          units: query.units
      - text: Show audit events from the past {number} {units} matching {searchString}.
        slots:
          number: query.number
          units: query.units
          searchString: query.searchString
      method: generated
      generated: '2026-10-01'