Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Assignment Groups API

6 actions 6 updates phrasing extends openapi/canvas-assignment-groups-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 6

$.info

$.paths['/v1/courses/{course_id}/assignment_groups'].get

$.paths['/v1/courses/{course_id}/assignment_groups'].post

$.paths['/v1/courses/{course_id}/assignment_groups/{assignment_group_id}'].get

$.paths['/v1/courses/{course_id}/assignment_groups/{assignment_group_id}'].put

$.paths['/v1/courses/{course_id}/assignment_groups/{assignment_group_id}'].delete

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 Groups API
  version: 1.0.0
extends: openapi/canvas-assignment-groups-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: 5
- target: $.paths['/v1/courses/{course_id}/assignment_groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List a course's assignment groups
      effect: read
      questions:
      - What assignment groups does a course have, in order?
      - Can I include the assignments inside each group and filter by grading period?
      instructions:
      - text: List assignment groups in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show course {course_id}'s assignment groups for grading period {grading_period_id}.
        slots:
          course_id: path.course_id
          grading_period_id: query.grading_period_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/assignment_groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an assignment group
      effect: write
      questions:
      - How do I add a weighted category like Homework to a course?
      - Can I set a group's weight and position when I create it?
      instructions:
      - text: Create assignment group {name} in course {course_id}.
        slots:
          name: requestBody.name
          course_id: path.course_id
      - text: Add group {name} weighted {group_weight} percent to course {course_id}.
        slots:
          name: requestBody.name
          group_weight: requestBody.group_weight
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/assignment_groups/{assignment_group_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an assignment group
      effect: read
      questions:
      - How do I look up a single assignment group and its assignments?
      - Which assignments sit in one particular group?
      instructions:
      - text: Show assignment group {assignment_group_id} in course {course_id}.
        slots:
          assignment_group_id: path.assignment_group_id
          course_id: path.course_id
      - text: Get group {assignment_group_id} of course {course_id} including {include}.
        slots:
          assignment_group_id: path.assignment_group_id
          course_id: path.course_id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/assignment_groups/{assignment_group_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an assignment group
      effect: write
      questions:
      - Can I change an existing group's weight or its grading rules?
      - How do I rename an assignment group?
      instructions:
      - text: Rename assignment group {assignment_group_id} in course {course_id} to {name}.
        slots:
          assignment_group_id: path.assignment_group_id
          course_id: path.course_id
          name: requestBody.name
      - text: Set the drop rules of group {assignment_group_id} in course {course_id} to {rules}.
        slots:
          assignment_group_id: path.assignment_group_id
          course_id: path.course_id
          rules: requestBody.rules
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/assignment_groups/{assignment_group_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an assignment group
      effect: destructive
      questions:
      - What happens to assignments when I delete their group?
      - Can I move a group's assignments elsewhere before deleting it?
      instructions:
      - text: Delete assignment group {assignment_group_id} from course {course_id}.
        slots:
          assignment_group_id: path.assignment_group_id
          course_id: path.course_id
      - text: Delete group {assignment_group_id} in course {course_id} and move its assignments to {move_assignments_to}.
        slots:
          assignment_group_id: path.assignment_group_id
          course_id: path.course_id
          move_assignments_to: query.move_assignments_to
      method: generated
      generated: '2026-10-01'