Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Audit Logs API

3 actions 3 updates phrasing extends openapi/snyk-audit-logs-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Snyk's API. It is a proposal applied on top of the contract, not a document Snyk publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/groups/{group_id}/audit_logs/search'].get
$.paths['/orgs/{org_id}/audit_logs/search'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Audit Logs API
  version: 1.0.0
extends: openapi/snyk-audit-logs-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: 2
- target: $.paths['/groups/{group_id}/audit_logs/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search a group's audit logs
      effect: read
      questions:
      - Who changed what across my Snyk group last week?
      - Can I search group audit logs for one user's actions?
      - Why don't api.access events show up in group audit results by default?
      instructions:
      - text: Search audit logs for group {group_id} from {from} to {to}.
        slots:
          group_id: path.group_id
          from: query.from
          to: query.to
      - text: Show group {group_id} audit events by user {user_id}.
        slots:
          group_id: path.group_id
          user_id: query.user_id
      - text: Find {events} events in group {group_id}'s audit log.
        slots:
          events: query.events
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/audit_logs/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search an organization's audit logs
      effect: read
      questions:
      - What happened in my organization's audit trail yesterday?
      - Can I filter an org's audit log to a single project?
      - Which event types can I exclude from org audit searches?
      instructions:
      - text: Search audit logs for org {org_id} from {from} to {to}.
        slots:
          org_id: path.org_id
          from: query.from
          to: query.to
      - text: Show org {org_id} audit events for project {project_id}.
        slots:
          org_id: path.org_id
          project_id: query.project_id
      - text: List organization {org_id} audit entries excluding {exclude_events}.
        slots:
          org_id: path.org_id
          exclude_events: query.exclude_events
      method: generated
      generated: '2026-09-26'