Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Block Editor Template API

2 actions 2 updates phrasing extends openapi/canvas-block-editor-template-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/courses/{course_id}/block_editor_templates'].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 Block Editor Template API
  version: 1.0.0
extends: openapi/canvas-block-editor-template-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/courses/{course_id}/block_editor_templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List block editor templates for a course
      effect: read
      questions:
      - What page templates can I use in the Canvas block editor for my course?
      - Can I include draft templates or filter templates by type?
      instructions:
      - text: List block templates available in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show course {course_id} block templates of type {type}, sorted by {sort}.
        slots:
          course_id: path.course_id
          type: query.type
          sort: query.sort
      method: generated
      generated: '2026-10-01'