diff --git a/docs/company/admin/admin.HR.go.md b/docs/company/admin/admin.HR.go.md index a4fff1b..50abac9 100644 --- a/docs/company/admin/admin.HR.go.md +++ b/docs/company/admin/admin.HR.go.md @@ -1,8 +1,8 @@ --- -title: company HR handler functions admin side -layout: home -nav_order: 5 -has_children: true +title: admin.HR +layout: dafault +nav_order: 3 +parent: company --- # admin.HR.go diff --git a/docs/company/admin/admin.company.go.md b/docs/company/admin/admin.company.go.md index 4f93d9e..a2794fa 100644 --- a/docs/company/admin/admin.company.go.md +++ b/docs/company/admin/admin.company.go.md @@ -1,9 +1,10 @@ --- -title: company handler functions admin side -layout: home -nav_order: 5 -has_children: true +title: admin.company +layout: dafault +nav_order: 1 +parent: company --- + # admin.company.go This file contains handler functions to add,update and delete requests for companies. diff --git a/docs/company/admin/admin.get_company.go..md b/docs/company/admin/admin.get_company.go..md index 0cfd206..55c97c7 100644 --- a/docs/company/admin/admin.get_company.go..md +++ b/docs/company/admin/admin.get_company.go..md @@ -1,8 +1,8 @@ --- -title: get company handler functions admin side -layout: home -nav_order: 5 -has_children: true +title: admin.get_company +layout: dafault +nav_order: 2 +parent: company --- ## admin.get_company.go diff --git a/docs/company/company.md b/docs/company/company.md new file mode 100644 index 0000000..295c7d9 --- /dev/null +++ b/docs/company/company.md @@ -0,0 +1,9 @@ +--- +title: Application +layout: default +nav_order : 4 +has_children: true +--- +Application +--- +* Logic for the company package diff --git a/docs/company/company/company.hr.go.md b/docs/company/company/company.hr.go.md index 375253b..4a666d2 100644 --- a/docs/company/company/company.hr.go.md +++ b/docs/company/company/company.hr.go.md @@ -1,8 +1,8 @@ --- -title: company HR handler functions company side -layout: home -nav_order: 5 -has_children: true +title: company.hr +layout: dafault +nav_order: 1 +parent: company --- # company.hr.go diff --git a/docs/rc/admin/admin.answers.go.md b/docs/rc/admin/admin.answers.go.md index 7dc5f70..f64069e 100644 --- a/docs/rc/admin/admin.answers.go.md +++ b/docs/rc/admin/admin.answers.go.md @@ -1,8 +1,9 @@ --- -title: RC Admin-Student-Answers handler functions -layout: home -nav_order: 5 -has_children: true +title: admin.answers +layout: dafault +nav_order: 1 +parent: admin +grand_parent: rc --- # admin.answers.go diff --git a/docs/rc/admin/admin.clarification.go.md b/docs/rc/admin/admin.clarification.go.md index 4b40981..f95da33 100644 --- a/docs/rc/admin/admin.clarification.go.md +++ b/docs/rc/admin/admin.clarification.go.md @@ -1,8 +1,9 @@ --- -title: RC Admin-clarification handler funciton -layout: home -nav_order: 5 -has_children: true +title: admin.clarification +layout: dafault +nav_order: 2 +parent: admin +grand_parent: rc --- # admin.clarification.go diff --git a/docs/rc/admin/admin.company.go.md b/docs/rc/admin/admin.company.go.md index 9e01e52..9b57834 100644 --- a/docs/rc/admin/admin.company.go.md +++ b/docs/rc/admin/admin.company.go.md @@ -1,8 +1,9 @@ --- -title: RC Admin-Company handler functions -layout: home -nav_order: 5 -has_children: true +title: admin.company +layout: default +nav_order: 3 +parent: admin +grand_parent: rc --- # admin.company.go diff --git a/docs/rc/admin/admin.count.go.md b/docs/rc/admin/admin.count.go.md index 9590193..8e4271b 100644 --- a/docs/rc/admin/admin.count.go.md +++ b/docs/rc/admin/admin.count.go.md @@ -1,8 +1,9 @@ --- -title: RC count handler function -layout: home -nav_order: 5 -has_children: true +title: admin.count +layout: dafault +nav_order: 4 +parent: admin +grand_parent: rc --- # admin.count.go diff --git a/docs/rc/admin/admin.md b/docs/rc/admin/admin.md new file mode 100644 index 0000000..7800c6d --- /dev/null +++ b/docs/rc/admin/admin.md @@ -0,0 +1,8 @@ +--- +title: Admin +layout: default +nav_order: 1 +parent: rc +has_children: true +--- +* It contains all the admin logic required for rc \ No newline at end of file diff --git a/docs/rc/admin/admin.notice.go.md b/docs/rc/admin/admin.notice.go.md index e16ab01..78e58bc 100644 --- a/docs/rc/admin/admin.notice.go.md +++ b/docs/rc/admin/admin.notice.go.md @@ -1,8 +1,9 @@ --- -title: RC Notices handler functions -layout: home +title: admin.notice +layout: dafault nav_order: 5 -has_children: true +parent: admin +grand_parent: rc --- # admin.notice.go diff --git a/docs/rc/admin/admin.question.go.md b/docs/rc/admin/admin.question.go.md index 0ac681b..fd93c37 100644 --- a/docs/rc/admin/admin.question.go.md +++ b/docs/rc/admin/admin.question.go.md @@ -1,8 +1,9 @@ --- -title: RC Admin-Student-Question handler functions -layout: home -nav_order: 5 -has_children: true +title: admin.question +layout: dafault +nav_order: 6 +parent: admin +grand_parent: rc --- # admin.question.go diff --git a/docs/rc/admin/admin.rc.go.md b/docs/rc/admin/admin.rc.go.md index 6adacff..2309227 100644 --- a/docs/rc/admin/admin.rc.go.md +++ b/docs/rc/admin/admin.rc.go.md @@ -1,8 +1,9 @@ --- -title: RC -layout: home -nav_order: 5 -has_children: true +title: admin.rc +layout: dafault +nav_order: 7 +parent: admin +grand_parent: rc --- # admin.rc.go diff --git a/docs/rc/admin/admin.resume.go.md b/docs/rc/admin/admin.resume.go.md index 8eaa1fe..3a817ed 100644 --- a/docs/rc/admin/admin.resume.go.md +++ b/docs/rc/admin/admin.resume.go.md @@ -1,8 +1,9 @@ --- -title: RC Admin-Resume handler functions -layout: home -nav_order: 5 -has_children: true +title: admin.resume +layout: dafault +nav_order: 8 +parent: admin +grand_parent: rc --- # admin.resume.go diff --git a/docs/rc/admin/admin.student.go.md b/docs/rc/admin/admin.student.go.md index 61d707a..2c69e64 100644 --- a/docs/rc/admin/admin.student.go.md +++ b/docs/rc/admin/admin.student.go.md @@ -1,8 +1,9 @@ --- -title: RC Admin-Student handler functions -layout: home -nav_order: 5 -has_children: true +title: admin.student +layout: dafault +nav_order: 9 +parent: admin +grand_parent: rc --- # admin.student.go diff --git a/docs/rc/company/company.info.go.md b/docs/rc/company/company.info.go.md index 73cc93b..3b3a71a 100644 --- a/docs/rc/company/company.info.go.md +++ b/docs/rc/company/company.info.go.md @@ -1,8 +1,9 @@ --- -title: RC company info handler fucntions -layout: home -nav_order: 5 -has_children: true +title: company.info +layout: dafault +nav_order: 1 +parent: company +grand_parent: rc --- # company.info.go diff --git a/docs/rc/company/company.md b/docs/rc/company/company.md new file mode 100644 index 0000000..6fbe78c --- /dev/null +++ b/docs/rc/company/company.md @@ -0,0 +1,8 @@ +--- +title: Company +layout: default +nav_order: 2 +parent: rc +has_children: true +--- +* It contains all the company logic required for rc \ No newline at end of file diff --git a/docs/rc/company/company.rc.go.md b/docs/rc/company/company.rc.go.md index 35c1ebb..5519034 100644 --- a/docs/rc/company/company.rc.go.md +++ b/docs/rc/company/company.rc.go.md @@ -1,8 +1,9 @@ --- -title: RC company handler fucntions -layout: home -nav_order: 5 -has_children: true +title: company.rc +layout: dafault +nav_order: 1 +parent: company +grand_parent: rc --- # company.rc.go diff --git a/docs/rc/overview.md b/docs/rc/overview.md index 174aab5..218d37d 100644 --- a/docs/rc/overview.md +++ b/docs/rc/overview.md @@ -1,2 +1,10 @@ +--- +title : overview +layout : default +nav_order: 1 +parent : rc +--- # RC - Recruitment Cycle +RC contains logic for various functionalities associated with the recruitment cycle which are used by the admin, company and student servers. + diff --git a/docs/rc/rc.md b/docs/rc/rc.md new file mode 100644 index 0000000..d775b38 --- /dev/null +++ b/docs/rc/rc.md @@ -0,0 +1,9 @@ +--- +title: RC +layout: default +nav_order : 5 +has_children: true +--- +Application +--- +* Contains the functions required for an application diff --git a/docs/rc/routers.md b/docs/rc/routers.md index 9e06f86..656f30b 100644 --- a/docs/rc/routers.md +++ b/docs/rc/routers.md @@ -1,13 +1,15 @@ --- -title: Company -layout: home -nav_order: 5 -has_children: true +title : router +layout : default +nav_order: 2 +parent : admin --- -# student.rc.go +# router.go -## function getStudentRCHandler +This file declares the API routes and attaches middlewares related to rc to the adminRCServer, studentRCServer, companyRCServer. +Backend API documentation: [https://ras-docs.netlify.app/] -## function studentWhoamiHandler -returns student information of the requested recruitment cycle. +The middlewares attached to these servers are: +[rc util util.active_rc.middleware]() +[rc util util.student.middleware]() \ No newline at end of file diff --git a/docs/rc/student/student.enrollment.go.md b/docs/rc/student/student.enrollment.go.md index b9c43b6..4ccbc8a 100644 --- a/docs/rc/student/student.enrollment.go.md +++ b/docs/rc/student/student.enrollment.go.md @@ -1,8 +1,9 @@ --- -title: RC student enrollment handler fucntions -layout: home -nav_order: 5 -has_children: true +title: student.enrollment +layout: dafault +nav_order: 1 +parent: student +grand_parent: rc --- # student.enrollment.go diff --git a/docs/rc/student/student.md b/docs/rc/student/student.md new file mode 100644 index 0000000..c9b563e --- /dev/null +++ b/docs/rc/student/student.md @@ -0,0 +1,8 @@ +--- +title: Student +layout: default +nav_order: 3 +parent: rc +has_children: true +--- +* It contains all the student logic required for rc \ No newline at end of file diff --git a/docs/rc/student/student.notice.go.md b/docs/rc/student/student.notice.go.md index c6ef906..89fb838 100644 --- a/docs/rc/student/student.notice.go.md +++ b/docs/rc/student/student.notice.go.md @@ -1,8 +1,9 @@ --- -title: RC student notices handler fucntions -layout: home -nav_order: 5 -has_children: true +title: student.notice +layout: dafault +nav_order: 2 +parent: student +grand_parent: rc --- # student.notice.go diff --git a/docs/rc/student/student.rc.go.md b/docs/rc/student/student.rc.go.md index 157a4d4..11357b1 100644 --- a/docs/rc/student/student.rc.go.md +++ b/docs/rc/student/student.rc.go.md @@ -1,8 +1,9 @@ --- -title: RC student handler functions -layout: home -nav_order: 5 -has_children: true +title: student.rc +layout: dafault +nav_order: 3 +parent: student +grand_parent: rc --- # student.rc.go diff --git a/docs/rc/student/student.resume.go.md b/docs/rc/student/student.resume.go.md index 7416fac..94b853c 100644 --- a/docs/rc/student/student.resume.go.md +++ b/docs/rc/student/student.resume.go.md @@ -1,8 +1,9 @@ --- -title: RC student resume handler fucntions -layout: home -nav_order: 5 -has_children: true +title: student.resume +layout: dafault +nav_order: 4 +parent: student +grand_parent: rc --- # student.resume.go diff --git a/docs/rc/util/util.active_rc.middleware.md b/docs/rc/util/util.active_rc.middleware.md new file mode 100644 index 0000000..20ab892 --- /dev/null +++ b/docs/rc/util/util.active_rc.middleware.md @@ -0,0 +1,15 @@ +--- +title: util.active_rc.middleware +layout: dafault +nav_order: 4 +parent: util +grand_parent: rc +--- + +# util.active_rc.middleware + +## function checkAdminAccessToRC +Middleware for the adminRCServer. Restricts the access of inactive RCs to admin roles other than 100 & 101. + +## function checkIsActiveRC +utility function to check if an RC is active or not. \ No newline at end of file diff --git a/docs/rc/util/util.company_id.md b/docs/rc/util/util.company_id.md new file mode 100644 index 0000000..c9ad18b --- /dev/null +++ b/docs/rc/util/util.company_id.md @@ -0,0 +1,12 @@ +--- +title: util.company_id +layout: dafault +nav_order: 2 +parent: util +grand_parent: rc +--- + +# util.company_id + +## function extractCompanyID +Utility function to fetch company ID for the given company HR email. \ No newline at end of file diff --git a/docs/rc/util/util.md b/docs/rc/util/util.md new file mode 100644 index 0000000..db18491 --- /dev/null +++ b/docs/rc/util/util.md @@ -0,0 +1,8 @@ +--- +title: Util +layout: default +nav_order: 1 +parent: rc +has_children: true +--- +* It contains utility functions and middlewares for rc \ No newline at end of file diff --git a/docs/rc/util/util.student.middleware.md b/docs/rc/util/util.student.middleware.md new file mode 100644 index 0000000..526b66f --- /dev/null +++ b/docs/rc/util/util.student.middleware.md @@ -0,0 +1,15 @@ +--- +title: util.student.middleware +layout: dafault +nav_order: 3 +parent: util +grand_parent: rc +--- + +# util.student.middleware + +## function ensureActiveStudent +middleware for the studentRCServer. Ensures that the student is active before passing the request to handlers. + +## function getStudentRCID +utility function to get rcid from the request context. \ No newline at end of file diff --git a/docs/rc/util/util.student_id.md b/docs/rc/util/util.student_id.md new file mode 100644 index 0000000..ee3e50e --- /dev/null +++ b/docs/rc/util/util.student_id.md @@ -0,0 +1,12 @@ +--- +title: util.student_id +layout: dafault +nav_order: 1 +parent: util +grand_parent: rc +--- + +# util.student_id + +## function extractStudentRCID +Utility function to fetch student details from a rc and student's email. Throws error if the student is frozen that is out of that rc. \ No newline at end of file diff --git a/docs/student/admin/admin.delete.go.md b/docs/student/admin/admin.delete.go.md index 3589fd7..5aa156f 100644 --- a/docs/student/admin/admin.delete.go.md +++ b/docs/student/admin/admin.delete.go.md @@ -1,8 +1,8 @@ --- -title: student delete handler function admin side -layout: home -nav_order: 5 -has_children: true +title: admin.delete +layout: dafault +nav_order: 1 +parent: student --- # admin.delete.go diff --git a/docs/student/admin/admin.student.go.md b/docs/student/admin/admin.student.go.md index 23a7218..8d871b4 100644 --- a/docs/student/admin/admin.student.go.md +++ b/docs/student/admin/admin.student.go.md @@ -1,8 +1,8 @@ --- -title: student get handler function admin side -layout: home -nav_order: 5 -has_children: true +title: admin.student +layout: dafault +nav_order: 2 +parent: student --- # admin.student.go diff --git a/docs/student/admin/admin.update.go.md b/docs/student/admin/admin.update.go.md index 8ffacdf..5c814fc 100644 --- a/docs/student/admin/admin.update.go.md +++ b/docs/student/admin/admin.update.go.md @@ -1,8 +1,8 @@ --- -title: student update handler function admin side -layout: home -nav_order: 5 -has_children: true +title: admin.update +layout: dafault +nav_order: 3 +parent: student --- # admin.update.go diff --git a/docs/student/student.md b/docs/student/student.md new file mode 100644 index 0000000..414517e --- /dev/null +++ b/docs/student/student.md @@ -0,0 +1,9 @@ +--- +title: Student +layout: default +nav_order : 7 +has_children: true +--- +Application +--- +* Logic for the student package diff --git a/docs/student/student/student.get.go.md b/docs/student/student/student.get.go.md index 527e625..67e79d1 100644 --- a/docs/student/student/student.get.go.md +++ b/docs/student/student/student.get.go.md @@ -1,8 +1,8 @@ --- -title: student get handler function student side -layout: home -nav_order: 5 -has_children: true +title: student.get +layout: dafault +nav_order: 1 +parent: student --- # student.get.go diff --git a/docs/student/student/student.update.go.md b/docs/student/student/student.update.go.md index 12dedf2..944e771 100644 --- a/docs/student/student/student.update.go.md +++ b/docs/student/student/student.update.go.md @@ -1,8 +1,8 @@ --- -title: student update handler function student side -layout: home -nav_order: 5 -has_children: true +title: student.update +layout: dafault +nav_order: 1 +parent: student --- # student.update.go