Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Plagiarism Detection Platform Users API

3 actions 3 updates phrasing extends openapi/canvas-plagiarism-detection-platform-users-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 3

$.info
$.paths['/lti/users/{id}'].get
$.paths['/lti/groups/{group_id}/users'].get

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 Canvas LMS REST Plagiarism Detection Platform Users API
  version: 1.0.0
extends: openapi/canvas-plagiarism-detection-platform-users-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['/lti/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user as a plagiarism detection tool
      effect: read
      questions:
      - Can a plagiarism tool look up a student by their LTI id?
      - Which users is my LTI tool allowed to fetch?
      instructions:
      - text: Get user {id} for my plagiarism detection tool.
        slots:
          id: path.id
      - text: Look up the user with Canvas or LTI id {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lti/groups/{group_id}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's users as an LTI tool
      effect: read
      questions:
      - Can my LTI tool list everyone in a student group?
      - Which groups can a tool provider read members from?
      instructions:
      - text: List the users in group {group_id} for my LTI tool.
        slots:
          group_id: path.group_id
      - text: Get all members of group {group_id} as the tool provider.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'