Scope3 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Scope3 Notifications API

5 actions 5 updates phrasing extends openapi/scope3-notifications-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/notifications'].get

$.paths['/notifications/read-all'].post

$.paths['/notifications/{notificationId}/read'].post

$.paths['/notifications/{notificationId}/acknowledge'].post

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 Scope3 Notifications API
  version: 1.0.0
extends: openapi/scope3-notifications-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: 4
- target: $.paths['/notifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my notifications
      effect: read
      questions:
      - Do I have any unread notifications about my campaigns?
      - Can I filter notifications to a single creative or campaign?
      instructions:
      - text: List my unread notifications.
      - text: Show notifications for campaign {campaignId}.
        slots:
          campaignId: query.campaignId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notifications/read-all'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark all notifications as read
      effect: write
      questions:
      - Can I clear all my unread notifications at once?
      - Is it possible to mark everything read for just one brand agent?
      instructions:
      - text: Mark all my notifications as read.
      - text: Mark every notification for brand agent {brandAgentId} as read.
        slots:
          brandAgentId: requestBody.brandAgentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notifications/{notificationId}/read'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark one notification as read
      effect: write
      questions:
      - How do I mark a single notification as read?
      - Can I flag just one alert as seen?
      instructions:
      - text: Mark notification {notificationId} as read.
        slots:
          notificationId: path.notificationId
      - text: Set notification {notificationId} to read.
        slots:
          notificationId: path.notificationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/notifications/{notificationId}/acknowledge'].post
  update:
    x-apievangelist-phrasing:
      intent: Acknowledge and dismiss a notification
      effect: write
      questions:
      - What's the difference between reading and acknowledging a notification?
      - Can I dismiss a notification from active views?
      instructions:
      - text: Acknowledge notification {notificationId}.
        slots:
          notificationId: path.notificationId
      - text: Dismiss notification {notificationId}.
        slots:
          notificationId: path.notificationId
      method: generated
      generated: '2026-10-01'