Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Poll Choices API

6 actions 6 updates phrasing extends openapi/canvas-poll-choices-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/polls/{poll_id}/poll_choices'].get

$.paths['/v1/polls/{poll_id}/poll_choices'].post

$.paths['/v1/polls/{poll_id}/poll_choices/{id}'].get

$.paths['/v1/polls/{poll_id}/poll_choices/{id}'].put

$.paths['/v1/polls/{poll_id}/poll_choices/{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 Poll Choices API
  version: 1.0.0
extends: openapi/canvas-poll-choices-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/polls/{poll_id}/poll_choices'].get
  update:
    x-apievangelist-phrasing:
      intent: List the choices in a poll
      effect: read
      questions:
      - What answer options does a Canvas poll have?
      - Can I see which poll choices are marked correct?
      instructions:
      - text: List the choices in poll {poll_id}.
        slots:
          poll_id: path.poll_id
      - text: Show all answer options for poll {poll_id}.
        slots:
          poll_id: path.poll_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/polls/{poll_id}/poll_choices'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a choice to a poll
      effect: write
      questions:
      - How do I add an answer option to a poll?
      - Can I mark a new poll choice as the correct answer and set its position?
      instructions:
      - text: Add choice {text} to poll {poll_id}.
        slots:
          text: requestBody.poll_choices[text]
          poll_id: path.poll_id
      - text: Create poll {poll_id} choice {text} at position {position}, correct {is_correct}.
        slots:
          poll_id: path.poll_id
          text: requestBody.poll_choices[text]
          position: requestBody.poll_choices[position]
          is_correct: requestBody.poll_choices[is_correct]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/polls/{poll_id}/poll_choices/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one poll choice
      effect: read
      questions:
      - How do I fetch a single choice from a poll?
      - Is a specific poll choice flagged as correct?
      instructions:
      - text: Show choice {id} in poll {poll_id}.
        slots:
          id: path.id
          poll_id: path.poll_id
      - text: Get poll {poll_id} option {id}.
        slots:
          poll_id: path.poll_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/polls/{poll_id}/poll_choices/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a poll choice
      effect: write
      questions:
      - Can I change the wording of an existing poll choice?
      - How do I reorder a poll's answer options?
      instructions:
      - text: Change choice {id} in poll {poll_id} to read {text}.
        slots:
          id: path.id
          poll_id: path.poll_id
          text: requestBody.poll_choices[text]
      - text: 'Edit poll {poll_id} choice {id}: text {text}, position {position}.'
        slots:
          poll_id: path.poll_id
          id: path.id
          text: requestBody.poll_choices[text]
          position: requestBody.poll_choices[position]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/polls/{poll_id}/poll_choices/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a poll choice
      effect: destructive
      questions:
      - How do I remove an answer option from a poll?
      - What response comes back after deleting a poll choice?
      instructions:
      - text: Delete choice {id} from poll {poll_id}.
        slots:
          id: path.id
          poll_id: path.poll_id
      - text: Remove poll {poll_id} option {id}.
        slots:
          poll_id: path.poll_id
          id: path.id
      method: generated
      generated: '2026-10-01'