# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian The Confluence Cloud REST Audit API
  version: 1.0.0
extends: openapi/atlassian-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: List Confluence audit records for a date range
      effect: read
      questions:
      - What admin events like space exports or app installs happened between two dates?
      - Can I search the audit log for records containing a specific word?
      instructions:
      - text: List 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 an app add its own entry to the Confluence audit log?
      - What information is required to create an audit record?
      instructions:
      - text: Add an audit record {summary} from IP {remoteAddress}.
        slots:
          summary: requestBody.summary
          remoteAddress: requestBody.remoteAddress
      - text: Log an audit event in category {category} with summary {summary} from {remoteAddress}.
        slots:
          category: requestBody.category
          summary: requestBody.summary
          remoteAddress: requestBody.remoteAddress
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/audit/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export audit records as CSV or ZIP
      effect: read
      questions:
      - How do I download the audit log as a CSV file?
      - Can I export only audit records from a certain period?
      instructions:
      - text: Export the audit log as {format}.
        slots:
          format: query.format
      - text: Export audit records from {startDate} to {endDate} as a file.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      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 are deleted?
      - What is the current audit log retention setting?
      instructions:
      - text: Show 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: Change the audit log retention period
      effect: write
      questions:
      - Can I keep audit records for longer than the default?
      - What is the maximum retention period for the audit log?
      instructions:
      - text: Set the audit retention period to {number} {units}.
        slots:
          number: requestBody.number
          units: requestBody.units
      - text: Keep audit records for {number} {units} before deletion.
        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: List audit records from the last N days, weeks or months
      effect: read
      questions:
      - What happened in the audit log over the last three months?
      - Can I pull recent audit records relative to today instead of fixed dates?
      instructions:
      - text: Show audit records from the last {number} {units}.
        slots:
          number: query.number
          units: query.units
      - text: Get audit entries from the past {number} {units} matching {searchString}.
        slots:
          number: query.number
          units: query.units
          searchString: query.searchString
      method: generated
      generated: '2026-10-01'