swagger.yml

openapi: 3.0.0
info:
  description: |
    This the backend server for HostelVerse, a Hostel Management System. 
    Tech Stack: Typescript, Azure Functions, Azure CosmosDB
  version: "1.0.0"
  title: Hostelverse-Backend
  contact:
    email: raghhavdturki@gmail.com
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
servers:
  - description: Development Server
    url: http://localhost:7071/api/
  - description: Production Server
    url: https://hostelverse-backend.azurewebsites.net/api/
paths:
  /student/signup:
    post:
      tags:
        - signup
      summary: Student Signup
      operationId: studentSignup
      requestBody:
        $ref: '#/components/requestBodies/CreateStudentInput'
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Student Created Successfully
  /createAdmin:
    post: 
      tags:
        - signup
      summary: Create Admin Account
      operationId: createAdmin
      requestBody:
        $ref: '#/components/requestBodies/AdminSignupInput'
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Admin Created Successfully
  /createHostel:
    post:
      tags:
        - admin
      summary: Create Hostel 
      operationId: createHostel
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/CreateHostelInput'
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Hostel Created Successfully
  /login:
    post:
      tags:
        - login
      summary: login
      operationId: login
      requestBody:
        $ref: '#/components/requestBodies/LoginInput'
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Logged In Successfully!
          content:
            application/json:
              schema: 
                $ref: '#/components/schemas/LoginResponse'
  /createWarden:
    post:
      tags: 
        - admin
      summary: Create Warden Account
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/CreateWardenInput'
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Warden Created Successfully
  /createRoom:
    post:
      tags:
        - admin
      summary: Create Room 
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/CreateRoomInput'
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Room Created Successfully
  /createRoomIssue:
    post:
      tags:
        - student
      summary: Create a Room Issue
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/CreateRoomIssueInput'
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Room Issue Created Successfully
  /createFeedback:
    post:
      tags: 
        - student
      security: 
        - bearerAuth: []
      summary: Create Feedback for a Hostel
      requestBody:
        $ref: '#/components/requestBodies/CreateFeedbackInput'
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Feedback Created Successfully
  /createLeaveApplication:
    post:
      tags: 
        - student
      security: 
      - bearerAuth: []
      summary: Create a Leave Application
      requestBody:
        $ref: '#/components/requestBodies/CreateLeaveApplicationInput'
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Leave Application Created Successfully
  /student/verifyemail:
    post:
      tags: 
        - student
      summary: Verify Email to get Email activated
      requestBody:
        $ref: '#/components/requestBodies/VerifyEmailInput'
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Account Activated Successfully
  /deleteWarden:
    post:
      security: 
        - bearerAuth: []
      tags:
        - admin
      summary: Delete a Warden
      requestBody:
        $ref: '#/components/requestBodies/DeleteWardenInput'
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Warden Deleted Successfully
  /getAnnouncements:
    get:
      tags: 
        - student
      security: 
        - bearerAuth: []
      summary: Get announcements of your hostel
      parameters: 
        - in: query
          name: studentid
          schema:
            type: string
          required: true
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Announcements
          content:
            application/json:
              schema: 
                type: array
                items:
                  $ref: '#/components/schemas/Announcement'
  /createAnnouncement:
    post:
      tags: 
        - warden
      security: 
        - bearerAuth: []
      summary: Create an annoucement for the hostel
      requestBody:
        $ref: '#/components/requestBodies/CreateAnnoucementInput'
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Annoucemnet Created Successfully
  /getStudent:
    get:
      tags: 
        - warden
        - admin
      security: 
        - bearerAuth: []
      summary: Get Students details
      parameters: 
        - in: query
          name: studentid
          schema:
            type: string
        - in: query
          name: wardenid
          schema:
            type: string
          required: true
        - in: query
          name: adminid
          description: enter the adminid if u want the admin to see the student details
          schema:
            type: string
          required: true
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Student List
          content:
            application/json:
              schema: 
                type: array
                items:
                  $ref: '#/components/schemas/Student'
  /getStudentProfile:
    get:
      tags: 
        - student
      security: 
        - bearerAuth: []
      summary: Get the profile for a student
      parameters: 
        - in: query
          name: studentid
          schema:
            type: string
          required: true
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Student Profile
          content:
            application/json:
              schema: 
                $ref: '#/components/schemas/Student'
  /getWarden:
    get:
      tags: 
        - admin
      security: 
        - bearerAuth: []
      summary: Get the Wardens Information
      parameters: 
        - in: query
          name: wardenid
          schema:
            type: string
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Warden List
          content:
            application/json:
              schema: 
                type: array
                items:
                  $ref: '#/components/schemas/Warden'
  /hostelList:
    get:
      tags: 
        - admin
      security: 
        - bearerAuth: []
      summary: Get the Hostels Information
      parameters: 
        - in: query
          name: hostelid
          schema:
            type: string
        - in: query
          name: low
          schema: 
            type: integer
        - in: query
          name: high
          schema: 
            type: integer
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Hostel List
          content:
            application/json:
              schema: 
                type: array
                items:
                  $ref: '#/components/schemas/Hostel'
  /getFeedback:
    get:
      tags: 
        - admin
      security: 
        - bearerAuth: []
      parameters: 
        - in: query
          name: feedbackid
          schema:
            type: string
          description: Provide optional feedback id to get a specifc feedback, otherwise shows all the feedbacks
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Feedback List
          content:
            application/json:
              schema: 
                type: array
                items:
                  $ref: '#/components/schemas/Feedback'
  /getLeaveApplications:
    get:
      tags: 
        - warden
      security: 
        - bearerAuth: []
      description: Provide studentid to view the Leave Application of that student in the warden's hostel otherwise displays all the leave applications in the warden's hostel
      parameters: 
        - in: query
          name: wardenid
          schema:
            type: string
          required: true
        - in: query
          name: studentid
          schema:
            type: string
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Leave Application List
          content:
            application/json:
              schema: 
                type: array
                items:
                  $ref: '#/components/schemas/LeaveApplication'
  /getRoomIssue:
    get:
      tags: 
        - warden
      security: 
        - bearerAuth: []
      description: Provide roomissueid to get a specifc room issue in the warden's hostel. Otherwise returns the full list of room issues
      parameters: 
        - in: query
          name: wardenid
          schema:
            type: string
          required: true
        - in: query
          name: roomIssueId
          schema:
            type: string
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Room Issue List
          content:
            application/json:
              schema: 
                type: array
                items:
                  $ref: '#/components/schemas/RoomIssue'
  /resolveRoomIssue:
    post:
      tags: 
        - warden
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/UpdateRoomIssue'
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Room Issue Updated Successfully
  /updateLeaveApplication:
    post:
      tags: 
        - warden
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/UpdateLeaveApplication'
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Leave Application Updated Successfully
  /allotHostel:
    post:
      tags: 
        - admin
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/AllotHostelInput'
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Hostel Alloted Successfully
  /checkin:
    post:
      tags: 
        - student
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/CheckInInput'
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Checked In Successfully
  /checkout:
    post:
      tags: 
        - student
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/CheckOutInput'
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Checked Out Successfully
  /getWardenProfile:
    get:
      tags:
        - warden
      security: 
        - bearerAuth: []
      parameters: 
        - in: query
          name: wardenid
          schema:
            type: string
          required: true
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Warden Profile
          content:
            application/json:
              schema: 
                $ref: '#/components/schemas/Warden'
  /getAdminProfile:
    get:
      tags:
        - admin
      security: 
        - bearerAuth: []
      parameters: 
        - in: query
          name: adminid
          schema:
            type: string
          required: true
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Admin Profile
          content:
            application/json:
              schema: 
                $ref: '#/components/schemas/Admin'
  /getAdminDashboard:
    get:
      tags: 
        - admin
      security: 
        - bearerAuth: []
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Admin Dashboard
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminDashboardResponse'
  /getRoomDetails:
    get:
      tags: 
        - warden
      security: 
        - bearerAuth: []
      description: Enter the roomid query param to get the room details of a particular room in the warden's hostel. Otherwise returns the room details of all the rooms in the hostel. Returns a single object in the data field if roomid is specified. Otherwise returns an array of room detail objects
      parameters: 
        - in: query
          name: wardenid
          schema:
            type: string
          required: true
        - in: query
          name: roomid
          schema:
            type: string
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Room details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoomDetailResponse'
  /getStudentAttendence:
    get:
      tags: 
        - warden
      security: 
        - bearerAuth: []
      parameters: 
        - in: query
          name: wardenid
          schema:
            type: string
          required: true
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Student Attendences Fetched Successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudentAttendenceResponse'
  /removeStudent:
    get:
      tags: 
        - admin
      security: 
        - bearerAuth: []
      parameters: 
        - in: query
          name: studentid
          schema:
            type: string
          required: true
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Student Deleted Successfully
  /getStudentRoomIssue:
    get:
      tags: 
        - student
      security: 
        - bearerAuth: []
      summary: Get the room issue of that student
      parameters: 
        - in: query
          name: studentid
          schema:
            type: string
          required: true
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: Student Room Issue Fetched Successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RoomIssue'
  /getStudentLeaveApplication:
    get:
      tags: 
        - student
      security: 
        - bearerAuth: []
      summary: Get the leave application of that student
      parameters: 
        - in: query
          name: studentid
          schema:
            type: string
          required: true
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Student Leave Application Fetched Successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LeaveApplication'
  /resendOTP:
    get:
      tags: 
        - signup
      summary: Resend OTP 
      parameters: 
        - in: query
          name: email
          schema:
            type: string
          required: true
      responses:
        '400':
          description: Invalid input
        '401':
          description: Unauthorised Access!
        '500':
          description: Internal Server Error
        '200':
          description: OTP resent successfully
  /uploadProfilePic:
    post:
      tags:
        - student
        - warden
        - admin
      security: 
        - bearerAuth: []
      summary: Upload Profile Picture
      parameters: 
        - in: query
          name: filename
          description: filename(set it equal to the id of the student, warden, admin)
          schema:
            type: string
          required: true
        - in: query
          name: id
          description: Id of the student, warden or admin
          schema:
            type: string
          required: true
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                filename:
                    type: string
                    format: binary
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Student Profile Pic Update Successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Student'
  /uploadHostelPic:
    post:
      tags:
        - admin
      security: 
        - bearerAuth: []
      summary: Upload Hostel Picture
      parameters: 
        - in: query
          name: filename
          description: filename(set it equal to the id of the hostel)
          schema:
            type: string
          required: true
        - in: query
          name: hostelid
          schema:
            type: string
          required: true
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                filename:
                    type: string
                    format: binary
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Hostel Pic Updated Successfully
  /updateStudentProfile:
    post:
      tags: 
        - student
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/UpdateStudentProfileInput'
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Student Profile Updated Successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Student'
  /updateWardenProfile:
    post:
      tags: 
        - warden
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/UpdateWardenProfileInput'
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Warden Profile Updated Successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Warden'
  /updateAdminProfile:
    post:
      tags: 
        - admin
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/UpdateAdminProfileInput'
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Admin Profile Updated Successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Admin'
  /requestResetPassword:
    get:  
      tags:
        - admin
        - warden
        - student
      parameters:
        - in: query
          name: email
          schema:
            type: string
          required: true
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Reset Password Link Sent Successfully
  /resetPassword:
    get:
      tags:
        - admin
        - warden
        - student
      parameters:
        - in: query
          name: token
          schema:
            type: string
          required: true
        - in: query
          name: newPassword
          schema:
            type: string
          required: true
        - in: query
          name: oldPassword
          schema:
            type: string
          required: true
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Password Reset Successfully
  /createOrder:
    post:
      tags:
        - student
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/CreateOrderInput'
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Order Created Successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateOrderResponse'
  /verifyPayment:
    post:
      tags:
        - student
      security: 
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/VerifyPaymentInput'
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Payment Verified Successfully
  /getPaymentHistory:
    get:
      tags:
        - student
        - admin
      security: 
        - bearerAuth: []
      description: Returns the payemnts of the student which have been successfully been paid
      parameters:
        - in: query
          name: studentid
          schema:
            type: string
          required: true
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Payment History Fetched Successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Payment'
  /createSemesterSchedule:
    post:
      tags:
        - admin
      security:
        - bearerAuth: []
      requestBody:
        $ref: '#/components/requestBodies/CreateSemesterScheduleInput'
      responses:
        '400':
          description: Invalid input
        '500':
          description: Internal Server Error
        '200':
          description: Semester Schedule Created Successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SemesterSchedule'
