The Things Network / The Things Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Things Stack — Identity Server Notification Service API

3 actions 3 updates phrasing extends openapi/the-things-network-notification-service-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/users/{receiver_ids.user_id}/notifications'].get

$.paths['/users/{receiver_ids.user_id}/notifications'].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 Things Stack — Identity Server Notification Service API
  version: 1.0.0
extends: openapi/the-things-network-notification-service-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: 2
- target: $.paths['/users/{receiver_ids.user_id}/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's notifications
      effect: read
      questions:
      - What notifications do I have on The Things Stack?
      - Can I list only unread or archived notifications?
      instructions:
      - text: List notifications for user {user_id}.
        slots:
          user_id: path.receiver_ids.user_id
      - text: Show notifications for {user_id} with status {status}.
        slots:
          user_id: path.receiver_ids.user_id
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{receiver_ids.user_id}/notifications'].patch
  update:
    x-apievangelist-phrasing:
      intent: Mark notifications as read or archived
      effect: write
      questions:
      - How do I mark several notifications as read at once?
      - Can I archive a batch of notifications?
      instructions:
      - text: Set notifications {ids} for user {user_id} to status {status}.
        slots:
          ids: requestBody.ids
          user_id: path.receiver_ids.user_id
          status: requestBody.status
      - text: Mark notifications {ids} as {status} for {user_id}.
        slots:
          ids: requestBody.ids
          status: requestBody.status
          user_id: path.receiver_ids.user_id
      method: generated
      generated: '2026-10-01'