# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Cloudera Service Audit API version: 1.0.0 extends: openapi/cloudera-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: 11 - target: $.paths['/api/v1/audit/archiveAuditEvents'].post update: x-apievangelist-phrasing: intent: Archive audit events for a time range now effect: write questions: - Can I force CDP audit events to be archived immediately instead of waiting for the schedule? - How do I trigger an on-demand archive of audit events between two timestamps? instructions: - text: Archive the audit events from {fromTimestamp} to {toTimestamp} right now. slots: fromTimestamp: requestBody.fromTimestamp toTimestamp: requestBody.toTimestamp - text: Kick off an immediate audit archive run covering everything since {fromTimestamp} up to {toTimestamp}. slots: fromTimestamp: requestBody.fromTimestamp toTimestamp: requestBody.toTimestamp method: generated generated: '2026-10-01' - target: $.paths['/api/v1/audit/batchEventsForArchiving'].post update: x-apievangelist-phrasing: intent: Group audit events into batches for manual archiving effect: write questions: - How do I split audit events into batches so I can archive them to my own storage? - Is batching audit events for archiving asynchronous, and how do I track it? instructions: - text: Create archive batches for audit events between {fromTimestamp} and {toTimestamp}. slots: fromTimestamp: requestBody.fromTimestamp toTimestamp: requestBody.toTimestamp - text: Start batching the audit log from {fromTimestamp} through {toTimestamp} so I can export it myself. slots: fromTimestamp: requestBody.fromTimestamp toTimestamp: requestBody.toTimestamp method: generated generated: '2026-10-01' - target: $.paths['/api/v1/audit/configureArchiving'].post update: x-apievangelist-phrasing: intent: Configure audit archiving to cloud storage effect: write questions: - How do I set up CDP to archive audit events to an external cloud storage bucket? - Can I just verify an audit archiving storage location and credential without saving the configuration? - Which storage region and credential does audit archiving need? instructions: - text: Turn on audit archiving to {storageLocation} using credential {credentialName}. slots: storageLocation: requestBody.storageLocation credentialName: requestBody.credentialName - text: Set audit archiving enabled to {enabled} with location {storageLocation}, credential {credentialName} and region {storageRegion}. slots: enabled: requestBody.enabled storageLocation: requestBody.storageLocation credentialName: requestBody.credentialName storageRegion: requestBody.storageRegion method: generated generated: '2026-10-01' - target: $.paths['/api/v1/audit/getArchivingConfig'].post update: x-apievangelist-phrasing: intent: Show the current audit archiving configuration effect: read questions: - Where are my audit events currently being archived to? - Is audit archiving switched on for my account right now? instructions: - text: Show me the current audit archiving configuration. - text: Tell me which storage location and credential audit archiving is set to use. method: generated generated: '2026-10-01' - target: $.paths['/api/v1/audit/getArchivingStatus'].post update: x-apievangelist-phrasing: intent: Check the status of an audit archive run effect: read questions: - Did my on-demand audit archive job finish yet? - What status is an audit archiving task in? instructions: - text: Check the status of audit archive task {taskId}. slots: taskId: requestBody.taskId - text: Tell me whether archive process {taskId} has completed. slots: taskId: requestBody.taskId method: generated generated: '2026-10-01' - target: $.paths['/api/v1/audit/getBatchEventsForArchivingStatus'].post update: x-apievangelist-phrasing: intent: Check progress of creating archive batches effect: read questions: - Are my audit event batches ready to be archived yet? - Why is checking batch creation status disabled when automated archiving is on? instructions: - text: Check how the batching of audit events is going for task {taskId}. slots: taskId: requestBody.taskId - text: Show the status of the latest audit event batching job. method: generated generated: '2026-10-01' - target: $.paths['/api/v1/audit/listEvents'].post update: x-apievangelist-phrasing: intent: Search the audit log for a time window effect: read questions: - What audit events were recorded in my CDP account between two dates? - Can I filter audit events by actor, event source or result code? - Which API calls did a specific request ID generate in the audit log? instructions: - text: List audit events from {fromTimestamp} to {toTimestamp}. slots: fromTimestamp: requestBody.fromTimestamp toTimestamp: requestBody.toTimestamp - text: Show audit events by actor {actorCrn} between {fromTimestamp} and {toTimestamp}. slots: actorCrn: requestBody.actorCrn fromTimestamp: requestBody.fromTimestamp toTimestamp: requestBody.toTimestamp - text: Find audit events for request {requestId} from source {eventSource} between {fromTimestamp} and {toTimestamp}. slots: requestId: requestBody.requestId eventSource: requestBody.eventSource fromTimestamp: requestBody.fromTimestamp toTimestamp: requestBody.toTimestamp method: generated generated: '2026-10-01' - target: $.paths['/api/v1/audit/listEventsInArchiveBatch'].post update: x-apievangelist-phrasing: intent: List the events inside one archive batch effect: read questions: - What audit events are contained in a particular archive batch? - Can I read a batch's events again before I mark it archived? instructions: - text: List the events in archive batch {archiveId}. slots: archiveId: requestBody.archiveId - text: Pull every audit event from batch {archiveId} so I can upload it. slots: archiveId: requestBody.archiveId method: generated generated: '2026-10-01' - target: $.paths['/api/v1/audit/listOutstandingArchiveBatches'].post update: x-apievangelist-phrasing: intent: List archive batches not yet archived effect: read questions: - Which audit archive batches still haven't been marked as archived? - What unarchived batches are waiting from last month? instructions: - text: List outstanding archive batches. - text: Show unarchived batches created between {fromTimestamp} and {toTimestamp}. slots: fromTimestamp: requestBody.fromTimestamp toTimestamp: requestBody.toTimestamp method: generated generated: '2026-10-01' - target: $.paths['/api/v1/audit/listRecentArchiveRuns'].post update: x-apievangelist-phrasing: intent: List recent audit archive runs effect: read questions: - When did audit archiving last run for my account? - What were the outcomes of the most recent archive runs? instructions: - text: Show the recent audit archive runs. - text: List the last {limit} archive runs. slots: limit: requestBody.limit method: generated generated: '2026-10-01' - target: $.paths['/api/v1/audit/markArchiveBatchesAsSuccessful'].post update: x-apievangelist-phrasing: intent: Mark archive batches as successfully archived effect: destructive questions: - How do I tell CDP that I've finished archiving a batch of audit events? - What happens to a batch's events once it's marked as successfully archived? instructions: - text: Mark archive batches {archiveIds} as successfully archived. slots: archiveIds: requestBody.archiveIds - text: Close out the batches {archiveIds} now that they're stored in my bucket. slots: archiveIds: requestBody.archiveIds method: generated generated: '2026-10-01'