schema.yml

openapi: 3.0.3
info:
  title: Clinic-z Api Documentation
  version: 1.0.0
  description: A public API for all front-end developers across the globe to integrate
    with Clinic-z services. This API provides endpoints for user authentication, patient
    management, appointment scheduling, and medical record access.
paths:
  /v2/api/appointment/doctor/:
    get:
      operationId: appointment_doctor_list
      description: "\n    A doctor can see the appointments they have,\n    view patient
        details, and update appointment status.\n    "
      tags:
      - Appointment
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DoctorAppointmentList'
          description: ''
    post:
      operationId: appointment_doctor_create
      description: "\n    A doctor can see the appointments they have,\n    view patient
        details, and update appointment status.\n    "
      tags:
      - Appointment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DoctorAppointmentList'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DoctorAppointmentList'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DoctorAppointmentList'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DoctorAppointmentList'
          description: ''
  /v2/api/appointment/doctor/{id}/update_status/:
    patch:
      operationId: appointment_doctor_update_status_partial_update
      description: "\n    A doctor can see the appointments they have,\n    view patient
        details, and update appointment status.\n    "
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this Appointment.
        required: true
      tags:
      - Appointment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDoctorAppointmentUpdateStatus'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDoctorAppointmentUpdateStatus'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDoctorAppointmentUpdateStatus'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DoctorAppointmentUpdateStatus'
          description: ''
  /v2/api/appointment/patient/:
    get:
      operationId: appointment_patient_list
      description: "\n    patients can create an appointment, see and retrieve their
        own appointments\n    "
      tags:
      - Appointment
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PatientAppointment'
          description: ''
    post:
      operationId: appointment_patient_create
      description: "\n    patients can create an appointment, see and retrieve their
        own appointments\n    "
      tags:
      - Appointment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatientAppointment'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatientAppointment'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatientAppointment'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientAppointment'
          description: ''
  /v2/api/doctor/{doctor_id}/qualifications/:
    get:
      operationId: doctor_qualifications_retrieve
      parameters:
      - in: path
        name: doctor_id
        schema:
          type: integer
        required: true
      tags:
      - Qualifications OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          description: No response body
  /v2/api/doctor/available-times/:
    get:
      operationId: doctor_available_times_list
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Available Time OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAvailableTimeList'
          description: ''
    post:
      operationId: doctor_available_times_create
      tags:
      - Available Time OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvailableTime'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AvailableTime'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AvailableTime'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableTime'
          description: ''
  /v2/api/doctor/available-times-patient/:
    get:
      operationId: doctor_available_times_patient_list
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Available Time OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAvailableTimeList'
          description: ''
    post:
      operationId: doctor_available_times_patient_create
      tags:
      - Available Time OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvailableTime'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AvailableTime'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AvailableTime'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableTime'
          description: ''
  /v2/api/doctor/available-times-patient/{id}/:
    get:
      operationId: doctor_available_times_patient_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this available time.
        required: true
      tags:
      - Available Time OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableTime'
          description: ''
    put:
      operationId: doctor_available_times_patient_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this available time.
        required: true
      tags:
      - Available Time OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvailableTime'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AvailableTime'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AvailableTime'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableTime'
          description: ''
    patch:
      operationId: doctor_available_times_patient_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this available time.
        required: true
      tags:
      - Available Time OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAvailableTime'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedAvailableTime'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedAvailableTime'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableTime'
          description: ''
    delete:
      operationId: doctor_available_times_patient_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this available time.
        required: true
      tags:
      - Available Time OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '204':
          description: No response body
  /v2/api/doctor/available-times/{id}/:
    get:
      operationId: doctor_available_times_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this available time.
        required: true
      tags:
      - Available Time OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableTime'
          description: ''
    put:
      operationId: doctor_available_times_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this available time.
        required: true
      tags:
      - Available Time OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvailableTime'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AvailableTime'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AvailableTime'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableTime'
          description: ''
    patch:
      operationId: doctor_available_times_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this available time.
        required: true
      tags:
      - Available Time OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAvailableTime'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedAvailableTime'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedAvailableTime'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableTime'
          description: ''
    delete:
      operationId: doctor_available_times_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this available time.
        required: true
      tags:
      - Available Time OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '204':
          description: No response body
  /v2/api/doctor/designations/:
    get:
      operationId: doctor_designations_list
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Designation OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDesignationList'
          description: ''
    post:
      operationId: doctor_designations_create
      tags:
      - Designation OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Designation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Designation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Designation'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Designation'
          description: ''
  /v2/api/doctor/designations/{id}/:
    get:
      operationId: doctor_designations_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this designation.
        required: true
      tags:
      - Designation OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Designation'
          description: ''
    put:
      operationId: doctor_designations_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this designation.
        required: true
      tags:
      - Designation OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Designation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Designation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Designation'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Designation'
          description: ''
    patch:
      operationId: doctor_designations_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this designation.
        required: true
      tags:
      - Designation OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDesignation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDesignation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDesignation'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Designation'
          description: ''
    delete:
      operationId: doctor_designations_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this designation.
        required: true
      tags:
      - Designation OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '204':
          description: No response body
  /v2/api/doctor/list/:
    get:
      operationId: doctor_list_list
      tags:
      - Doctors
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Doctor'
          description: ''
  /v2/api/doctor/profile/{user__email}:
    get:
      operationId: doctor_profile_retrieve
      parameters:
      - in: path
        name: user__email
        schema:
          type: string
        required: true
      tags:
      - Doctors
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doctor'
          description: ''
  /v2/api/doctor/profile/me/:
    get:
      operationId: doctor_profile_me_retrieve
      tags:
      - Doctors
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doctor'
          description: ''
    put:
      operationId: doctor_profile_me_update
      tags:
      - Doctors
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Doctor'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Doctor'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Doctor'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doctor'
          description: ''
    patch:
      operationId: doctor_profile_me_partial_update
      tags:
      - Doctors
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDoctor'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDoctor'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDoctor'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Doctor'
          description: ''
    delete:
      operationId: doctor_profile_me_destroy
      tags:
      - Doctors
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '204':
          description: No response body
  /v2/api/doctor/qualifications/apply/:
    post:
      operationId: doctor_qualifications_apply_create
      tags:
      - Qualifications OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QualificationApply'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/QualificationApply'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/QualificationApply'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QualificationApply'
          description: ''
  /v2/api/doctor/reviews/:
    get:
      operationId: doctor_reviews_list
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Review OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedReviewList'
          description: ''
    post:
      operationId: doctor_reviews_create
      tags:
      - Review OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Review'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Review'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Review'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Review'
          description: ''
  /v2/api/doctor/reviews/{id}/:
    get:
      operationId: doctor_reviews_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this review.
        required: true
      tags:
      - Review OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Review'
          description: ''
    put:
      operationId: doctor_reviews_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this review.
        required: true
      tags:
      - Review OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Review'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Review'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Review'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Review'
          description: ''
    patch:
      operationId: doctor_reviews_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this review.
        required: true
      tags:
      - Review OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedReview'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedReview'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedReview'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Review'
          description: ''
    delete:
      operationId: doctor_reviews_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this review.
        required: true
      tags:
      - Review OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '204':
          description: No response body
  /v2/api/doctor/specializations/:
    get:
      operationId: doctor_specializations_list
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Specialization OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSpecializationList'
          description: ''
    post:
      operationId: doctor_specializations_create
      tags:
      - Specialization OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Specialization'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Specialization'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Specialization'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Specialization'
          description: ''
  /v2/api/doctor/specializations/{id}/:
    get:
      operationId: doctor_specializations_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this specialization.
        required: true
      tags:
      - Specialization OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Specialization'
          description: ''
    put:
      operationId: doctor_specializations_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this specialization.
        required: true
      tags:
      - Specialization OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Specialization'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Specialization'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Specialization'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Specialization'
          description: ''
    patch:
      operationId: doctor_specializations_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this specialization.
        required: true
      tags:
      - Specialization OF Doctor
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSpecialization'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSpecialization'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSpecialization'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Specialization'
          description: ''
    delete:
      operationId: doctor_specializations_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this specialization.
        required: true
      tags:
      - Specialization OF Doctor
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '204':
          description: No response body
  /v2/api/operations/apply/to-be/doctor/:
    post:
      operationId: operations_apply_to_be_doctor_create
      tags:
      - profile migration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BecomeDoctor'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BecomeDoctor'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BecomeDoctor'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BecomeDoctor'
          description: ''
  /v2/api/patient/patients/:
    get:
      operationId: patient_patients_list
      description: List all patient profiles with filtering options.
      tags:
      - Patients
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PatientList'
          description: ''
  /v2/api/patient/patients/{user__email}/:
    get:
      operationId: patient_patients_retrieve
      description: Retrieve a patient profile by email.
      parameters:
      - in: path
        name: user__email
        schema:
          type: string
        required: true
      tags:
      - Patients
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientDetail'
          description: ''
  /v2/api/patient/patients/me/:
    get:
      operationId: patient_patients_me_retrieve
      description: Retrieve, update, or delete your own patient profile.
      tags:
      - Patients
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientDetail'
          description: ''
    put:
      operationId: patient_patients_me_update
      description: Retrieve, update, or delete your own patient profile.
      tags:
      - Patients
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatientDetail'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatientDetail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatientDetail'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientDetail'
          description: ''
    patch:
      operationId: patient_patients_me_partial_update
      description: Retrieve, update, or delete your own patient profile.
      tags:
      - Patients
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedPatientDetail'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedPatientDetail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedPatientDetail'
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatientDetail'
          description: ''
    delete:
      operationId: patient_patients_me_destroy
      description: Retrieve, update, or delete your own patient profile.
      tags:
      - Patients
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '204':
          description: No response body
  /v2/api/public-portal/contact-us/:
    post:
      operationId: public_portal_contact_us_create
      description: Create a new contact us entry
      tags:
      - user-feedback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactUs'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ContactUs'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ContactUs'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContactUs'
          description: ''
  /v2/api/public-portal/list/doctor/:
    get:
      operationId: public_portal_list_doctor_list
      description: List all services
      tags:
      - website-decoration
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Doctor'
          description: ''
  /v2/api/public-portal/list/doctor/reviews/:
    get:
      operationId: public_portal_list_doctor_reviews_list
      description: doctor reviews
      tags:
      - website-decoration
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReviewSerializerPublic'
          description: ''
  /v2/api/public-portal/report-bug/:
    post:
      operationId: public_portal_report_bug_create
      description: List all report bugs or create a new one
      tags:
      - user-feedback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportBug'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ReportBug'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ReportBug'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportBug'
          description: ''
  /v2/api/public-portal/services/:
    get:
      operationId: public_portal_services_list
      description: List all services
      tags:
      - website-decoration
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Service'
          description: ''
  /v2/api/user/account/activate/:
    post:
      operationId: user_account_activate_create
      description: "\n    this end point will be the place where you will be taking
        \n    otp from user and make sure you are authenticating the user \n    using
        the access token last time you took from registration end point\n    "
      tags:
      - User-Authentication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivatingAccount'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ActivatingAccount'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ActivatingAccount'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivatingAccount'
          description: ''
  /v2/api/user/account/activate/otp/resend/:
    post:
      operationId: user_account_activate_otp_resend_create
      description: "\n    If user demands OTP again, use this endpoint to resend the
        OTP.\n    This endpoint will expire the previous OTP and generate a new one.\n
        \   The user must be authenticated to use this endpoint.\n    Returns the
        new OTP for the user.\n    "
      tags:
      - User-Authentication
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          description: No response body
  /v2/api/user/change-password/:
    post:
      operationId: user_change_password_create
      description: Change password using old password
      tags:
      - User-Authentication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordChange'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PasswordChange'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PasswordChange'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordChange'
          description: ''
  /v2/api/user/forget-password/:
    post:
      operationId: user_forget_password_create
      description: Request password reset OTP
      tags:
      - User-Authentication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForgetPasswordRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ForgetPasswordRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ForgetPasswordRequest'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForgetPasswordRequest'
          description: ''
  /v2/api/user/forget-password/confirm/:
    post:
      operationId: user_forget_password_confirm_create
      description: Reset password using verified OTP
      tags:
      - User-Authentication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordResetConfirm'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PasswordResetConfirm'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PasswordResetConfirm'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordResetConfirm'
          description: ''
  /v2/api/user/forget-password/otp/resend/:
    post:
      operationId: user_forget_password_otp_resend_create
      description: Verify OTP for password reset
      tags:
      - User-Authentication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordResetVerifyOTP'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PasswordResetVerifyOTP'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PasswordResetVerifyOTP'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordResetVerifyOTP'
          description: ''
  /v2/api/user/forget-password/otp/send/:
    post:
      operationId: user_forget_password_otp_send_create
      description: Verify OTP for password reset
      tags:
      - User-Authentication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordResetVerifyOTP'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PasswordResetVerifyOTP'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PasswordResetVerifyOTP'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordResetVerifyOTP'
          description: ''
  /v2/api/user/list/:
    get:
      operationId: user_list_list
      description: Returns all users to admin only.
      tags:
      - User-Authentication
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserList'
          description: ''
  /v2/api/user/login/:
    post:
      operationId: user_login_create
      description: "\n    This end point will help you to authenticate user.\n    You
        will be taking email and password. If all information are correct,\n    I
        will give you an access token to do OTP verification for that\n    take the
        user to /v1/api/user/login/otp/verify/ end point and\n    take otp from them,
        then gimme i will work with it and give you access\n    and refresh token\n
        \   "
      tags:
      - User-Authentication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Login'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Login'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Login'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Login'
          description: ''
  /v2/api/user/login/otp/resend/:
    post:
      operationId: user_login_otp_resend_create
      description: Resend OTP for login verification.
      tags:
      - User-Authentication
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '200':
          description: No response body
  /v2/api/user/login/otp/verify/:
    post:
      operationId: user_login_otp_verify_create
      description: Verify OTP for login to gain access and refresh tokens. Provide
        the OTP sent to your email.
      tags:
      - User-Authentication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoginOtp'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/LoginOtp'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/LoginOtp'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LoginOtp'
          description: ''
  /v2/api/user/register/:
    post:
      operationId: user_register_create
      description: "it's a registration end point where you will be \n    getting
        the access token and make the user short time authenticated, \n    then you
        will take otp from /v1/api/user/account/activate/ and i will \n    be verifying
        the user from backend"
      tags:
      - User-Authentication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Registration'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Registration'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Registration'
        required: true
      security:
      - jwtAuth: []
      - BearerAuth: []
      - {}
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Registration'
          description: ''
  /v2/api/user/token/refresh/:
    post:
      operationId: user_token_refresh_create
      description: Refresh access token using refresh token
      tags:
      - User-Authentication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenRefresh'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TokenRefresh'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TokenRefresh'
        required: true
      security:
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenRefresh'
          description: ''
  /v2/api/user/token/verify/:
    post:
      operationId: user_token_verify_create
      description: Verify if the access token is valid
      tags:
      - User-Authentication
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenVerify'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TokenVerify'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TokenVerify'
        required: true
      security:
      - BearerAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenVerify'
          description: ''
