# 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 Experiences API
  version: 1.0.0
extends: openapi/canvas-canvas-career-experiences-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: 4
- target: $.paths['/v1/career/enabled'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if Canvas Career is enabled
      effect: read
      questions:
      - Is Canvas Career turned on anywhere in our root account?
      - Does any subaccount have the Horizon career experience enabled?
      instructions:
      - text: Check whether Canvas Career is enabled.
      - text: Tell me if Horizon is on for any subaccount.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/career/experience_summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Show my current and available experiences
      effect: read
      questions:
      - Which experience am I in right now, and which others can I switch to?
      - Can I see my available Canvas experiences?
      instructions:
      - text: Show my current experience and the ones I can switch to.
      - text: List the experiences available to me.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/career/switch_experience'].post
  update:
    x-apievangelist-phrasing:
      intent: Switch my active experience
      effect: write
      questions:
      - How do I switch from the academic experience to Canvas Career?
      - Can I change which experience I'm using?
      instructions:
      - text: Switch my active experience to {experience}.
        slots:
          experience: requestBody.experience
      - text: Move me into the {experience} experience.
        slots:
          experience: requestBody.experience
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/career/switch_role'].post
  update:
    x-apievangelist-phrasing:
      intent: Switch my role in the current experience
      effect: write
      questions:
      - Can I switch between learner and admin roles in my current experience?
      - How do I change my role without leaving the experience?
      instructions:
      - text: Switch my role to {role}.
        slots:
          role: requestBody.role
      - text: Change my role in this experience to {role}.
        slots:
          role: requestBody.role
      method: generated
      generated: '2026-10-01'