Canvas · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Canvas LMS REST Lti Resource Links API

7 actions 7 updates phrasing extends openapi/canvas-lti-resource-links-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 7

$.info
$.paths['/v1/courses/{course_id}/lti_resource_links'].get
$.paths['/v1/courses/{course_id}/lti_resource_links'].post
$.paths['/v1/courses/{course_id}/lti_resource_links/{id}'].get
$.paths['/v1/courses/{course_id}/lti_resource_links/{id}'].put
$.paths['/v1/courses/{course_id}/lti_resource_links/{id}'].delete
$.paths['/v1/courses/{course_id}/lti_resource_links/bulk'].post

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 Lti Resource Links API
  version: 1.0.0
extends: openapi/canvas-lti-resource-links-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: 6
- target: $.paths['/v1/courses/{course_id}/lti_resource_links'].get
  update:
    x-apievangelist-phrasing:
      intent: List a course's LTI resource links
      effect: read
      questions:
      - Which LTI tool links exist in my course, including ones embedded in pages?
      - Can I include deleted LTI resource links when listing a course's links?
      instructions:
      - text: List the LTI resource links in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Show course {course_id} LTI resource links, {per_page} per page, including deleted ones.
        slots:
          course_id: path.course_id
          per_page: query.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/lti_resource_links'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an LTI resource link in a course
      effect: write
      questions:
      - Can I create an LTI resource link manually instead of through deep linking?
      - What's the risk of making an LTI resource link the tool doesn't know about?
      instructions:
      - text: Create an LTI resource link to {url} in course {course_id}.
        slots:
          url: requestBody.url
          course_id: path.course_id
      - text: Add a resource link titled {title} pointing at {url} in course {course_id}.
        slots:
          title: requestBody.title
          url: requestBody.url
          course_id: path.course_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/lti_resource_links/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an LTI resource link
      effect: read
      questions:
      - Can I look up an LTI resource link by its resource_link_uuid instead of its id?
      - What URL and custom parameters does a given LTI resource link use?
      instructions:
      - text: Show LTI resource link {id} in course {course_id}.
        slots:
          id: path.id
          course_id: path.course_id
      - text: Get the details of course {course_id} resource link {id}, even if deleted.
        slots:
          course_id: path.course_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/lti_resource_links/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an LTI resource link
      effect: write
      questions:
      - Can changing an LTI resource link's URL break tool launches?
      - How do I move an LTI resource link to a different external tool?
      instructions:
      - text: Change the URL of LTI resource link {id} in course {course_id} to {url}.
        slots:
          id: path.id
          course_id: path.course_id
          url: requestBody.url
      - text: Point course {course_id} resource link {id} at external tool {context_external_tool_id}.
        slots:
          course_id: path.course_id
          id: path.id
          context_external_tool_id: requestBody.context_external_tool_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/lti_resource_links/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an LTI resource link
      effect: destructive
      questions:
      - How do I remove an LTI resource link from a course?
      - Can I delete a resource link using its lookup_uuid?
      instructions:
      - text: Delete LTI resource link {id} from course {course_id}.
        slots:
          id: path.id
          course_id: path.course_id
      - text: Remove the course {course_id} tool link {id}.
        slots:
          course_id: path.course_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/courses/{course_id}/lti_resource_links/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Create up to 100 LTI resource links at once
      effect: write
      questions:
      - Can I create many LTI resource links in a course with one request?
      - What's the maximum number of LTI resource links I can bulk create?
      instructions:
      - text: Bulk create LTI resource links in course {course_id}.
        slots:
          course_id: path.course_id
      - text: Create a batch of up to 100 tool links in course {course_id}, starting with {url}.
        slots:
          course_id: path.course_id
          url: requestBody.url
      method: generated
      generated: '2026-10-01'