Skip to content

fixed doc tree + added rc middlewares #6

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.

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/company/admin/admin.HR.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
9 changes: 5 additions & 4 deletions docs/company/admin/admin.company.go.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
8 changes: 4 additions & 4 deletions docs/company/admin/admin.get_company.go..md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
9 changes: 9 additions & 0 deletions docs/company/company.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Application
layout: default
nav_order : 4
has_children: true
---
Application
---
* Logic for the company package
8 changes: 4 additions & 4 deletions docs/company/company/company.hr.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
9 changes: 5 additions & 4 deletions docs/rc/admin/admin.answers.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
9 changes: 5 additions & 4 deletions docs/rc/admin/admin.clarification.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
9 changes: 5 additions & 4 deletions docs/rc/admin/admin.company.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
9 changes: 5 additions & 4 deletions docs/rc/admin/admin.count.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
8 changes: 8 additions & 0 deletions docs/rc/admin/admin.md
Original file line number Diff line number Diff line change
@@ -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
7 changes: 4 additions & 3 deletions docs/rc/admin/admin.notice.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
9 changes: 5 additions & 4 deletions docs/rc/admin/admin.question.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
9 changes: 5 additions & 4 deletions docs/rc/admin/admin.rc.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
9 changes: 5 additions & 4 deletions docs/rc/admin/admin.resume.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
9 changes: 5 additions & 4 deletions docs/rc/admin/admin.student.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
9 changes: 5 additions & 4 deletions docs/rc/company/company.info.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
8 changes: 8 additions & 0 deletions docs/rc/company/company.md
Original file line number Diff line number Diff line change
@@ -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
9 changes: 5 additions & 4 deletions docs/rc/company/company.rc.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
8 changes: 8 additions & 0 deletions docs/rc/overview.md
Original file line number Diff line number Diff line change
@@ -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.

9 changes: 9 additions & 0 deletions docs/rc/rc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: RC
layout: default
nav_order : 5
has_children: true
---
Application
---
* Contains the functions required for an application
18 changes: 10 additions & 8 deletions docs/rc/routers.md
Original file line number Diff line number Diff line change
@@ -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]()
9 changes: 5 additions & 4 deletions docs/rc/student/student.enrollment.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
8 changes: 8 additions & 0 deletions docs/rc/student/student.md
Original file line number Diff line number Diff line change
@@ -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
9 changes: 5 additions & 4 deletions docs/rc/student/student.notice.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
9 changes: 5 additions & 4 deletions docs/rc/student/student.rc.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
9 changes: 5 additions & 4 deletions docs/rc/student/student.resume.go.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
15 changes: 15 additions & 0 deletions docs/rc/util/util.active_rc.middleware.md
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 12 additions & 0 deletions docs/rc/util/util.company_id.md
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 8 additions & 0 deletions docs/rc/util/util.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Util
layout: default
nav_order: 1
parent: rc
has_children: true
---
* It contains utility functions and middlewares for rc
Loading