Pending API tasks — backend routes

This page was generated by scanning ILS-dev/backend/routes and records documentation coverage and next documentation tasks. This is a documentation-only summary — ILS-dev source is not modified.

Scanned route modules (partial list)

  • academicCalendar.js
  • adminDescribeModuleTeachingMethods.js
  • adminDescribeOutcomes.js
  • adminMigrateOutcomes.js
  • adminSeedAssessmentDescriptions.js
  • aiQuiz.js
  • apiAssignments.js
  • assignments.js
  • assessmentTypes.js
  • auth.js
  • campus.js
  • classes.js
  • cockpit.js
  • course.js
  • curriculum.js
  • events.js
  • frameworks.js
  • grading.js
  • heatmap.js
  • institution.js
  • library.js
  • matrix.js
  • module.js
  • moduleItems.js
  • moduleObjectives.js
  • outcomes.js
  • outcomeCategories.js
  • periodTemplates.js
  • periods.js
  • projects.js
  • quizz(es).js (quizzes.js)
  • reference.js
  • rubrics.js
  • student.js
  • submissionFiles.js
  • submissions (apiAssignments.js / apiAssignments)
  • timetable.js
  • theme.js
  • users.js
  • health.js

Current documentation coverage (high level)

  • Documented in this site:
  • grading.js → Developer: Grading & Submissions (developer/grading-and-submissions.md)
  • cockpit.js, heatmap.js → Developer: Cockpit & Heatmap (developer/cockpit-and-heatmap.md)
  • aiQuiz.js → Developer: AI Quiz APIs (developer/ai-quiz.md)
  • student.js → Developer: Student APIs (developer/student-apis.md)
  • moduleItems.js → Developer: Module Composition & Locking (developer/module-composition-locking.md)

  • Admin-facing: projects.js endpoints are described in Admin Guide (admin/projects.md) and the Pre‑September checklist references classes.js enroll behavior (admin/pre-september-checklist.md).

  • Not documented yet (candidates for next work):

  • events.js, curriculum.js, course.js, assignments.js, quizzes.js, reference.js, users.js, timetable.js, submissionFiles.js, projects.js (full API surface), outcomes.js, rubrics.js, library.js, matrix.js, several admin* scripts.

Top-down documentation recommendation

  1. classes.js (class lifecycle, enrollments, modules, teachers) — high priority for admin flows (enrollment + class setup).
  2. events.js and timetable.js (calendar & session generation) — next, since scheduling underpins intake flows.
  3. curriculum.js, course.js, module.js, moduleItems.js — curriculum mapping and module composition.
  4. assignments.js, apiAssignments.js, quizzes.js, submissionFiles.js — student work and submissions.
  5. projects.js, rubrics.js, outcomes.js, matrix.js — intelligence layer inputs.
  6. users.js, reference.js, auth.js — supporting APIs and admin utilities.

Next action taken

  • Documented: classes.js (see developer/classes-api.md).
  • Recommended next: events.js (calendar) — I can document it next.

If you prefer a different ordering or want me to open PRs for docs now, tell me and I'll prepare the commit/PR steps. I will not modify ILS-dev itself.

Pending Developer API Documentation Tasks

This page collects backend route files discovered in ILS-dev that either have incomplete documentation in docs/developer/api.md or are not yet referenced in the Developer Guide. It is an author-facing checklist to prioritize what to document next.

Summary of route files discovered (read-only scan):

  • adminDescribeModuleTeachingMethods.js — admin helper endpoint (priority: Low)
  • academicCalendar.js — documented (Admin page added) (priority: Done)
  • adminMigrateOutcomes.js — migration helper (priority: Low)
  • adminDescribeOutcomes.js — admin helper (priority: Low)
  • aiQuiz.js — AI-assisted quiz generation (priority: High)
  • adminSeedAssessmentDescriptions.js — seeding helper (priority: Low)
  • apiAssignments.js — assignment admin surface (priority: High)
  • assessmentTypes.js — reference data (priority: Medium)
  • classes.js — class management endpoints (priority: High)
  • campus.js — campus management (priority: Medium)
  • auth.js — auth flows (priority: High)
  • assignments.js — assignment CRUD (priority: High)
  • course.js — course CRUD (priority: Medium)
  • cockpit.js — teacher cockpit APIs (priority: High)
  • events.js — unified calendar (documented in developer/api.md) (priority: Done)
  • curriculum.js — curriculum composer endpoints (priority: High)
  • frameworks.js — reference data (priority: Medium)
  • health.js — health endpoint (priority: Low)
  • grading.js — grading API (priority: High)
  • heatmap.js — heatmap / classroom intelligence (priority: High)
  • institution.js — institution management (priority: Medium)
  • library.js — content library APIs (priority: Medium)
  • periods.js — academic periods (priority: Medium)
  • outcomes.js, outcomeCategories.js — outcomes metadata (priority: High)
  • moduleObjectives.js, moduleItems.js, module.js — module composition & sequence (priority: High)
  • matrix.js — mapping matrix (priority: Medium)
  • rubrics.js — rubric authoring (priority: High)
  • quizzes.js — quiz authoring and student attempts (priority: High)
  • projects.js — project workflows (priority: Medium)
  • periodTemplates.js — period templates (priority: Low)
  • student.js — student-facing endpoints (dashboard, my-work) (priority: High)
  • submissionFiles.js — submission file uploads/downloads (priority: High)
  • users.js — user APIs (priority: High)
  • timetable.js — timetable endpoints (priority: Low)
  • theme.js — themes metadata (priority: Medium)

Top-priority documentation tasks (authoring recommendations):

  1. Grading & Submissions (grading.js, submissionFiles.js, assignments.js) — provide request/response examples and a full grading workflow (High).
  2. Cockpit & Heatmap (cockpit.js, heatmap.js) — document payloads used by the Teacher Cockpit and Heatmap UI (High).
  3. AI Quiz (aiQuiz.js) — document the AI-assisted quiz generation inputs/outputs, safety notes, and usage examples (High).
  4. Module Composition & Locking (moduleItems.js, module.js, moduleObjectives.js) — expand the Module Composer docs with developer API examples for lock settings (High).
  5. Student APIs (student.js) — confirm and document the full Student Dashboard and my-work endpoints, include payloads (High).

How to use this page

  • Authors: pick a top-priority task, create or extend the corresponding doc page under docs/developer/ and include concrete examples (requests and responses) pulled from ILS-dev (read-only).
  • When a task is complete, mark it in this file and update Active-ILS-doc.md and the manage_todo_list tracker.

Last updated: 2026-07-08