# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for TextQL Audit Log Service API
  version: 1.0.0
extends: openapi/textql-auditlogservice-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['/textql.rpc.public.audit_log.AuditLogService/ConfigureOtlpExport'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up audit log export over OTLP
      effect: write
      questions:
      - How do I stream TextQL audit logs to my OpenTelemetry collector?
      - Can I choose the OTLP protocol and push interval for audit export?
      instructions:
      - text: Configure OTLP audit export to {endpoint}.
        slots:
          endpoint: requestBody.otlpEndpoint
      - text: Send audit logs to OTLP endpoint {endpoint} over {protocol} every {interval} seconds.
        slots:
          endpoint: requestBody.otlpEndpoint
          protocol: requestBody.otlpProtocol
          interval: requestBody.pushIntervalSeconds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.audit_log.AuditLogService/ConfigureS3Export'].post
  update:
    x-apievangelist-phrasing:
      intent: Set up audit log export to S3
      effect: write
      questions:
      - How do I export audit logs to an S3 bucket?
      - Can audit export to S3 use an assumed IAM role instead of access keys?
      instructions:
      - text: Configure audit log export to S3 bucket {bucket} in {region}.
        slots:
          bucket: requestBody.bucket
          region: requestBody.region
      - text: Export audit logs to bucket {bucket} under prefix {prefix} using role {role_arn}.
        slots:
          bucket: requestBody.bucket
          prefix: requestBody.prefix
          role_arn: requestBody.roleArn
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.audit_log.AuditLogService/DeleteOtlpExportConfig'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove the OTLP audit export config
      effect: destructive
      questions:
      - How do I stop sending audit logs to my OTLP collector?
      - Can I delete the OpenTelemetry audit export setup?
      instructions:
      - text: Delete the OTLP audit export configuration, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Turn off OTLP audit log export with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.audit_log.AuditLogService/DeleteS3ExportConfig'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove the S3 audit export config
      effect: destructive
      questions:
      - How do I stop exporting audit logs to S3?
      - Can I delete the S3 bucket configuration for audit export?
      instructions:
      - text: Delete the S3 audit export configuration, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Turn off S3 audit log export with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.audit_log.AuditLogService/GetOtlpExportConfig'].post
  update:
    x-apievangelist-phrasing:
      intent: View the OTLP audit export config
      effect: read
      questions:
      - Where are my audit logs being sent over OTLP?
      - What OTLP endpoint and interval is audit export using?
      instructions:
      - text: Show the OTLP audit export configuration, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Get the current OTLP export settings with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.audit_log.AuditLogService/GetS3ExportConfig'].post
  update:
    x-apievangelist-phrasing:
      intent: View the S3 audit export config
      effect: read
      questions:
      - Which S3 bucket are my audit logs exported to?
      - Is S3 audit export enabled, and how often does it run?
      instructions:
      - text: Show the S3 audit export configuration, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Get the current S3 export settings with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.audit_log.AuditLogService/ListAuditLogs'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the audit log
      effect: read
      questions:
      - Who changed what in my organization, and when?
      - Can I filter audit logs by actor, action or resource type?
      - What happened in the audit trail after a certain time?
      instructions:
      - text: List audit log entries by actor {actor}.
        slots:
          actor: requestBody.actorId
      - text: Show audit events with action {action} on {resource_type} resources after {after}.
        slots:
          action: requestBody.action
          resource_type: requestBody.resourceType
          after: requestBody.after
      - text: Search the audit log for {search_term}.
        slots:
          search_term: requestBody.searchTerm
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.audit_log.AuditLogService/TestOtlpExportConnection'].post
  update:
    x-apievangelist-phrasing:
      intent: Test an OTLP audit export endpoint
      effect: read
      questions:
      - Can I check that my OTLP collector is reachable before enabling audit export?
      - How do I verify OTLP headers and protocol work for audit logs?
      instructions:
      - text: Test the OTLP connection to {endpoint}.
        slots:
          endpoint: requestBody.otlpEndpoint
      - text: Verify OTLP endpoint {endpoint} accepts {protocol} with headers {headers}.
        slots:
          endpoint: requestBody.otlpEndpoint
          protocol: requestBody.otlpProtocol
          headers: requestBody.otlpHeaders
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.audit_log.AuditLogService/TestS3ExportConnection'].post
  update:
    x-apievangelist-phrasing:
      intent: Test an S3 audit export bucket
      effect: read
      questions:
      - Can I confirm TextQL can write to my S3 bucket before enabling audit export?
      - How do I test an IAM role setup for audit log delivery?
      instructions:
      - text: Test access to S3 bucket {bucket} in {region}.
        slots:
          bucket: requestBody.bucket
          region: requestBody.region
      - text: Verify bucket {bucket} is writable using role {role_arn} and external ID {external_id}.
        slots:
          bucket: requestBody.bucket
          role_arn: requestBody.roleArn
          external_id: requestBody.externalId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.audit_log.AuditLogService/TriggerOtlpExport'].post
  update:
    x-apievangelist-phrasing:
      intent: Push audit logs over OTLP now
      effect: write
      questions:
      - Can I force an immediate audit log push to my OTLP collector?
      - How do I send pending audit events over OTLP without waiting for the interval?
      instructions:
      - text: Trigger an OTLP audit export now, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Run the OTLP audit push immediately with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.audit_log.AuditLogService/TriggerS3Export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export audit logs to S3 now
      effect: write
      questions:
      - Can I run the S3 audit log export right away?
      - How do I flush audit events to my bucket without waiting for the schedule?
      instructions:
      - text: Trigger an S3 audit export now, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Run the S3 audit export immediately with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'