merged_openapi.json

{
  "openapi": "3.0.3",
  "info": {
    "title": "Turf Booking API",
    "version": "1.0.0"
  },
  "servers": [],
  "tags": [
    {
      "name": "admin",
      "description": "Admin endpoints"
    },
    {
      "name": "guest",
      "description": "Guest endpoints"
    }
  ],
  "paths": {
    "/api/bookings": {
      "get": {
        "summary": "Retrieve available time slots for booking.",
        "tags": [
          "guest"
        ],
        "parameters": [
          {
            "name": "date",
            "in": "query",
            "description": "The specific date for which time slots are requested (YYYY-MM-DD).",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response with available time slots.",
            "content": {
              "application/json": {
                "example": {
                  "success": true,
                  "data": {
                    "booking_by_date": {
                      "2024-12-15": [
                        {
                          "_id": "12345",
                          "guest_name": "Alex Xu",
                          "guest_phone": "+91-9876543210",
                          "guest_email": "Alex@email.com",
                          "booking_date": "2024-01-28",
                          "start_time": "8",
                          "end_time": "9",
                          "sports": "Cricket",
                          "attendees": 10,
                          "status": "CONFIRMED",
                          "admin_id": "65b646e7ef56fc00ce98df42"
                        }
                      ]
                    },
                    "admin_by_id": {
                      "65b646e7ef56fc00ce98df42": {
                        "_id": "65b646e7ef56fc00ce98df42",
                        "username": "admin_1",
                        "name": "Tars",
                        "phone": "1234567890",
                        "email": "admin_1@email.com"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request, invalid date format or missing parameter.",
            "content": {
              "application/json": {
                "example": {
                  "error": "Invalid date format. Please provide the date in YYYY-MM-DD format."
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Create a new booking for the selected time slot.",
        "tags": [
          "guest"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "guest_name": {
                    "type": "string",
                    "example": "Alex"
                  },
                  "guest_phone": {
                    "type": "string",
                    "example": "+91-9876543210"
                  },
                  "guest_email": {
                    "type": "string",
                    "example": "Alex@email.com"
                  },
                  "attendees": {
                    "type": "integer",
                    "example": 12
                  },
                  "date": {
                    "type": "string",
                    "format": "date",
                    "example": "2024-01-27"
                  },
                  "start_time": {
                    "type": "string",
                    "format": "time",
                    "example": "13:00"
                  },
                  "end_time": {
                    "type": "string",
                    "format": "time",
                    "example": "15:00"
                  },
                  "sports": {
                    "type": "string",
                    "format": "string",
                    "example": "Football"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Booking created successfully.",
            "content": {
              "application/json": {
                "example": {
                  "success": true,
                  "data": {
                    "booking_id": "1a2b3c"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request, invalid data format or missing parameters.",
            "content": {
              "application/json": {
                "example": {
                  "error": "Invalid data format. Please provide valid booking details."
                }
              }
            }
          }
        }
      }
    },
    "/api/bookings/{booking_id}": {
      "get": {
        "summary": "Retrieve booking details by booking ID",
        "tags": [
          "guest"
        ],
        "parameters": [
          {
            "name": "booking_id",
            "in": "path",
            "description": "ID of the booking",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "65b634486977c3aad4a5fa2e"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response with booking details",
            "content": {
              "application/json": {
                "example": {
                  "booking": {
                    "guest_name": "Alex Xu",
                    "guest_phone": "+91-9876543210",
                    "guest_email": "Alex@email.com",
                    "booking_date": "2024-01-28",
                    "start_time": "8",
                    "end_time": "9",
                    "sports": "Cricket",
                    "attendees": 10,
                    "status": "CONFIRMED",
                    "admin_id": "65b646e7ef56fc00ce98df42"
                  },
                  "admin_by_id": {
                    "65b646e7ef56fc00ce98df42": {
                      "_id": "65b646e7ef56fc00ce98df42",
                      "username": "admin_1",
                      "name": "Tars",
                      "phone": "1234567890",
                      "email": "admin_1@email.com"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Booking not found",
            "content": {
              "application/json": {
                "example": {
                  "error": "Booking not found"
                }
              }
            }
          }
        }
      }
    },
    "/api/admin/bookings": {
      "get": {
        "summary": "Retrieve the list of pending bookings.",
        "tags": [
          "admin"
        ],
        "responses": {
          "200": {
            "description": "Successful response with pending bookings.",
            "content": {
              "application/json": {
                "example": {
                  "success": true,
                  "data": [
                    {
                      "id": "1a2b3c",
                      "guestName": "John Doe",
                      "guestPhone": "+91-9876543210",
                      "guestEmail": "john@example.com",
                      "sports": "Cricket",
                      "attendees": 12,
                      "date": "2024-12-15",
                      "startTime": "08:00 AM",
                      "endTime": "09:00 AM",
                      "status": "pending"
                    },
                    {
                      "id": "4d5e6f",
                      "guestName": "Jane Doe",
                      "guestPhone": "+91-9876543211",
                      "guestEmail": "jane@example.com",
                      "sports": "Football",
                      "attendees": 15,
                      "date": "2024-12-20",
                      "startTime": "10:00 AM",
                      "endTime": "12:00 PM",
                      "status": "paid"
                    }
                  ]
                }
              }
            }
          },
          "404": {
            "description": "No pending bookings found.",
            "content": {
              "application/json": {
                "example": {
                  "error": "No pending bookings found."
                }
              }
            }
          }
        }
      }
    },
    "/api/admin/bookings/{bookingId}/confirm": {
      "put": {
        "summary": "Confirm the payment and mark the booking as booked.",
        "tags": [
          "admin"
        ],
        "parameters": [
          {
            "name": "bookingId",
            "in": "path",
            "description": "The ID of the booking to confirm payment and mark as booked.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response after confirming payment and marking as booked.",
            "content": {
              "application/json": {
                "example": {
                  "success": true
                }
              }
            }
          },
          "404": {
            "description": "Booking not found.",
            "content": {
              "application/json": {
                "example": {
                  "error": "Booking not found."
                }
              }
            }
          },
          "409": {
            "description": "Booking is already booked.",
            "content": {
              "application/json": {
                "example": {
                  "error": "Booking is already booked."
                }
              }
            }
          }
        }
      }
    },
    "/api/admin/login": {
      "post": {
        "summary": "Authenticate user with username and password",
        "tags": [
          "admin"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "username": {
                    "type": "string",
                    "example": "john_doe",
                    "description": "The username of the admin"
                  },
                  "password": {
                    "type": "string",
                    "example": "password123",
                    "description": "The password of the user"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Login successful",
            "content": {
              "application/json": {
                "example": {
                  "success": true
                }
              }
            },
            "headers": {
              "admin-cookie": {
                "description": "Cookie containing admin information",
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized, invalid credentials",
            "content": {
              "application/json": {
                "example": {
                  "success": false,
                  "error": "Invalid credentials"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "example": {
                  "success": false,
                  "error": "Internal Server Error"
                }
              }
            }
          }
        }
      }
    },
    "/api/admin/current": {
      "get": {
        "summary": "Get details of the currently logged-in admin user.",
        "tags": [
          "admin"
        ],
        "responses": {
          "200": {
            "description": "Successful response with admin user details.",
            "content": {
              "application/json": {
                "example": {
                  "success": true,
                  "data": {
                    "_id": "65b646e7ef56fc00ce98df40",
                    "username": "admin_1",
                    "name": "Tars",
                    "phone": "1234567890",
                    "email": "admin_1@email.com",
                    "__v": 0
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized. User not logged in.",
            "content": {
              "application/json": {
                "example": {
                  "success": false,
                  "error": "Unauthorized. User not logged in."
                }
              }
            }
          }
        }
      }
    },
    "/api/admin/logout": {
      "post": {
        "tags": [
          "admin"
        ],
        "summary": "Logs out current logged in admin session",
        "responses": {
          "200": {
            "description": "Successful response after confirming payment and marking as booked.",
            "content": {
              "application/json": {
                "example": {
                  "success": true
                }
              }
            }
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Unauthorized - user not logged in"
          }
        }
      }
    }
  },
  "components": {}
}