Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Poll Submissions API

3 actions 3 updates phrasing extends openapi/canvas-poll-submissions-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 3

$.info

$.paths['/v1/polls/{poll_id}/poll_sessions/{poll_session_id}/poll_submissions/{id}'].get

$.paths['/v1/polls/{poll_id}/poll_sessions/{poll_session_id}/poll_submissions'].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 Poll Submissions API
  version: 1.0.0
extends: openapi/canvas-poll-submissions-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: 2
- target: $.paths['/v1/polls/{poll_id}/poll_sessions/{poll_session_id}/poll_submissions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one poll submission
      effect: read
      questions:
      - How do I see which choice a student picked in a poll session?
      - Can I fetch a single poll response by its id?
      instructions:
      - text: Show submission {id} in poll {poll_id} session {poll_session_id}.
        slots:
          id: path.id
          poll_id: path.poll_id
          poll_session_id: path.poll_session_id
      - text: Get poll response {id} from session {poll_session_id} of poll {poll_id}.
        slots:
          id: path.id
          poll_id: path.poll_id
          poll_session_id: path.poll_session_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/polls/{poll_id}/poll_sessions/{poll_session_id}/poll_submissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a poll response
      effect: write
      questions:
      - How does a student answer a live poll?
      - Can I submit a choice to an open poll session?
      instructions:
      - text: Submit choice {poll_choice_id} to poll {poll_id} session {poll_session_id}.
        slots:
          poll_choice_id: requestBody.poll_submissions[poll_choice_id]
          poll_id: path.poll_id
          poll_session_id: path.poll_session_id
      - text: Vote {poll_choice_id} in session {poll_session_id} of poll {poll_id}.
        slots:
          poll_choice_id: requestBody.poll_submissions[poll_choice_id]
          poll_id: path.poll_id
          poll_session_id: path.poll_session_id
      method: generated
      generated: '2026-10-01'