Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Canvas Career User Context API

2 actions 2 updates phrasing extends openapi/canvas-canvas-career-user-context-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 2

$.info
$.paths['/v1/career/user_context'].get

OpenAPI Overlay

Raw ↑ 
# 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 Canvas Career User Context API
  version: 1.0.0
extends: openapi/canvas-canvas-career-user-context-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: 1
- target: $.paths['/v1/career/user_context'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my Career user context
      effect: read
      questions:
      - What permissions, enrollment types and admin roles does my user have for Journey?
      - Can I get the career user context scoped to one account?
      instructions:
      - text: Get my career user context.
      - text: Get my career user context for account {account_id}.
        slots:
          account_id: query.account_id
      method: generated
      generated: '2026-10-01'