Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Admin Events API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/orgs/{orgId}/events'].get
$.paths['/v1/orgs/{orgId}/events/{eventId}'].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 Atlassian Admin Events API
  version: 1.0.0
extends: openapi/atlassian-events-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['/v1/orgs/{orgId}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Search an organization's audit log
      effect: read
      questions:
      - What admin actions happened in my Atlassian organization last week?
      - Can I filter the org audit trail by action type and date range?
      instructions:
      - text: List audit events for organization {orgId} from {from} to {to}.
        slots:
          orgId: path.orgId
          from: query.from
          to: query.to
      - text: Show org {orgId}'s audit events with action {action}.
        slots:
          orgId: path.orgId
          action: query.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/orgs/{orgId}/events/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one audit log event
      effect: read
      questions:
      - What exactly changed in a particular audit event?
      - Can I look up one organization event by its ID?
      instructions:
      - text: Get event {eventId} in organization {orgId}.
        slots:
          eventId: path.eventId
          orgId: path.orgId
      - text: Show the details of audit event {eventId} for org {orgId}.
        slots:
          eventId: path.eventId
          orgId: path.orgId
      method: generated
      generated: '2026-10-01'