Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Portfolio Notifications API

2 actions 2 updates phrasing extends openapi/canvas-portfolio-notifications-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/users/{user_id}/portfolio_notifications'].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 Canvas LMS REST Portfolio Notifications API
  version: 1.0.0
extends: openapi/canvas-portfolio-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: 1
- target: $.paths['/v1/users/{user_id}/portfolio_notifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a portfolio notification to a user
      effect: write
      questions:
      - How do I notify a user about a portfolio event?
      - Can a portfolio notification include a link and message?
      instructions:
      - text: Send user {user_id} a {event_type} portfolio notification titled {title}.
        slots:
          user_id: path.user_id
          event_type: requestBody.event_type
          title: requestBody.title
      - text: Notify user {user_id} of {event_type} with title {title}, message {message} and link {url}.
        slots:
          user_id: path.user_id
          event_type: requestBody.event_type
          title: requestBody.title
          message: requestBody.message
          url: requestBody.url
      method: generated
      generated: '2026-10-01'