From eb39f4bc503e41353bce0eaced628382df31050c Mon Sep 17 00:00:00 2001 From: freyazjiner Date: Thu, 15 Jan 2026 17:52:48 -0500 Subject: [PATCH 1/3] Update documentation for course start/end date fields --- Instructor-Guide--Course-Settings.md | 2 ++ RESTful-API.md | 8 ++++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/Instructor-Guide--Course-Settings.md b/Instructor-Guide--Course-Settings.md index 8b712a9..30ed498 100644 --- a/Instructor-Guide--Course-Settings.md +++ b/Instructor-Guide--Course-Settings.md @@ -7,5 +7,7 @@ The course settings page provides information on the name, display name and cour - **Name**: The name or course code for this course. - **Display Name**: A longer course name or title for users to see. - **Course Visibility**: A toggle that determines whether students can see and access the course. Selecting "hidden" will prevent students from being able to view and access the course. To unhide a course from students, you may do so by setting the course as "visible". Graders and instructors for the course can still see and manage the course as usual. +- **Start Date**: The date and time the course starts. Visible to all course members. Only editable by admins. +- **End Date**: The date and time the course ends. Visible to all course members. Only editable by admins. > :spiral_notepad: **Note:** While you cannot change the name of a course, you are free to change its display name or toggle its visibility. diff --git a/RESTful-API.md b/RESTful-API.md index 6234a82..cb19018 100644 --- a/RESTful-API.md +++ b/RESTful-API.md @@ -205,7 +205,9 @@ NOTE: this method is only available to AdminUser users "id": 1, "name": "course1", "is_hidden": false, - "display_name": "a longer course name to display in the UI" + "display_name": "a longer course name to display in the UI", + "start_at": null, + "end_at": null } ] ``` @@ -235,7 +237,9 @@ NOTE: this method is only available to AdminUser users "id": 1, "name": "course1", "is_hidden": false, - "display_name": "a longer course name to display in the UI" + "display_name": "a longer course name to display in the UI", + "start_at": null, + "end_at": null } ``` From 3dee88b7bd6cb84edbc02d997b64a0cab8247ee7 Mon Sep 17 00:00:00 2001 From: freyazjiner Date: Thu, 15 Jan 2026 17:56:31 -0500 Subject: [PATCH 2/3] add start_at and end_at to PUT /api/courses/:id --- RESTful-API.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/RESTful-API.md b/RESTful-API.md index cb19018..ed0bbc3 100644 --- a/RESTful-API.md +++ b/RESTful-API.md @@ -252,6 +252,8 @@ NOTE: If not an AdminUser, this will only return courses where the current user - name (string) - is_hidden (boolean) - display_name (string) + - start_at (datetime) + - end_at (datetime) NOTE: this method is only available to AdminUser users From bfab2f7fc3546ff5250d83f0ce3feabe2b378ded Mon Sep 17 00:00:00 2001 From: freyazjiner Date: Tue, 20 Jan 2026 13:06:10 -0500 Subject: [PATCH 3/3] update with valid datetime inputs --- RESTful-API.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/RESTful-API.md b/RESTful-API.md index ed0bbc3..3716772 100644 --- a/RESTful-API.md +++ b/RESTful-API.md @@ -206,8 +206,8 @@ NOTE: this method is only available to AdminUser users "name": "course1", "is_hidden": false, "display_name": "a longer course name to display in the UI", - "start_at": null, - "end_at": null + "start_at": "2026-01-05T00:00:00.000-05:00", + "end_at": "2026-04-27T00:00:00.000-04:00" } ] ``` @@ -238,8 +238,8 @@ NOTE: this method is only available to AdminUser users "name": "course1", "is_hidden": false, "display_name": "a longer course name to display in the UI", - "start_at": null, - "end_at": null + "start_at": "2026-01-05T00:00:00.000-05:00", + "end_at": "2026-04-27T00:00:00.000-04:00" } ```