Skip to main content

headless_lms_server/controllers/main_frontend/
mod.rs

1/*!
2Handlers for HTTP requests to `/api/v0/main_frontend`.
3
4This documents all endpoints. Select a module below for a category.
5
6*/
7
8pub mod certificates;
9pub mod chapters;
10pub mod chatbot_models;
11pub mod chatbots;
12pub mod code_giveaways;
13pub mod course_designer;
14pub mod course_instances;
15pub mod course_modules;
16pub mod courses;
17pub mod email_templates;
18pub mod email_verification;
19pub mod exams;
20pub mod exercise_repositories;
21pub mod exercise_services;
22pub mod exercise_slide_submissions;
23pub mod exercises;
24pub mod feedback;
25pub mod global_stats;
26pub mod glossary;
27pub mod oauth;
28pub mod org;
29pub mod organizations;
30pub mod page_audio_files;
31pub mod pages;
32pub mod playground_examples;
33pub mod playground_views;
34pub mod proposed_edits;
35pub mod regradings;
36pub mod roles;
37pub mod status;
38pub mod teacher_grading_decisions;
39pub mod time;
40pub mod user_details;
41pub mod users;
42
43use actix_web::web::{self, ServiceConfig};
44use utoipa::OpenApi;
45
46#[derive(OpenApi)]
47#[openapi(
48    nest(
49        (path = "/certificates", api = certificates::MainFrontendCertificatesApiDoc),
50        (path = "/chapters", api = chapters::MainFrontendChaptersApiDoc),
51        (path = "/chatbot-models", api = chatbot_models::MainFrontendChatbotModelsApiDoc),
52        (path = "/chatbots", api = chatbots::MainFrontendChatbotsApiDoc),
53        (path = "/code-giveaways", api = code_giveaways::MainFrontendCodeGiveawaysApiDoc),
54        (path = "/course-plans", api = course_designer::MainFrontendCourseDesignerApiDoc),
55        (path = "/course-instances", api = course_instances::MainFrontendCourseInstancesApiDoc),
56        (path = "/course-modules", api = course_modules::MainFrontendCourseModulesApiDoc),
57        (path = "/courses", api = courses::MainFrontendCoursesApiDoc),
58        (path = "/email-templates", api = email_templates::MainFrontendEmailTemplatesApiDoc),
59        (path = "/email-verification", api = email_verification::MainFrontendEmailVerificationApiDoc),
60        (path = "/exams", api = exams::MainFrontendExamsApiDoc),
61        (path = "/exercise-repositories", api = exercise_repositories::MainFrontendExerciseRepositoriesApiDoc),
62        (path = "/exercise-services", api = exercise_services::MainFrontendExerciseServicesApiDoc),
63        (path = "/exercise-slide-submissions", api = exercise_slide_submissions::MainFrontendExerciseSlideSubmissionsApiDoc),
64        (path = "/exercises", api = exercises::MainFrontendExercisesApiDoc),
65        (path = "/feedback", api = feedback::MainFrontendFeedbackApiDoc),
66        (path = "/global-stats", api = global_stats::MainFrontendGlobalStatsApiDoc),
67        (path = "/glossary", api = glossary::MainFrontendGlossaryApiDoc),
68        (path = "/oauth", api = oauth::MainFrontendOauthApiDoc),
69        (path = "/org", api = org::MainFrontendOrgApiDoc),
70        (path = "/organizations", api = organizations::MainFrontendOrganizationsApiDoc),
71        (path = "/page_audio", api = page_audio_files::MainFrontendPageAudioApiDoc),
72        (path = "/pages", api = pages::MainFrontendPagesApiDoc),
73        (path = "/playground_examples", api = playground_examples::MainFrontendPlaygroundExamplesApiDoc),
74        (path = "/playground-views", api = playground_views::MainFrontendPlaygroundViewsApiDoc),
75        (path = "/proposed-edits", api = proposed_edits::MainFrontendProposedEditsApiDoc),
76        (path = "/regradings", api = regradings::MainFrontendRegradingsApiDoc),
77        (path = "/roles", api = roles::MainFrontendRolesApiDoc),
78        (path = "/status", api = status::MainFrontendStatusApiDoc),
79        (path = "/teacher-grading-decisions", api = teacher_grading_decisions::MainFrontendTeacherGradingDecisionsApiDoc),
80        (path = "/time", api = time::MainFrontendTimeApiDoc),
81        (path = "/user-details", api = user_details::MainFrontendUserDetailsApiDoc),
82        (path = "/users", api = users::MainFrontendUsersApiDoc)
83    )
84)]
85pub struct MainFrontendRoutesApiDoc;
86
87/// Add controllers from all the submodules.
88pub fn _add_routes(cfg: &mut ServiceConfig) {
89    cfg.service(web::scope("/chapters").configure(chapters::_add_routes))
90        .service(web::scope("/course-instances").configure(course_instances::_add_routes))
91        .service(web::scope("/course-plans").configure(course_designer::_add_routes))
92        .service(web::scope("/course-modules").configure(course_modules::_add_routes))
93        .service(web::scope("/courses").configure(courses::_add_routes))
94        .service(web::scope("/email-templates").configure(email_templates::_add_routes))
95        .service(web::scope("/email-verification").configure(email_verification::_add_routes))
96        .service(web::scope("/exercises").configure(exercises::_add_routes))
97        .service(web::scope("/feedback").configure(feedback::_add_routes))
98        .service(web::scope("/org").configure(org::_add_routes))
99        .service(web::scope("/organizations").configure(organizations::_add_routes))
100        .service(web::scope("/pages").configure(pages::_add_routes))
101        .service(
102            web::scope("/exercise-slide-submissions")
103                .configure(exercise_slide_submissions::_add_routes),
104        )
105        .service(web::scope("/proposed-edits").configure(proposed_edits::_add_routes))
106        .service(web::scope("/exercise-services").configure(exercise_services::_add_routes))
107        .service(web::scope("/playground_examples").configure(playground_examples::_add_routes))
108        .service(web::scope("/users").configure(users::_add_routes))
109        .service(web::scope("/exams").configure(exams::_add_routes))
110        .service(web::scope("/glossary").configure(glossary::_add_routes))
111        .service(web::scope("/roles").configure(roles::_add_routes))
112        .service(web::scope("/exercise-repositories").configure(exercise_repositories::_add_routes))
113        .service(web::scope("/regradings").configure(regradings::_add_routes))
114        .service(web::scope("/playground-views").configure(playground_views::_add_routes))
115        .service(web::scope("/page_audio").configure(page_audio_files::_add_routes))
116        .service(web::scope("/user-details").configure(user_details::_add_routes))
117        .service(web::scope("/certificates").configure(certificates::_add_routes))
118        .service(web::scope("/global-stats").configure(global_stats::_add_routes))
119        .service(
120            web::scope("/teacher-grading-decisions")
121                .configure(teacher_grading_decisions::_add_routes),
122        )
123        .service(web::scope("/code-giveaways").configure(code_giveaways::_add_routes))
124        .service(web::scope("/oauth").configure(oauth::_add_routes))
125        .service(web::scope("/chatbots").configure(chatbots::_add_routes))
126        .service(web::scope("/chatbot-models").configure(chatbot_models::_add_routes))
127        .service(web::scope("/time").configure(time::_add_routes))
128        .service(web::scope("/status").configure(status::_add_routes));
129}