Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Assessment Question Banks API

4 actions 4 updates phrasing extends openapi/canvas-assessment-question-banks-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 4

$.info

$.paths['/v1/question_banks'].get

$.paths['/v1/question_banks/{id}'].get

$.paths['/v1/question_banks/{id}/questions'].get

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 Assessment Question Banks API
  version: 1.0.0
extends: openapi/canvas-assessment-question-banks-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: 3
- target: $.paths['/v1/question_banks'].get
  update:
    x-apievangelist-phrasing:
      intent: List question banks in a context
      effect: read
      questions:
      - What question banks exist in a course?
      - Can I see how many questions are in each bank?
      instructions:
      - text: List question banks for {context_type} {context_id}.
        slots:
          context_type: query.context_type
          context_id: query.context_id
      - text: Show question banks in {context_type} {context_id} with question counts {include_question_count}.
        slots:
          context_type: query.context_type
          context_id: query.context_id
          include_question_count: query.include_question_count
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/question_banks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single question bank
      effect: read
      questions:
      - What are the details of one question bank?
      - How many questions does a specific bank hold?
      instructions:
      - text: Get question bank {id}.
        slots:
          id: path.id
      - text: Show question bank {id} with question count {include_question_count}.
        slots:
          id: path.id
          include_question_count: query.include_question_count
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/question_banks/{id}/questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List questions in a question bank
      effect: read
      questions:
      - Which questions are inside a particular question bank?
      - Can I page through the assessment questions of a bank?
      instructions:
      - text: List the questions in question bank {id}.
        slots:
          id: path.id
      - text: Show every assessment question stored in bank {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'