Strivacity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin Portal - Admin Management Admin Account Event API

6 actions 6 updates phrasing extends openapi/strivacity-admin-account-event-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Strivacity's API. It is a proposal applied on top of the contract, not a document Strivacity publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/admin/api/v1/admin/events/account'].get
$.paths['/admin/api/v1/admin/events/account/{eventId}'].get
$.paths['/admin/api/v1/admin/events/descriptor'].get
$.paths['/admin/api/v1/admin/events/notification'].get
$.paths['/admin/api/v1/admin/events/notification/{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 Admin Portal - Admin Management Admin Account Event API
  version: 1.0.0
extends: openapi/strivacity-admin-account-event-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: 5
- target: $.paths['/admin/api/v1/admin/events/account'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin account events
      effect: read
      questions:
      - What did my administrators do in the admin console recently?
      - Can I filter admin account events by IP or event type?
      - Which admin login events happened in a date range?
      instructions:
      - text: List admin account events for admin {admin}.
        slots:
          admin: query.subjectAccountIds
      - text: Show admin account events from IP {ip} since {start}.
        slots:
          ip: query.actorIps
          start: query.startDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/events/account/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an admin account event
      effect: read
      questions:
      - What happened in a particular admin account event?
      - Can I fetch one administrator event by ID?
      instructions:
      - text: Get admin account event {event}.
        slots:
          event: path.eventId
      - text: Show details of administrator event {event}.
        slots:
          event: path.eventId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/events/descriptor'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin event type descriptors
      effect: read
      questions:
      - What event types can appear in the admin event log?
      - Which descriptors exist for administrator account events?
      instructions:
      - text: List the descriptors for admin account events.
      - text: Show every possible admin event type.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/events/notification'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin notification events
      effect: read
      questions:
      - Did my admins receive their notification emails?
      - Can I see failed notifications sent to administrators?
      instructions:
      - text: List admin notification events for admin {admin}.
        slots:
          admin: query.accountIds
      - text: Show admin notifications sent to {target}.
        slots:
          target: query.target
      method: generated
      generated: '2026-10-01'
- target: $.paths['/admin/api/v1/admin/events/notification/{eventId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an admin notification event
      effect: read
      questions:
      - What was the outcome of one notification sent to an admin?
      - Can I retrieve a single administrator notification event?
      instructions:
      - text: Get admin notification event {event}.
        slots:
          event: path.eventId
      - text: Show delivery details for admin notification {event}.
        slots:
          event: path.eventId
      method: generated
      generated: '2026-10-01'