/checkFeesStatus:
  get:
    tags:
      - student
      - admin
    security:
      - bearerAuth: []
    description: Returns the status of the fees of the student
    parameters:
      - in: query
        name: studentid
        schema:
          type: string
        required: true
    responses:
      '400':
        description: Invalid input
      '500':
        description: Internal Server Error
      '200':
        description: Fees Status Fetched Successfully
        content:
          application/json:
            schema:
              type: object
              properties:
                paid:
                  type: boolean
components:
  schemas:
    Student:
      type: object
      properties:
        studentid:
          type: string
        email:
          type: string
        password:
          type: string
        roomid:
          type: string
        hostelid:
          type: string
        emailToken:
          type: integer
          format: int64
          nullable: true
        emailTokenExpires:
          type: string
          format: date-time
          nullable: true
        resetPasswordToken:
          type: string
          nullable: true
        resetPasswordExpires: 
          type: string
          nullable: true
        batch: 
          type: string
        role: 
          type: string
          default: student
        active:
          type: boolean
        distance:
          type: number
          format: float
        profile:
          type: object
          properties:
            name:
              type: string
            studentid:
              type: string
            role: 
              type: string
            gender: 
              type: string
            email: 
              type: string
            contactno:
              type: string
            location:
              type: string
    Warden:
      type: object
      properties:
        wardenid:
          type: string
        name: 
          type: string
        email: 
          type: string
        password: 
          type: string
        resetPasswordToken:
          type: string
          nullable: true
        resetPasswordExpires: 
          type: string
          nullable: true
        role:
          type: string
          default: Warden
        hostelid:
          type: string
        profile: 
          type: object
          properties:
            name: 
              type: string
            email: 
              type: string
            contactno: 
              type: string
    Admin:
      type: object
      properties:
        adminid:
          type: string
        name:
          type: string
        email:
          type: string
        password:
          type: string
        resetPasswordToken:
          type: string
          nullable: true
        resetPasswordExpires: 
          type: string
          nullable: true
        role:
          type: string
          default: Admin
        profile:
          type: object
          properties:
            adminid:
              type: string
            name: 
              type: string
            email: 
              type: string
            contactno: 
              type: string
    Hostel:
      type: object
      properties:
        hostelid:
          type: string
        name:
          type: string
        location:
          type: string
        wardenid: 
          type: string
          nullable: true
        description:
          type: string
        totalCapacity:
          type: integer
          format: int32
        singleRooms: 
          type: integer
          format: int32
          default: 0
        doubleRooms: 
          type: integer
          format: int32
          default: 0
        tripleRooms: 
          type: integer
          format: int32
          default: 0
        singleRoomsLeft: 
          type: integer
          format: int32
        doubleRoomsLeft: 
          type: integer
          format: int32
        tripleRoomsLeft: 
          type: integer
          format: int32
        fees: 
          type: integer
          format: int32
        overallRating: 
          type: number
          format: float
        numberOfReviews:
          type: integer
          format: int32
        image:
          type: string
    Room:
      type: object
      properties:
        hostelid:
          type: string
        roomno:
          type: string
        allotrmentStatus:
          type: boolean
          default: false
        type:
          type: string
          description: Specifies the room type,such as single, double or triple
        occupants:
          description: Array of student id's occupying the room
          type: array
          items:
            type: string
    RoomIssue:
      type: object
      properties:
        hostelid:
          type: string
        roomno:
          type: string
        remarks:
          type: string
        created_at: 
          type: string
          format: date-time
        status:
          type: string
          enum: [Pending, Resolved]
          default: Pending
    LeaveApplication:
      type: object
      properties:
        studentid:
          type: string
        hostelid: 
          type: string
        message:
          type: string
        date_from:
          type: string
          format: date-time
        date_to: 
          type: string
          format: date-time
        status:
          type: string
          enum: [Pending, Approved, Rejected]
          default: Pending
        remarks:
          type: string
          nullable: true
        seenBy:
          type: string
          description: The wardenid of the warden that approved/rejected the application
    Feedback:
      type: object
      properties:
        studentid:
          type: string
        name:
          type: string
        hostelid: 
          type: number
        message:
          type: string
        rating: 
          type: number
          format: float
    Attendence:
      type: object
      properties:
        studentid: 
          type: string
        last_checkin: 
          type: string
          format: date-time
          nullable: true
        last_checkout: 
          type: string
          format: date-time
          nullable: true
    Announcement:
      type: object
      properties:
        hostelid:
          type: string
        wardenid:
          type: string
        heading:
          type: string
        message:
          type: string
    Payment:
      type: object
      properties:
        orderid:
          type: string
        receiptid:
          type: string
        razorpay_order_id:
          type: string
        razorpay_payment_id:
          type: string
        razorpay_signature:
          type: string
        studentid:
          type: string
        hostelid:
          type: string
        amount:
          type: number
          format: float
        status:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    SemesterSchedule:
      type: object
      properties:
        type:
          type: string
        half:
          type: integer
          format: int32
        year:
          type: integer
          format: int32
        startdDate:
          type: string
          format: date-time
        endDate:
          type: string
          format: date-time
        allotDate:
          type: string
          format: date-time
        paymentDeadline:
          type: string
          format: date-time
    CreateStudentInput:
      type: object
      properties:
        studentid: 
          type: string
        email: 
          type: string
        password: 
          type: string
        name: 
          type: string
        gender: 
          type: string
        contactno: 
          type: string
        location: 
          type: string
    CreateHostelInput:
      type: object
      properties:
        hostelid:
          type: string
        name:
          type: string
        location:
          type: string
        wardenid: 
          type: string
        description:
          type: string
        totalCapacity:
          type: integer
          format: int32
        singleRooms: 
          type: integer
          format: int32
          default: 0
        doubleRooms: 
          type: integer
          format: int32
          default: 0
        tripleRooms: 
          type: integer
          format: int32
          default: 0
        fees: 
          type: integer
          format: int32
    AdminSignupInput:
      type: object
      properties: 
        name: 
          type: string
        email: 
          type: string
        password: 
          type: string
        contactno: 
          type: string
        adminid: 
          type: string
    VerifyEmailInput:
      type: object
      properties: 
        email:
          type: string
        code: 
          type: integer
          format: int32
    LoginInput:
      type: object
      properties: 
        email:
          type: string
        password: 
          type: string
    CreateWardenInput:
      type: object
      properties: 
        wardenid:
          type: string
        email: 
          type: string
        password: 
          type: string
        name: 
          type: string
        contactno:
          type: string
        hostelid: 
          type: string
    CreateRoomInput:
      type: object
      properties: 
        hostelid:
          type: string
        roomno: 
          type: string
        type: 
          type: string
          enum: [single, double, triple]
          description: Specify the room type
        updateOrAdd:
          type: string
          enum: [add, update]
          description: Add-> Admin has to add another room which increases the capacity; Update-> The room is already included in the current Hostel document, but the admin wants to create that room inside the databse.
    CreateRoomIssueInput:
      type: object
      properties:
        studentid: 
          type: string
        remarks: 
          type: string
    CreateFeedbackInput:
      type: object
      properties: 
        hostelid:
          type: string
        studentid: 
          type: string
        name:
          type: string
        rating: 
          type: integer
          format: int32
        message:
          type: string
    CreateLeaveApplicationInput:
      type: object
      properties:
        studentid: 
          type: string
        date_from: 
          type: string
          format: date-time
        date_to:
          type: string
          format: date-time
        message: 
          type: string
    CreateAnnoucementInput:
      type: object
      properties:
        wardenid: 
          type: string
        heading:
          type: string
        message: 
          type: string
    DeleteWardenInput:
      type: object
      properties:
        wardenid:
          type: string
    UpdateRoomIssue:
      type: object
      properties:
        id:
          type: string
        hosteldid: 
          type: string
        roomno:
          type: string
        status:
          type: string
          enum: [Pending, Resolved, Assigned]
          default: Pending
        assigned_person:
          type: string
        expected_completion_date:
          type: string
          format: date-time
        contact_no:
          type: string
    UpdateLeaveApplication:
      type: object
      properties:
        studentid: 
          type: string
        wardenid: 
          type: string
        name: 
          type: string
        status: 
          type: string
        remarks: 
          type: string
    AllotHostelInput:
      type: object
      properties:
        hostelid:
          type: array
          items:
            type: string
        batch: 
          type: array
          items:
            type: string
        paymentDeadline: 
          type: string
          format: date-time
    CheckInInput:
      type: object
      properties:
        studentid: 
          type: string
        location:
          type: string
    CheckOutInput:
      type: object
      properties:
        studentid: 
          type: string
        location:
          type: string
    UpdateStudentProfileInput:
      type: object
      required: 
        - studentid
      properties:
        studentid: 
          type: string
        name:
          type: string
        gender:
          type: string
        description:
          type: string
        contatcno:
          type: string
        instagramHandle:
          type: string
        linkedinHandle:
          type: string
        githubHandle:
          type: string
        twitterHandle:
          type: string
    UpdateWardenProfileInput:
      type: object
      required: 
        - wardenid
      properties:
        wardenid: 
          type: string
        email:
          type: string
        contactno:
          type: string
    UpdateAdminProfileInput:
      type: object
      required: 
        - wardenid
      properties:
        wardenid: 
          type: string
        email:
          type: string
        contactno:
          type: string
    CreateOrderInput:
      type: object
      properties:
        studentid: 
          type: string
        hostelid: 
          type: string
        name: 
          type: string
        contactno: 
          type: string
        email: 
          type: string
        amount: 
          type: number
          format: int32
    VerifyPaymentInput:
      type: object
      properties:
        razorpay_payment_id: 
          type: string
        razorpay_order_id: 
          type: string
        razorpay_signature: 
          type: string
        receipt_id:
          type: string
    CreateSemesterScheduleInput:
      type: object
      properties:
        type: 
          type: string
        year: 
          type: integer
          format: int32
        half:
          type: integer
          format: int32
        startDate: 
          type: string
          format: date-time
        endDate: 
          type: string
          format: date-time
    LoginResponse:
      type: object
      properties:
        message:
          type: string
        profile: 
          type: object
        token: 
          type: string
    AdminDashboardResponse:
      type: object
      properties:
        message:  
          type: string
        data:
          type: object
          properties:
            occupancyRate:
              type: array
              items:
                type: object
            issueClearanceRate:
              type: array
              items:
                type: object
    RoomDetailResponse:
      type: object
      properties:
        message:  
          type: string
        data:
          type: object
    StudentAttendenceResponse:
      type: object
      properties:
        message:  
          type: string
        data:
          type: array
          items:
            type: object
    CreateOrderResponse:
      type: object
      properties:
        orderid:  
          type: string
        receiptid:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Iron Sealed Token
  requestBodies:
    CreateStudentInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateStudentInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/CreateStudentInput'
      description: Signup properties for Student
      required: true
    CreateHostelInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateHostelInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/CreateHostelInput'
      required: true
    AdminSignupInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AdminSignupInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/AdminSignupInput'
      required: true
    VerifyEmailInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/VerifyEmailInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/VerifyEmailInput'
      required: true
    LoginInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/LoginInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/LoginInput'
      required: true
    CreateWardenInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateWardenInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/CreateWardenInput'
      required: true
    CreateRoomInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateRoomInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/CreateRoomInput'
      required: true
    CreateRoomIssueInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateRoomIssueInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/CreateRoomIssueInput'
      required: true
    CreateFeedbackInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateFeedbackInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/CreateFeedbackInput'
      required: true
    CreateLeaveApplicationInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateLeaveApplicationInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/CreateLeaveApplicationInput'
      required: true
    CreateAnnoucementInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateAnnoucementInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/CreateAnnoucementInput'
      required: true
    DeleteWardenInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DeleteWardenInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/DeleteWardenInput'
    UpdateRoomIssue:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateRoomIssue'
        application/xml:
          schema:
            $ref: '#/components/schemas/UpdateRoomIssue'
    UpdateLeaveApplication:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateLeaveApplication'
        application/xml:
          schema:
            $ref: '#/components/schemas/UpdateLeaveApplication'
    AllotHostelInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AllotHostelInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/AllotHostelInput'
      required: true
    CheckInInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CheckInInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/CheckInInput'
      required: true
    CheckOutInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CheckOutInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/CheckOutInput'
      required: true
    UpdateStudentProfileInput:
      content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateStudentProfileInput'
          application/xml:
            schema:
              $ref: '#/components/schemas/UpdateStudentProfileInput'
      required: true
    UpdateWardenProfileInput:
      content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWardenProfileInput'
          application/xml:
            schema:
              $ref: '#/components/schemas/UpdateWardenProfileInput'
      required: true
    CreateOrderInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateOrderInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/CreateOrderInput'
      required: true
    VerifyPaymentInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/VerifyPaymentInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/VerifyPaymentInput'
      required: true
    UpdateAdminProfileInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateAdminProfileInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/UpdateAdminProfileInput'
      required: true
    CreateSemesterScheduleInput:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CreateSemesterScheduleInput'
        application/xml:
          schema:
            $ref: '#/components/schemas/CreateSemesterScheduleInput'
      required: true