# 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 Quiz Question Groups API
  version: 1.0.0
extends: openapi/canvas-quiz-question-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: 6
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List a quiz's question groups
      effect: read
      questions:
      - Which question groups make up a quiz?
      - Can I see every random-pick group in a classic quiz?
      instructions:
      - text: List question groups in quiz {quiz_id} of course {course_id}.
        slots:
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: Show all the question groups for quiz {quiz_id} in course {course_id}.
        slots:
          quiz_id: path.quiz_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a quiz question group
      effect: write
      questions:
      - How do I make a quiz pick a random number of questions from a group?
      - Can a question group draw from an existing question bank?
      instructions:
      - text: Create question group {name} in quiz {quiz_id} of course {course_id}.
        slots:
          name: requestBody.quiz_groups[name]
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: Create group {name} in quiz {quiz_id} of course {course_id} that picks {pick_count} questions worth {question_points} each.
        slots:
          name: requestBody.quiz_groups[name]
          pick_count: requestBody.quiz_groups[pick_count]
          question_points: requestBody.quiz_groups[question_points]
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: Link question bank {assessment_question_bank_id} as a new group in quiz {quiz_id} of course {course_id}.
        slots:
          assessment_question_bank_id: requestBody.quiz_groups[assessment_question_bank_id]
          quiz_id: path.quiz_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one quiz question group
      effect: read
      questions:
      - How many questions does a particular quiz group pick, and for how many points?
      - Can I look up a single question group by id?
      instructions:
      - text: Show question group {id} in quiz {quiz_id} of course {course_id}.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: Get the pick count and points of quiz group {id} in quiz {quiz_id}, course {course_id}.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a quiz question group
      effect: write
      questions:
      - Can I change how many questions a quiz group picks?
      - Is it possible to rename a question group or change its point value?
      instructions:
      - text: Set question group {id} in quiz {quiz_id} of course {course_id} to pick {pick_count} questions.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
          pick_count: requestBody.quiz_groups[pick_count]
      - text: Rename quiz group {id} in quiz {quiz_id} of course {course_id} to {name}.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
          name: requestBody.quiz_groups[name]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a quiz question group
      effect: destructive
      questions:
      - Can I remove a question group from a quiz?
      - What response confirms a quiz group was deleted?
      instructions:
      - text: Delete question group {id} from quiz {quiz_id} in course {course_id}.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
      - text: Remove group {id} from quiz {quiz_id} of course {course_id}.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}/reorder'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder questions within a quiz group
      effect: write
      questions:
      - How do I change the order of questions inside a question group?
      - Can I rearrange the items within one quiz group?
      instructions:
      - text: Reorder the questions in group {id} of quiz {quiz_id}, course {course_id}, as {order_ids}.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
          order_ids: requestBody.order[id]
      - text: Put question {order_ids} first in quiz {quiz_id} group {id} of course {course_id}.
        slots:
          id: path.id
          quiz_id: path.quiz_id
          course_id: path.course_id
          order_ids: requestBody.order[id]
      method: generated
      generated: '2026-10-01'