Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Assignment Extensions API

2 actions 2 updates phrasing extends openapi/canvas-assignment-extensions-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}/assignments/{assignment_id}/extensions'].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 Assignment Extensions API
  version: 1.0.0
extends: openapi/canvas-assignment-extensions-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}/assignments/{assignment_id}/extensions'].post
  update:
    x-apievangelist-phrasing:
      intent: Give students extra attempts on an assignment
      effect: write
      questions:
      - How do I give a student extra attempts on an assignment?
      - What happens if I'm not allowed to extend assignments in a course?
      instructions:
      - text: Give student {user_id} {extra_attempts} extra attempts on assignment {assignment_id} in course {course_id}.
        slots:
          user_id: requestBody.assignment_extensions[user_id]
          extra_attempts: requestBody.assignment_extensions[extra_attempts]
          assignment_id: path.assignment_id
          course_id: path.course_id
      - text: Extend assignment {assignment_id} in course {course_id} by {extra_attempts} attempts for user {user_id}.
        slots:
          assignment_id: path.assignment_id
          course_id: path.course_id
          extra_attempts: requestBody.assignment_extensions[extra_attempts]
          user_id: requestBody.assignment_extensions[user_id]
      method: generated
      generated: '2026-10-01'