Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Course Audit Log API

3 actions 3 updates phrasing extends openapi/canvas-course-audit-log-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/audit/course/courses/{course_id}'].get

$.paths['/v1/audit/course/accounts/{account_id}'].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 Course Audit Log API
  version: 1.0.0
extends: openapi/canvas-course-audit-log-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/audit/course/courses/{course_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List change events for a course
      effect: read
      questions:
      - Who changed a course's settings, and when?
      - Can I see a course's audit log for a date range?
      instructions:
      - text: List course change events for course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show audit events for course {course_id} from {start_time} to {end_time}.
        slots:
          course_id: path.course_id
          start_time: query.start_time
          end_time: query.end_time
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/audit/course/accounts/{account_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List course change events across an account
      effect: read
      questions:
      - How do I audit course changes across a whole account?
      - Can I pull every course change event for an account in a time window?
      instructions:
      - text: List course change events for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show course audit events in account {account_id} from {start_time} to {end_time}.
        slots:
          account_id: path.account_id
          start_time: query.start_time
          end_time: query.end_time
      method: generated
      generated: '2026-10-01'