Merge · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Merge Subpackage Audit Trail API

9 actions 9 updates phrasing extends openapi/merge-subpackage-audittrail-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Merge's API. It is a proposal applied on top of the contract, not a document Merge publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/accounting/v1/audit-trail'].get
$.paths['/ats/v1/audit-trail'].get
$.paths['/audit-trail'].get
$.paths['/crm/v1/audit-trail'].get
$.paths['/filestorage/v1/audit-trail'].get
$.paths['/hris/v1/audit-trail'].get
$.paths['/knowledgebase/v1/audit-trail'].get
$.paths['/ticketing/v1/audit-trail'].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 Merge Subpackage Audit Trail API
  version: 1.0.0
extends: openapi/merge-subpackage-audittrail-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: 8
- target: $.paths['/accounting/v1/audit-trail'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit trail events (accounting path)
      effect: read
      questions:
      - Who on my team changed settings in the accounting integration dashboard last week?
      - Can I filter accounting audit events by the user's email?
      instructions:
      - text: List accounting audit trail events between {start_date} and {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Show accounting-path audit events by {user_email}.
        slots:
          user_email: query.user_email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/audit-trail'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit trail events (ATS path)
      effect: read
      questions:
      - What actions were logged in the recruiting integrations audit trail?
      - Can I see only one type of event in the ATS audit log?
      instructions:
      - text: List ATS audit events of type {event_type}.
        slots:
          event_type: query.event_type
      - text: Get the recruiting audit trail since {start_date}.
        slots:
          start_date: query.start_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audit-trail'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit trail events (root path)
      effect: read
      questions:
      - Is there an audit trail endpoint at the root path without a category prefix?
      - Can the unprefixed audit log be paged with a cursor?
      instructions:
      - text: Fetch audit events from the root /audit-trail route for {user_email}.
        slots:
          user_email: query.user_email
      - text: Read the category-less audit log, {page_size} events per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/audit-trail'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit trail events (CRM path)
      effect: read
      questions:
      - Which team members made changes recorded in the CRM audit trail?
      - Can I narrow CRM audit events to a date window?
      instructions:
      - text: List CRM audit trail events of type {event_type}.
        slots:
          event_type: query.event_type
      - text: Show the CRM audit log up to {end_date}.
        slots:
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/audit-trail'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit trail events (file storage path)
      effect: read
      questions:
      - What security and settings events appear in the file storage audit trail?
      - Can I check whether a colleague rotated keys via the file storage audit log?
      instructions:
      - text: List file storage audit events by user {user_email}.
        slots:
          user_email: query.user_email
      - text: Get the file storage audit trail from {start_date}.
        slots:
          start_date: query.start_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/audit-trail'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit trail events (HRIS path)
      effect: read
      questions:
      - Who changed HR integration settings according to the HRIS audit trail?
      - Can the HRIS audit log be filtered by event type?
      instructions:
      - text: List HRIS audit events between {start_date} and {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Show HRIS-path audit events of kind {event_type}.
        slots:
          event_type: query.event_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/audit-trail'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit trail events (knowledge base path)
      effect: read
      questions:
      - What actions are logged in the knowledge base audit trail?
      - Can I page through the wiki integration audit log?
      instructions:
      - text: List knowledge base audit events by {user_email}.
        slots:
          user_email: query.user_email
      - text: Get the next page of wiki audit events after cursor {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/audit-trail'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit trail events (ticketing path)
      effect: read
      questions:
      - Which dashboard actions were recorded in the ticketing audit trail?
      - Can I limit ticketing audit events to a single user?
      instructions:
      - text: List ticketing audit events of type {event_type}.
        slots:
          event_type: query.event_type
      - text: Show the helpdesk audit log from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'