Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Tabs API

6 actions 6 updates phrasing extends openapi/canvas-tabs-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/accounts/{account_id}/tabs'].get

$.paths['/v1/courses/{course_id}/tabs'].get

$.paths['/v1/groups/{group_id}/tabs'].get

$.paths['/v1/users/{user_id}/tabs'].get

$.paths['/v1/courses/{course_id}/tabs/{tab_id}'].put

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 Tabs API
  version: 1.0.0
extends: openapi/canvas-tabs-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/accounts/{account_id}/tabs'].get
  update:
    x-apievangelist-phrasing:
      intent: List navigation tabs for an account
      effect: read
      questions:
      - Which navigation links appear in an account's admin menu?
      - What tabs are available at the account level?
      instructions:
      - text: List the navigation tabs for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show account {account_id}'s menu tabs including {include}.
        slots:
          account_id: path.account_id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/tabs'].get
  update:
    x-apievangelist-phrasing:
      intent: List navigation tabs for a course
      effect: read
      questions:
      - Which items are in my course's left-hand navigation menu?
      - Can I see which course tabs are hidden from students?
      instructions:
      - text: List the navigation tabs for course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show course {course_id}'s navigation including {include}.
        slots:
          course_id: path.course_id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/groups/{group_id}/tabs'].get
  update:
    x-apievangelist-phrasing:
      intent: List navigation tabs for a group
      effect: read
      questions:
      - What navigation tabs does a student group have?
      - Which pages show in a group's menu?
      instructions:
      - text: List the navigation tabs for group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show group {group_id}'s menu tabs including {include}.
        slots:
          group_id: path.group_id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/users/{user_id}/tabs'].get
  update:
    x-apievangelist-phrasing:
      intent: List navigation tabs for a user
      effect: read
      questions:
      - What tabs show up in a user's profile navigation?
      - Which navigation links does a user's personal area have?
      instructions:
      - text: List the navigation tabs for user {user_id}.
        slots:
          user_id: path.user_id
      - text: Show user {user_id}'s menu tabs including {include}.
        slots:
          user_id: path.user_id
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/tabs/{tab_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Hide or reorder a course navigation tab
      effect: write
      questions:
      - How do I hide a tab like Discussions from my course navigation?
      - Can I move a course tab higher up in the menu?
      - Why can't I hide the Home or Settings tab?
      instructions:
      - text: Hide tab {tab_id} in course {course_id} by setting hidden to {hidden}.
        slots:
          tab_id: path.tab_id
          course_id: path.course_id
          hidden: requestBody.hidden
      - text: Move tab {tab_id} in course {course_id} to position {position}.
        slots:
          tab_id: path.tab_id
          course_id: path.course_id
          position: requestBody.position
      method: generated
      generated: '2026-10-01'