Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Polls API

6 actions 6 updates phrasing extends openapi/canvas-polls-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'].get

$.paths['/v1/polls'].post

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

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

$.paths['/v1/polls/{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 Polls API
  version: 1.0.0
extends: openapi/canvas-polls-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List my polls
      effect: read
      questions:
      - What polls have I created?
      - Can I see all of my polls in one list?
      instructions:
      - text: List my polls.
      - text: Show every poll I own.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/polls'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a poll
      effect: write
      questions:
      - How do I create a new poll with a question?
      - Can I add a description when creating a poll?
      instructions:
      - text: Create a poll asking {question}.
        slots:
          question: requestBody.polls[question]
      - text: Create a poll asking {question} with description {description}.
        slots:
          question: requestBody.polls[question]
          description: requestBody.polls[description]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/polls/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single poll
      effect: read
      questions:
      - What does one of my polls ask?
      - Can I look up a poll by its ID?
      instructions:
      - text: Get poll {id}.
        slots:
          id: path.id
      - text: Show the question for poll {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/polls/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a poll's question
      effect: write
      questions:
      - Can I change the question of a poll I already made?
      - How do I edit a poll's description?
      instructions:
      - text: Change poll {id}'s question to {question}.
        slots:
          id: path.id
          question: requestBody.polls[question]
      - text: Update poll {id} to ask {question} with description {description}.
        slots:
          id: path.id
          question: requestBody.polls[question]
          description: requestBody.polls[description]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/polls/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a poll
      effect: destructive
      questions:
      - Is there a way to delete a poll I no longer need?
      - What response confirms a poll was deleted?
      instructions:
      - text: Delete poll {id}.
        slots:
          id: path.id
      - text: Remove my poll {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'