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_auditing;
14pub mod course_credit_registrations;
15pub mod course_designer;
16pub mod course_instances;
17pub mod course_modules;
18pub mod courses;
19pub mod credit_registration_admin;
20pub mod credit_registrations;
21pub mod email_templates;
22pub mod email_verification;
23pub mod exams;
24pub mod exercise_repositories;
25pub mod exercise_services;
26pub mod exercise_slide_submissions;
27pub mod exercises;
28pub mod feedback;
29pub mod global_stats;
30pub mod glossary;
31pub mod oauth;
32pub mod org;
33pub mod organizations;
34pub mod page_audio_files;
35pub mod pages;
36pub mod playground_examples;
37pub mod playground_views;
38pub mod proposed_edits;
39pub mod regradings;
40pub mod roles;
41pub mod shared_submissions;
42pub mod status;
43pub mod teacher_grading_decisions;
44pub mod time;
45pub mod user_details;
46pub mod users;
47
48use actix_web::web::{self, ServiceConfig};
49use utoipa::OpenApi;
50
51#[derive(OpenApi)]
52#[openapi(
53    nest(
54        (path = "/certificates", api = certificates::MainFrontendCertificatesApiDoc),
55        (path = "/chapters", api = chapters::MainFrontendChaptersApiDoc),
56        (path = "/chatbot-models", api = chatbot_models::MainFrontendChatbotModelsApiDoc),
57        (path = "/chatbots", api = chatbots::MainFrontendChatbotsApiDoc),
58        (path = "/code-giveaways", api = code_giveaways::MainFrontendCodeGiveawaysApiDoc),
59        (path = "/course-auditing", api = course_auditing::MainFrontendCourseAuditingApiDoc),
60        (path = "/course-credit-registrations", api = course_credit_registrations::MainFrontendCourseCreditRegistrationsApiDoc),
61        (path = "/course-plans", api = course_designer::MainFrontendCourseDesignerApiDoc),
62        (path = "/course-instances", api = course_instances::MainFrontendCourseInstancesApiDoc),
63        (path = "/course-modules", api = course_modules::MainFrontendCourseModulesApiDoc),
64        (path = "/courses", api = courses::MainFrontendCoursesApiDoc),
65        (path = "/credit-registration-admin", api = credit_registration_admin::MainFrontendCreditRegistrationAdminApiDoc),
66        (path = "/credit-registrations", api = credit_registrations::MainFrontendCreditRegistrationsApiDoc),
67        (path = "/email-templates", api = email_templates::MainFrontendEmailTemplatesApiDoc),
68        (path = "/email-verification", api = email_verification::MainFrontendEmailVerificationApiDoc),
69        (path = "/exams", api = exams::MainFrontendExamsApiDoc),
70        (path = "/exercise-repositories", api = exercise_repositories::MainFrontendExerciseRepositoriesApiDoc),
71        (path = "/exercise-services", api = exercise_services::MainFrontendExerciseServicesApiDoc),
72        (path = "/exercise-slide-submissions", api = exercise_slide_submissions::MainFrontendExerciseSlideSubmissionsApiDoc),
73        (path = "/exercises", api = exercises::MainFrontendExercisesApiDoc),
74        (path = "/feedback", api = feedback::MainFrontendFeedbackApiDoc),
75        (path = "/global-stats", api = global_stats::MainFrontendGlobalStatsApiDoc),
76        (path = "/glossary", api = glossary::MainFrontendGlossaryApiDoc),
77        (path = "/oauth", api = oauth::MainFrontendOauthApiDoc),
78        (path = "/org", api = org::MainFrontendOrgApiDoc),
79        (path = "/organizations", api = organizations::MainFrontendOrganizationsApiDoc),
80        (path = "/page_audio", api = page_audio_files::MainFrontendPageAudioApiDoc),
81        (path = "/pages", api = pages::MainFrontendPagesApiDoc),
82        (path = "/playground_examples", api = playground_examples::MainFrontendPlaygroundExamplesApiDoc),
83        (path = "/playground-views", api = playground_views::MainFrontendPlaygroundViewsApiDoc),
84        (path = "/proposed-edits", api = proposed_edits::MainFrontendProposedEditsApiDoc),
85        (path = "/regradings", api = regradings::MainFrontendRegradingsApiDoc),
86        (path = "/roles", api = roles::MainFrontendRolesApiDoc),
87        (path = "/shared-submissions", api = shared_submissions::MainFrontendSharedSubmissionsApiDoc),
88        (path = "/status", api = status::MainFrontendStatusApiDoc),
89        (path = "/teacher-grading-decisions", api = teacher_grading_decisions::MainFrontendTeacherGradingDecisionsApiDoc),
90        (path = "/time", api = time::MainFrontendTimeApiDoc),
91        (path = "/user-details", api = user_details::MainFrontendUserDetailsApiDoc),
92        (path = "/users", api = users::MainFrontendUsersApiDoc)
93    )
94)]
95pub struct MainFrontendRoutesApiDoc;
96
97/// Add controllers from all the submodules.
98pub fn _add_routes(cfg: &mut ServiceConfig) {
99    cfg.service(web::scope("/chapters").configure(chapters::_add_routes))
100        .service(web::scope("/course-auditing").configure(course_auditing::_add_routes))
101        .service(
102            web::scope("/course-credit-registrations")
103                .configure(course_credit_registrations::_add_routes),
104        )
105        .service(web::scope("/course-instances").configure(course_instances::_add_routes))
106        .service(web::scope("/course-plans").configure(course_designer::_add_routes))
107        .service(web::scope("/course-modules").configure(course_modules::_add_routes))
108        .service(web::scope("/courses").configure(courses::_add_routes))
109        .service(
110            web::scope("/credit-registration-admin")
111                .configure(credit_registration_admin::_add_routes),
112        )
113        .service(web::scope("/credit-registrations").configure(credit_registrations::_add_routes))
114        .service(web::scope("/email-templates").configure(email_templates::_add_routes))
115        .service(web::scope("/email-verification").configure(email_verification::_add_routes))
116        .service(web::scope("/exercises").configure(exercises::_add_routes))
117        .service(web::scope("/feedback").configure(feedback::_add_routes))
118        .service(web::scope("/org").configure(org::_add_routes))
119        .service(web::scope("/organizations").configure(organizations::_add_routes))
120        .service(web::scope("/pages").configure(pages::_add_routes))
121        .service(
122            web::scope("/exercise-slide-submissions")
123                .configure(exercise_slide_submissions::_add_routes),
124        )
125        .service(web::scope("/proposed-edits").configure(proposed_edits::_add_routes))
126        .service(web::scope("/exercise-services").configure(exercise_services::_add_routes))
127        .service(web::scope("/playground_examples").configure(playground_examples::_add_routes))
128        .service(web::scope("/users").configure(users::_add_routes))
129        .service(web::scope("/exams").configure(exams::_add_routes))
130        .service(web::scope("/glossary").configure(glossary::_add_routes))
131        .service(web::scope("/roles").configure(roles::_add_routes))
132        .service(web::scope("/exercise-repositories").configure(exercise_repositories::_add_routes))
133        .service(web::scope("/regradings").configure(regradings::_add_routes))
134        .service(web::scope("/playground-views").configure(playground_views::_add_routes))
135        .service(web::scope("/page_audio").configure(page_audio_files::_add_routes))
136        .service(web::scope("/user-details").configure(user_details::_add_routes))
137        .service(web::scope("/certificates").configure(certificates::_add_routes))
138        .service(web::scope("/global-stats").configure(global_stats::_add_routes))
139        .service(
140            web::scope("/teacher-grading-decisions")
141                .configure(teacher_grading_decisions::_add_routes),
142        )
143        .service(web::scope("/code-giveaways").configure(code_giveaways::_add_routes))
144        .service(web::scope("/oauth").configure(oauth::_add_routes))
145        .service(web::scope("/chatbots").configure(chatbots::_add_routes))
146        .service(web::scope("/chatbot-models").configure(chatbot_models::_add_routes))
147        .service(web::scope("/time").configure(time::_add_routes))
148        .service(web::scope("/shared-submissions").configure(shared_submissions::_add_routes))
149        .service(web::scope("/status").configure(status::_add_routes));
150}