Gumlet · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gumlet Audit Logs API

2 actions 2 updates phrasing extends openapi/gumlet-audit-logs-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Gumlet's API. It is a proposal applied on top of the contract, not a document Gumlet publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/user/audit-log'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gumlet Audit Logs API
  version: 1.0.0
extends: openapi/gumlet-audit-logs-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: 1
- target: $.paths['/user/audit-log'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch user activity audit logs
      effect: read
      questions:
      - Who in my organisation changed settings last week?
      - Can I filter the audit log to a single user's email or activity type?
      - Which roles are allowed to see the organisation's audit trail?
      instructions:
      - text: Show audit logs for {date_range}.
        slots:
          date_range: requestBody.date_range
      - text: Get audit log activity by {user_email} during {date_range}.
        slots:
          user_email: requestBody.user_email
          date_range: requestBody.date_range
      - text: List {activity_type} events in the audit log for {date_range}.
        slots:
          activity_type: requestBody.activity_type
          date_range: requestBody.date_range
      method: generated
      generated: '2026-10-01'