# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Flagsmith Audit API
  version: 1.0.0
extends: openapi/flagsmith-audit-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: 6
- target: $.paths['/api/v1/audit/'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the audit log across everything I can see
      effect: read
      questions:
      - Who changed what across all my Flagsmith projects recently?
      - Can I hide system events and only see changes made by people in the global audit log?
      - Is there a way to search every audit entry I have access to by keyword?
      instructions:
      - text: Search the whole audit log for {search}.
        slots:
          search: query.search
      - text: List audit log entries for environments {environments}, {page_size} per page.
        slots:
          environments: query.environments
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/audit/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one audit log entry by ID
      effect: read
      questions:
      - Can I pull up the full detail of a single audit log record?
      - What exactly was recorded in one audit event, using the top-level audit endpoint?
      instructions:
      - text: Show audit log entry {id}.
        slots:
          id: path.id
      - text: Open audit record {id} and tell me who made the change.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/audit/'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organisation's audit log
      effect: read
      questions:
      - How do I see the audit trail for everything in one organisation?
      - Can I filter an organisation's audit log down to a single project?
      instructions:
      - text: List the audit log for organisation {organisation_pk}.
        slots:
          organisation_pk: path.organisation_pk
      - text: Search organisation {organisation_pk}'s audit log for {search} in project {project}.
        slots:
          organisation_pk: path.organisation_pk
          search: query.search
          project: query.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/organisations/{organisation_pk}/audit/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audit entry within an organisation
      effect: read
      questions:
      - Can I look up one audit record scoped to a specific organisation?
      - What did a particular organisation-level audit event change?
      instructions:
      - text: Show audit entry {id} from organisation {organisation_pk}.
        slots:
          id: path.id
          organisation_pk: path.organisation_pk
      - text: Get the details of organisation {organisation_pk}'s audit record {id}.
        slots:
          organisation_pk: path.organisation_pk
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/projects/{project_pk}/audit/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's audit log
      effect: read
      questions:
      - What changes have been made inside one project lately?
      - Can I narrow a project's audit trail to certain environments and skip system events?
      instructions:
      - text: List the audit log for project {project_pk}.
        slots:
          project_pk: path.project_pk
      - text: Show project {project_pk} audit entries for environments {environments}, excluding system events ({is_system_event}).
        slots:
          project_pk: path.project_pk
          environments: query.environments
          is_system_event: query.is_system_event
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/projects/{project_pk}/audit/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audit entry within a project
      effect: read
      questions:
      - How do I open a single audit record that belongs to one project?
      - Can I see the detail of a project-scoped audit event?
      instructions:
      - text: Show audit entry {id} from project {project_pk}.
        slots:
          id: path.id
          project_pk: path.project_pk
      - text: Get project {project_pk}'s audit record {id} and summarise the change.
        slots:
          project_pk: path.project_pk
          id: path.id
      method: generated
      generated: '2026-09-26'