Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Suite Audit events API

5 actions 5 updates phrasing extends openapi/adobe-suite-audit-events-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/audit/events'].get
$.paths['/audit/export'].get
$.paths['/audit_events'].get
$.paths['/audit_events/{EVENT_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 Adobe Suite Audit events API
  version: 1.0.0
extends: openapi/adobe-suite-audit-events-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: 4
- target: $.paths['/audit/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Query Platform audit events
      effect: read
      questions:
      - Who changed what in my Experience Platform sandbox, according to the audit log?
      - Can I filter Platform audit events by action or resource type?
      - How do I page through more than 1000 audit events with the same query?
      instructions:
      - text: List Platform audit events in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show up to {limit} Platform audit events filtered by {property}.
        slots:
          limit: query.limit
          property: query.property
      - text: Get the next page of audit query {queryId} starting at {start}.
        slots:
          queryId: query.queryId
          start: query.start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audit/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export Platform audit events
      effect: read
      questions:
      - Can I export the Experience Platform audit log to a file?
      - How do I download audit events that match a filter?
      instructions:
      - text: Export the Platform audit events for sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Export audit events filtered by {property}.
        slots:
          property: query.property
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audit_events'].get
  update:
    x-apievangelist-phrasing:
      intent: List tags audit events
      effect: read
      questions:
      - What changes have been made to my tags properties recently?
      - Can I filter tags audit events by type or creation date?
      instructions:
      - text: List the tags audit events.
      - text: Show tags audit events of type {type}.
        slots:
          type: query.type_of
      - text: List tags audit events created at {created}.
        slots:
          created: query.created_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/audit_events/{EVENT_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tags audit event
      effect: read
      questions:
      - How do I look up a single tags audit event by ID?
      - What exactly changed in one audit event?
      instructions:
      - text: Show audit event {event}.
        slots:
          event: path.EVENT_ID
      - text: Get the details of tags audit event {event}.
        slots:
          event: path.EVENT_ID
      method: generated
      generated: '2026-09-26'