Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Management Logs API

5 actions 5 updates phrasing extends openapi/talon-one-logs-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Talon.One's API. It is a proposal applied on top of the contract, not a document Talon.One publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/applications/{applicationId}/access_logs/no_total'].get
$.paths['/v1/message_logs'].get
$.paths['/v1/changes'].get
$.paths['/v1/exports'].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 Management Logs API
  version: 1.0.0
extends: openapi/talon-one-logs-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['/v1/applications/{applicationId}/access_logs/no_total'].get
  update:
    x-apievangelist-phrasing:
      intent: Get API access logs for an Application
      effect: read
      questions:
      - Which API calls hit my Application during a time window?
      - Can I filter an Application's access logs to failed requests on one path?
      instructions:
      - text: Show access logs for application {applicationId} from {rangeStart} to {rangeEnd}.
        slots:
          applicationId: path.applicationId
          rangeStart: query.rangeStart
          rangeEnd: query.rangeEnd
      - text: List calls to {path} with status {status} in application {applicationId} between {rangeStart} and {rangeEnd}.
        slots:
          path: query.path
          status: query.status
          applicationId: path.applicationId
          rangeStart: query.rangeStart
          rangeEnd: query.rangeEnd
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/message_logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook and notification message logs
      effect: read
      questions:
      - Did my webhook deliveries succeed, and what response codes came back?
      - Can I see message logs for a single loyalty program's notifications?
      instructions:
      - text: List message logs for entity type {entityType}.
        slots:
          entityType: query.entityType
      - text: Show failed message logs for {entityType} where isSuccessful is {isSuccessful}.
        slots:
          entityType: query.entityType
          isSuccessful: query.isSuccessful
      - text: Get message logs of type {entityType} for webhooks {webhookIDs}.
        slots:
          entityType: query.entityType
          webhookIDs: query.webhookIDs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/changes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the account's audit log
      effect: read
      questions:
      - Who changed what in our account, and when?
      - Can I see the audit trail of a single user's changes?
      instructions:
      - text: Show the audit log for my account.
      - text: List audit log changes made by user {userId}.
        slots:
          userId: query.userId
      - text: Show audit log entries for application {applicationId} created after {createdAfter}.
        slots:
          applicationId: query.applicationId
          createdAfter: query.createdAfter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/exports'].get
  update:
    x-apievangelist-phrasing:
      intent: List past data exports
      effect: read
      questions:
      - What exports have been run in the account before?
      - Can I list past exports for one campaign?
      instructions:
      - text: List all past exports.
      - text: Show past exports for campaign {campaignId}.
        slots:
          campaignId: query.campaignId
      - text: List previous exports of entity {entity}.
        slots:
          entity: query.entity
      method: generated
      generated: '2026-09-26'