2025 API and CLI Change Log

[#1]

The Change Log Archive page displays previous API changes from 2025 noted in the API Change Log. The heading date indicates the date that the API code was made available in the production environment.

 

2025-01-29

Announcement Date: 2025-01-17

Addition

Restore a deleted authentication provider

• Reinstate a previously deleted authentication provider to active status. This option is available exclusively to admins with permission to manage account settings for the specified root account.

2025-01-10

Announcement Date: 2024-12-16

Addition

Summary:

DAP CLI version 1.3.1 addresses a bug affecting PostgreSQL users when running the syncdb command after multiple new enums were added to the DAP Query API.

Details of the Issue

• Affected Command: dap syncdb
• Cause: The bug occurred because DAP CLI’s previous dependency (pysqlsync < 0.8.1) was not equipped to handle cases where multiple new enums were added to the API at once.
• Impact: PostgreSQL users encountered errors when attempting to sync their databases using the CLI.

Resolution

• Updated the DAP CLI dependency on pysqlsync to version 0.8.1, which correctly handles multiple new enums during synchronization.
• Added a new test case to our automated test suite to cover scenarios involving multiple enum additions, ensuring this issue is caught in future releases.

How to Update

To upgrade to the latest version of DAP CLI, run the following command:

pip install -U instructure-dap-client

Or download directly from pypi.org.

2025-01-09

Announcement Date: 2024-12-16

Addition

Updates to multiple tables and columns in the Canvas namespace with new enumerated values (enums) that will be available in your (CD2) DAP Query API dataset.

1. Conversation_messages, submission_comments, submissions
   • Column: media_comment_type
     • New Values: 
       • audio/aac, audio/amr, audio/flac, audio/mp4, audio/mpeg, audio/ogg, audio/vnd.dlna.adts, audio/wav, audio/webm, audio/x-m4a, audio/x-ms-wma, audio/x-wav, video/3gpp, video/avi, video/mp4, video/mpeg, video/ogg, video/quicktime, video/webm, video/x-m4v, video/x-matroska, video/x-ms-asf, video/x-ms-wmv, video/x-msvideo
2. access_tokens
   • Column: workflow_state
     • New Value: pending
3. assignment_overrides
   • Column: set_type
     • New Value: Course
4. assignments
   • Column: workflow_state
     • New Values:
       • outcome_alignment_cloning
       • failed_to_clone_outcome_alignment
5. attachments
   • Column: file_state
     • New Values: 
       
       • public
6. developer_key_account_bindings
   • Column: workflow_state
     • New Value: deleted
7. discussion_topics
   • Column: discussion_type
     • New Value: not_threaded
8. grading_standards
   • Column: workflow_state
     • New Value: archived
9. learning_outcomes
   • Column: calculation_method
     • New Values:
       • weighted_average
       • standard_decaying_average
10. master_courses_master_content_tags
    • Column: content_type
      • New Value: MediaTrack
11. rubrics
    • Column: workflow_state
      • New Values: 
        • archived
        • draft

2025-01-18

Announcement Date: 2024-11-20

Beta Environment Availability: 2024-12-16

Addition

Quiz Reports API

• An API endpoint is added to allow the export of Item Analysis or Student Analysis reports.
  
  • POST: /quiz/v1/courses/:course_id/quizzes/:assignment_id/reports

Related Idea: [API] Student Responses to Questions in New Quizzes and Grades Received per Question