AI Applyd · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aiapplyd Notifications API

6 actions 6 updates phrasing extends openapi/aiapplyd-notifications-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/notifications/push-token'].post

$.paths['/notifications/push-token/unregister'].post

$.paths['/notifications'].get

$.paths['/notifications/read'].patch

$.paths['/notifications/dismiss'].patch

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 Aiapplyd Notifications API
  version: 1.0.0
extends: openapi/aiapplyd-notifications-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: 5
- target: $.paths['/notifications/push-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a device for push notifications
      effect: write
      questions:
      - How do I get push notifications on my phone?
      - What happens if I register the same Expo push token twice?
      instructions:
      - text: Register push token {token}.
        slots:
          token: requestBody.token
      - text: Register Expo token {token} for {platform}.
        slots:
          token: requestBody.token
          platform: requestBody.platform
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/push-token/unregister'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop push notifications to a device
      effect: destructive
      questions:
      - Should the push token be removed when I sign out on my phone?
      - Can I stop notifications going to a device I no longer use?
      instructions:
      - text: Unregister push token {token}.
        slots:
          token: requestBody.token
      - text: Remove device token {token} from my account.
        slots:
          token: requestBody.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my notifications
      effect: read
      questions:
      - How many unread notifications do I have?
      - Can I load older notifications beyond the first page?
      instructions:
      - text: Show my notifications.
      - text: List notifications older than {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/read'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark notifications as read
      effect: write
      questions:
      - Can I mark several notifications read at once?
      - How many notifications can be marked read in one request?
      instructions:
      - text: Mark notifications {ids} as read.
        slots:
          ids: requestBody.ids
      - text: Clear the unread flag on {ids}.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/dismiss'].patch
  update:
    x-apievangelist-phrasing:
      intent: Dismiss notifications
      effect: write
      questions:
      - Can I dismiss notifications so they leave my feed?
      - Is there a limit on how many notifications I can dismiss together?
      instructions:
      - text: Dismiss notifications {ids}.
        slots:
          ids: requestBody.ids
      - text: Hide notifications {ids} from my feed.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'