Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Audit Records API

2 actions 2 updates phrasing extends openapi/atlassian-audit-records-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 2

$.info
$.paths['/rest/api/3/auditing/record'].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 The Jira Cloud platform REST Audit Records API
  version: 1.0.0
extends: openapi/atlassian-audit-records-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['/rest/api/3/auditing/record'].get
  update:
    x-apievangelist-phrasing:
      intent: List Jira audit records
      effect: read
      questions:
      - Who changed permissions or settings in Jira last week?
      - Can I filter the audit log by keyword and date range?
      - What admin changes have been recorded on our Jira site?
      instructions:
      - text: List Jira audit records between {from} and {to}.
        slots:
          from: query.from
          to: query.to
      - text: Search the audit log for {filter}, returning {limit} records.
        slots:
          filter: query.filter
          limit: query.limit
      method: generated
      generated: '2026-10-01'