OneSignal · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for api.onesignal.com Organizations API

2 actions 2 updates phrasing extends openapi/onesignal-organizations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for OneSignal's API. It is a proposal applied on top of the contract, not a document OneSignal publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/organizations/{organization_id}/audit_logs'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for api.onesignal.com Organizations API
  version: 1.0.0
extends: openapi/onesignal-organizations-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: 1
- target: $.paths['/organizations/{organization_id}/audit_logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's audit log events
      effect: read
      questions:
      - Who changed settings in my OneSignal organization last week?
      - Can I filter audit logs by the person who acted or by app?
      - Which plan do I need to access audit logs?
      instructions:
      - text: List audit log events for organization {organization_id} between {start_time} and {end_time}.
        slots:
          organization_id: path.organization_id
          start_time: query.start_time
          end_time: query.end_time
      - text: Show audit logs in organization {organization_id} for actions by {actor_emails}.
        slots:
          organization_id: path.organization_id
          actor_emails: query.actor_emails
      - text: Get the next page of audit logs for organization {organization_id} from cursor {cursor}.
        slots:
          organization_id: path.organization_id
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'