components:
  schemas:
    ActivatingAccount:
      type: object
      properties:
        otp:
          type: string
      required:
      - otp
    AppointmentImage:
      type: object
      properties:
        image:
          type: string
          format: uri
      required:
      - image
    AppointmentTypeEnum:
      enum:
      - online
      - offline
      type: string
      description: |-
        * `online` - Online
        * `offline` - Offline
    AvailableTime:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        name:
          type: string
          nullable: true
          maxLength: 255
        description:
          type: string
          nullable: true
          maxLength: 1000
      required:
      - created_at
      - id
      - updated_at
    BecomeDoctor:
      type: object
      properties:
        registration_number:
          type: string
          maxLength: 100
        certificate_img:
          type: string
          format: uri
        institution:
          type: string
          maxLength: 200
        degree:
          type: string
          maxLength: 100
        certificate_registration_number:
          type: string
          maxLength: 100
        year:
          type: string
          format: date
      required:
      - certificate_img
      - certificate_registration_number
      - degree
      - institution
      - registration_number
      - year
    BlankEnum:
      enum:
      - ''
    BugTypeEnum:
      enum:
      - UI/UX
      - Functional
      - Performance
      - Security
      - Compatibility
      - Accessibility
      - Network
      - Database
      - Integration
      - Other
      type: string
      description: |-
        * `UI/UX` - User Interface
        * `Functional` - Functional
        * `Performance` - Performance
        * `Security` - Security
        * `Compatibility` - Compatibility
        * `Accessibility` - Accessibility
        * `Network` - Network
        * `Database` - Database
        * `Integration` - Integration
        * `Other` - Other
    ContactUs:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        email:
          type: string
          nullable: true
          maxLength: 30
        problem:
          type: string
          nullable: true
        user:
          type: integer
          nullable: true
      required:
      - created_at
      - id
      - problem
      - updated_at
    Designation:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        name:
          type: string
          nullable: true
          maxLength: 255
        description:
          type: string
          nullable: true
          maxLength: 1000
      required:
      - created_at
      - id
      - updated_at
    Doctor:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        email:
          type: string
          format: email
          readOnly: true
        role:
          type: string
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        full_name:
          type: string
          maxLength: 255
        birthday:
          type: string
          format: date
          nullable: true
        gender:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/GenderEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        age:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          nullable: true
        blood_group:
          type: string
          maxLength: 5
        height:
          type: string
          format: decimal
          pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
          nullable: true
          description: height in inches
        weight:
          type: string
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,4})?$
          nullable: true
          description: weight in kg
        phone_number:
          type: string
          maxLength: 15
        address:
          type: string
        token:
          type: integer
          readOnly: true
          nullable: true
        photo:
          type: string
          format: uri
          nullable: true
        fee:
          type: string
          format: decimal
          pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
        year_of_experience:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
        registration_number:
          type: string
          readOnly: true
          nullable: true
        is_verified:
          type: boolean
          readOnly: true
        verification_status:
          readOnly: true
          nullable: true
          description: |-
            Verification status of the doctor, maintained by admin

            * `pending` - Pending
            * `verified` - Verified
            * `rejected` - Rejected
          oneOf:
          - $ref: '#/components/schemas/VerificationStatusEnum'
          - $ref: '#/components/schemas/NullEnum'
        personal_status:
          nullable: true
          description: |-
            Personal status of the doctor

            * `active` - Active
            * `inactive` - Inactive
            * `on_leave` - On Leave
          oneOf:
          - $ref: '#/components/schemas/PersonalStatusEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        designation:
          type: array
          items:
            type: integer
        specialization:
          type: array
          items:
            type: integer
        available_time:
          type: array
          items:
            type: integer
      required:
      - created_at
      - email
      - id
      - is_verified
      - registration_number
      - role
      - token
      - updated_at
      - verification_status
    DoctorAppointmentList:
      type: object
      properties:
        patient_photo:
          type: string
          format: uri
          readOnly: true
        patient_name:
          type: string
          readOnly: true
        meeting_date:
          type: string
          format: date
          description: Meeting date
        meeting_time:
          type: integer
        appointment_type:
          $ref: '#/components/schemas/AppointmentTypeEnum'
        status:
          $ref: '#/components/schemas/Status77fEnum'
        is_paid:
          type: boolean
      required:
      - appointment_type
      - meeting_date
      - meeting_time
      - patient_name
      - patient_photo
    DoctorAppointmentUpdateStatus:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status77fEnum'
        meeting_link:
          type: string
          nullable: true
          maxLength: 200
    ForgetPasswordRequest:
      type: object
      properties:
        email:
          type: string
          format: email
      required:
      - email
    GenderEnum:
      enum:
      - male
      - female
      - other
      type: string
      description: |-
        * `male` - Male
        * `female` - Female
        * `other` - Other
    Login:
      type: object
      properties:
        email:
          type: string
          format: email
        password:
          type: string
          writeOnly: true
      required:
      - email
      - password
    LoginOtp:
      type: object
      properties:
        otp:
          type: string
      required:
      - otp
    NullEnum:
      enum:
      - null
    PaginatedAvailableTimeList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/AvailableTime'
    PaginatedDesignationList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Designation'
    PaginatedReviewList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Review'
    PaginatedSpecializationList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/Specialization'
    PasswordChange:
      type: object
      properties:
        old_password:
          type: string
          writeOnly: true
        new_password:
          type: string
          writeOnly: true
        confirm_password:
          type: string
          writeOnly: true
      required:
      - confirm_password
      - new_password
      - old_password
    PasswordResetConfirm:
      type: object
      properties:
        email:
          type: string
          format: email
        otp:
          type: string
        new_password:
          type: string
        confirm_password:
          type: string
      required:
      - confirm_password
      - email
      - new_password
      - otp
    PasswordResetVerifyOTP:
      type: object
      properties:
        email:
          type: string
          format: email
        otp:
          type: string
      required:
      - email
      - otp
    PatchedAvailableTime:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        name:
          type: string
          nullable: true
          maxLength: 255
        description:
          type: string
          nullable: true
          maxLength: 1000
    PatchedDesignation:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        name:
          type: string
          nullable: true
          maxLength: 255
        description:
          type: string
          nullable: true
          maxLength: 1000
    PatchedDoctor:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        email:
          type: string
          format: email
          readOnly: true
        role:
          type: string
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        full_name:
          type: string
          maxLength: 255
        birthday:
          type: string
          format: date
          nullable: true
        gender:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/GenderEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        age:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          nullable: true
        blood_group:
          type: string
          maxLength: 5
        height:
          type: string
          format: decimal
          pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
          nullable: true
          description: height in inches
        weight:
          type: string
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,4})?$
          nullable: true
          description: weight in kg
        phone_number:
          type: string
          maxLength: 15
        address:
          type: string
        token:
          type: integer
          readOnly: true
          nullable: true
        photo:
          type: string
          format: uri
          nullable: true
        fee:
          type: string
          format: decimal
          pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
        year_of_experience:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
        registration_number:
          type: string
          readOnly: true
          nullable: true
        is_verified:
          type: boolean
          readOnly: true
        verification_status:
          readOnly: true
          nullable: true
          description: |-
            Verification status of the doctor, maintained by admin

            * `pending` - Pending
            * `verified` - Verified
            * `rejected` - Rejected
          oneOf:
          - $ref: '#/components/schemas/VerificationStatusEnum'
          - $ref: '#/components/schemas/NullEnum'
        personal_status:
          nullable: true
          description: |-
            Personal status of the doctor

            * `active` - Active
            * `inactive` - Inactive
            * `on_leave` - On Leave
          oneOf:
          - $ref: '#/components/schemas/PersonalStatusEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        designation:
          type: array
          items:
            type: integer
        specialization:
          type: array
          items:
            type: integer
        available_time:
          type: array
          items:
            type: integer
    PatchedDoctorAppointmentUpdateStatus:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Status77fEnum'
        meeting_link:
          type: string
          nullable: true
          maxLength: 200
    PatchedPatientDetail:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        user:
          type: integer
          readOnly: true
        email:
          type: string
          nullable: true
          readOnly: true
        full_name:
          type: string
          maxLength: 255
        photo:
          type: string
          format: uri
          nullable: true
        birthday:
          type: string
          format: date
          nullable: true
        gender:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/GenderEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        age:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          nullable: true
        blood_group:
          type: string
          maxLength: 5
        height:
          type: string
          format: decimal
          pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
          nullable: true
          description: height in inches
        weight:
          type: string
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,4})?$
          nullable: true
          description: weight in kg
        phone_number:
          type: string
          maxLength: 15
        address:
          type: string
        token:
          type: integer
          readOnly: true
          nullable: true
        account_type:
          type: string
          nullable: true
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
    PatchedReview:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        body:
          type: string
          maxLength: 500
        star:
          allOf:
          - $ref: '#/components/schemas/StarEnum'
          minimum: -9223372036854775808
          maximum: 9223372036854775807
        reviewer:
          type: string
          format: uuid
    PatchedSpecialization:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        name:
          type: string
          nullable: true
          maxLength: 255
        description:
          type: string
          nullable: true
          maxLength: 1000
    PatientAppointment:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        images:
          type: array
          items:
            $ref: '#/components/schemas/AppointmentImage'
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        appointment_type:
          $ref: '#/components/schemas/AppointmentTypeEnum'
        title:
          type: string
          description: 3-4 word summary of your issue
          maxLength: 100
        symptoms:
          type: string
          description: Describe the symptoms or reason for consultation
        meeting_date:
          type: string
          format: date
          description: Meeting date
        is_paid:
          type: boolean
        doctor:
          type: string
          format: uuid
          readOnly: true
        patient:
          type: string
          format: uuid
          readOnly: true
        meeting_time:
          type: integer
      required:
      - appointment_type
      - created_at
      - doctor
      - id
      - meeting_date
      - meeting_time
      - patient
      - symptoms
      - title
      - updated_at
    PatientDetail:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        user:
          type: integer
          readOnly: true
        email:
          type: string
          nullable: true
          readOnly: true
        full_name:
          type: string
          maxLength: 255
        photo:
          type: string
          format: uri
          nullable: true
        birthday:
          type: string
          format: date
          nullable: true
        gender:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/GenderEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        age:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          nullable: true
        blood_group:
          type: string
          maxLength: 5
        height:
          type: string
          format: decimal
          pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
          nullable: true
          description: height in inches
        weight:
          type: string
          format: decimal
          pattern: ^-?\d{0,3}(?:\.\d{0,4})?$
          nullable: true
          description: weight in kg
        phone_number:
          type: string
          maxLength: 15
        address:
          type: string
        token:
          type: integer
          readOnly: true
          nullable: true
        account_type:
          type: string
          nullable: true
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account_type
      - created_at
      - email
      - id
      - token
      - updated_at
      - user
    PatientList:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        email:
          type: string
          nullable: true
          readOnly: true
        full_name:
          type: string
          maxLength: 255
        photo:
          type: string
          format: uri
          nullable: true
        gender:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/GenderEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        age:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          nullable: true
        blood_group:
          type: string
          maxLength: 5
        account_type:
          type: string
          nullable: true
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - account_type
      - created_at
      - email
      - id
    PersonalStatusEnum:
      enum:
      - active
      - inactive
      - on_leave
      type: string
      description: |-
        * `active` - Active
        * `inactive` - Inactive
        * `on_leave` - On Leave
    QualificationApply:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        email:
          type: string
          format: email
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        title:
          type: string
          maxLength: 200
        institution:
          type: string
          maxLength: 200
        degree:
          type: string
          maxLength: 200
        year:
          type: string
          format: date
          nullable: true
        grade:
          type: string
          nullable: true
          maxLength: 10
        registration_id:
          type: string
          maxLength: 100
        certificate_img:
          type: string
          format: uri
          nullable: true
        verification_status:
          readOnly: true
          nullable: true
          description: |-
            Verification status of the qualification, maintained by admin

            * `pending` - Pending
            * `verified` - Verified
            * `rejected` - Rejected
          oneOf:
          - $ref: '#/components/schemas/VerificationStatusEnum'
          - $ref: '#/components/schemas/NullEnum'
      required:
      - created_at
      - degree
      - email
      - id
      - institution
      - title
      - updated_at
      - verification_status
    Registration:
      type: object
      properties:
        email:
          type: string
          format: email
        password:
          type: string
          writeOnly: true
        password2:
          type: string
          writeOnly: true
      required:
      - email
      - password
      - password2
    ReportBug:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        email:
          type: string
          format: email
          nullable: true
          maxLength: 254
        bug_type:
          $ref: '#/components/schemas/BugTypeEnum'
        bug_other:
          type: string
          maxLength: 100
        issue:
          type: string
          maxLength: 1000
        image:
          type: string
          format: uri
          nullable: true
        status:
          $ref: '#/components/schemas/ReportBugStatusEnum'
        user:
          type: integer
          nullable: true
      required:
      - bug_type
      - created_at
      - id
      - issue
      - updated_at
    ReportBugStatusEnum:
      enum:
      - pending
      - resolved
      - rejected
      type: string
      description: |-
        * `pending` - Pending
        * `resolved` - Resolved
        * `rejected` - Rejected
    Review:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        body:
          type: string
          maxLength: 500
        star:
          allOf:
          - $ref: '#/components/schemas/StarEnum'
          minimum: -9223372036854775808
          maximum: 9223372036854775807
        reviewer:
          type: string
          format: uuid
      required:
      - created_at
      - id
      - reviewer
      - star
      - updated_at
    ReviewSerializerPublic:
      type: object
      properties:
        name:
          type: string
          readOnly: true
        image:
          type: string
          format: uri
          readOnly: true
        star:
          allOf:
          - $ref: '#/components/schemas/StarEnum'
          readOnly: true
        body:
          type: string
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - body
      - created_at
      - image
      - name
      - star
    RoleEnum:
      enum:
      - doctor
      - patient
      - admin
      type: string
      description: |-
        * `doctor` - Doctor
        * `patient` - Patient
        * `admin` - Admin
    Service:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        name:
          type: string
          maxLength: 20
        description:
          type: string
        image:
          type: string
          format: uri
      required:
      - created_at
      - description
      - id
      - image
      - name
      - updated_at
    Specialization:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        name:
          type: string
          nullable: true
          maxLength: 255
        description:
          type: string
          nullable: true
          maxLength: 1000
      required:
      - created_at
      - id
      - updated_at
    StarEnum:
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      type: integer
      description: |-
        * `1` - One Star
        * `2` - Two Stars
        * `3` - Three Stars
        * `4` - Four Stars
        * `5` - Five Stars
    Status77fEnum:
      enum:
      - pending
      - running
      - completed
      type: string
      description: |-
        * `pending` - Pending
        * `running` - Running
        * `completed` - Completed
    TokenRefresh:
      type: object
      properties:
        access:
          type: string
          readOnly: true
        refresh:
          type: string
      required:
      - access
      - refresh
    TokenVerify:
      type: object
      properties:
        token:
          type: string
          writeOnly: true
      required:
      - token
    UserList:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        password:
          type: string
          maxLength: 128
        last_login:
          type: string
          format: date-time
          nullable: true
        email:
          type: string
          format: email
          maxLength: 254
        is_active:
          type: boolean
        is_verified:
          type: boolean
        is_staff:
          type: boolean
        is_superuser:
          type: boolean
        role:
          $ref: '#/components/schemas/RoleEnum'
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
        groups:
          type: array
          items:
            type: integer
          description: The groups this user belongs to. A user will get all permissions
            granted to each of their groups.
        user_permissions:
          type: array
          items:
            type: integer
          description: Specific permissions for this user.
      required:
      - created_at
      - email
      - id
      - password
      - updated_at
    VerificationStatusEnum:
      enum:
      - pending
      - verified
      - rejected
      type: string
      description: |-
        * `pending` - Pending
        * `verified` - Verified
        * `rejected` - Rejected
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
tags:
- name: User-Authentication
- name: Patients
- name: profile migration
- name: Doctors
- name: Appointment
- name: user-feedback
- name: website-decoration
- name: Available Time OF Doctor
- name: Designation OF Doctor
- name: Specialization OF Doctor
- name: Review OF Doctor
- name: Qualifications OF Doctor