Skip to content

Update docs for course start/end date fields #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
freyazjiner wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update docs for course start/end date fields #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb39f4b
Update documentation for course start/end date fields
freyazjiner Jan 15, 2026
3dee88b
add start_at and end_at to PUT /api/courses/:id
freyazjiner Jan 15, 2026
bfab2f7
update with valid datetime inputs
freyazjiner Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Instructor-Guide--Course-Settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
10 changes: 8 additions & 2 deletions RESTful-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": "2026-01-05T00:00:00.000-05:00",
"end_at": "2026-04-27T00:00:00.000-04:00"
}
]
```
Expand Down Expand Up @@ -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": "2026-01-05T00:00:00.000-05:00",
"end_at": "2026-04-27T00:00:00.000-04:00"
}
```

Expand All @@ -248,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

Expand Down