> ## Documentation Index
> Fetch the complete documentation index at: https://internal.mechzie.in/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Readiness check with DB and Redis probes



## OpenAPI

````yaml /openapi.yaml get /health/ready
openapi: 3.1.0
info:
  title: MechZie API
  version: 1.0.0-rc1
  description: On-demand roadside mechanic dispatch service API (MechZie)
  contact:
    name: MechZie Support
    email: support@mechzie.com
  license:
    name: MIT
    identifier: MIT
servers:
  - url: http://localhost:3000
    description: Local development
  - url: https://mechzie-api-399967621389.asia-south1.run.app/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: auth
    description: Authentication and token management
  - name: users
    description: User profile operations
  - name: vehicles
    description: Customer vehicle management
  - name: mechanics
    description: Mechanic profile and availability
  - name: jobs
    description: Job lifecycle and line items
  - name: tracking
    description: Real-time location tracking
  - name: payments
    description: Razorpay payment integration
  - name: wallet
    description: Mechanic wallet, UPI accounts, disputes, refunds, and settlements
  - name: ratings
    description: Customer and mechanic ratings
  - name: service-categories
    description: Service category management
  - name: notifications
    description: Push notifications and FCM tokens
  - name: uploads
    description: S3 presigned URL generation
  - name: admin
    description: Admin dashboard and management
  - name: super-admin
    description: Super-admin only operations (invite management, role assignment)
  - name: comms
    description: In-job audio calls (100ms) and persistent chat (Socket.IO + REST)
  - name: call
    description: >-
      Call signaling layer — initiate, accept, decline, cancel, end (ringing via
      FCM + Redis over 100ms rooms)
  - name: health
    description: Health check endpoints
paths:
  /health/ready:
    get:
      tags:
        - health
      summary: Readiness check with DB and Redis probes
      responses:
        '200':
          description: All systems ready
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadinessCheck'
        '503':
          description: One or more systems degraded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadinessCheck'
      security: []
components:
  schemas:
    ReadinessCheck:
      type: object
      properties:
        status:
          type: string
          enum:
            - ready
            - degraded
        timestamp:
          type: string
          format: date-time
        checks:
          type: object
          properties:
            database:
              type: object
              properties:
                ok:
                  type: boolean
                latencyMs:
                  type: number
                error:
                  type: string
            redis:
              type: object
              properties:
                ok:
                  type: boolean
                latencyMs:
                  type: number
                error:
                  type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT access token from /auth/verify-otp

````