Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal Audit entry API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/admin/api/v2/admin/events/audit'].get
$.paths['/admin/api/v2/admin/events/audit/{id}'].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 Admin Portal Audit entry API
  version: 1.0.0
extends: openapi/strivacity-audit-entry-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: 2
- target: $.paths['/admin/api/v2/admin/events/audit'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit log entries
      effect: read
      questions:
      - Who changed configuration in my instance and when?
      - Can I filter audit logs by action, entity type or actor?
      instructions:
      - text: List audit logs between {start} and {end}.
        slots:
          start: query.startDate
          end: query.endDate
      - text: Show audit entries made by admin {actor}.
        slots:
          actor: query.actorAccountId
      - text: Find audit logs for entity type {type} with action {action}.
        slots:
          type: query.entityType
          action: query.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v2/admin/events/audit/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an audit log entry
      effect: read
      questions:
      - What exactly changed in one audit log entry?
      - Can I open a single audit record by ID?
      instructions:
      - text: Get audit log {id}.
        slots:
          id: path.id
      - text: Show the details of audit entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'