Appwrite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Appwrite Notifications API

3 actions 3 updates phrasing extends openapi/appwrite-notifications-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Appwrite's API. It is a proposal applied on top of the contract, not a document Appwrite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/notifications'].get
$.paths['/notifications/{notificationId}'].patch

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 Appwrite Notifications API
  version: 1.0.0
extends: openapi/appwrite-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: 2
- target: $.paths['/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my console notifications
      effect: read
      questions:
      - What notifications do I have waiting in the Appwrite console?
      - Can I see only my unread console notifications?
      instructions:
      - text: List my console notifications.
      - text: List my notifications matching {queries}.
        slots:
          queries: query.queries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/notifications/{notificationId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark a notification read or unread
      effect: write
      questions:
      - How do I mark a console notification as read?
      - Can I flip a notification back to unread after opening it?
      instructions:
      - text: Mark notification {notificationId} as read.
        slots:
          notificationId: path.notificationId
      - text: Set the read flag on notification {notificationId} to {read}.
        slots:
          notificationId: path.notificationId
          read: requestBody.read
      method: generated
      generated: '2026-09-26'