Mini Sprint API

[Hamdysaad20]

Minisprint Management API

GET /api/minisprintSystem/minisprint

Description:

Fetches a list of minisprints or a specific minisprint based on query parameters.

Query Parameters:

• name (optional): Name of the minisprint to retrieve.
• isActive (optional): Boolean to filter minisprints by their active status.

Response:

• 200 OK:

  • If name is provided and the minisprint is found:

    {
    "image": "string",
    "name": "string",
    "description": "string",
    "price": "string",
    "startDate": "string",
    "duration": "string",
    "isActive": "boolean",
    "keyLearnings": ["string"],
    "content": [
        {
            "icon": "string",
            "title": "string",
            "description": "string"
        }
    ],
    "requirements": ["string"]
    }

  • If isActive is provided:

    [
    {
        "image": "string",
        "name": "string",
        "description": "string",
        "price": "string",
        "startDate": "string",
        "duration": "string",
        "isActive": "boolean"
    },
    ...
    ]

  • If no query parameters are provided:

    [
    {
        "image": "string",
        "name": "string",
        "description": "string",
        "price": "string",
        "startDate": "string",
        "duration": "string",
        "isActive": "boolean"
    },
    ...
    ]

• 404 Not Found: Minisprint not found when name is provided.

Example:

GET /api/minisprintSystem/minisprint?name=exampleMinisprint

POST /api/minisprintSystem/minisprint

Description:

Creates a new minisprint.

Request Body:

{
    "image": "string",
    "name": "string",
    "description": "string",
    "price": "string",
    "startDate": "string",
    "duration": "string",
    "isActive": "boolean",
    "keyLearnings": ["string"],
    "content": [
        {
            "icon": "string",
            "title": "string",
            "description": "string"
        }
    ],
    "requirements": ["string"]
}

Response:

• 201 Created:

  {
      "message": "Minisprint created successfully"
  }

• 400 Bad Request: Validation error.

• 409 Conflict: Minisprint already exists.

PUT /api/minisprintSystem/minisprint

Description:

Edits an existing minisprint.

Request Body:

{
    "name": "string",
    "description": "string",
    "price": "string",
    "startDate": "string",
    "duration": "string",
    "isActive": "boolean",
    "keyLearnings": ["string"],
    "content": [
        {
            "icon": "string",
            "title": "string",
            "description": "string"
        }
    ],
    "requirements": ["string"]
}

Response:

• 200 OK:

  {
      "message": "Minisprint updated successfully"
  }

• 400 Bad Request: Validation error.

• 404 Not Found: Minisprint not found.

DELETE /api/minisprintSystem/minisprint

Description:

Deletes a minisprint.

Query Parameters:

• name (required): Name of the minisprint to delete.

Response:

• 200 OK:

  {
      "message": "Minisprint deleted successfully"
  }

• 404 Not Found: Minisprint not found.

---

Booking Management API

GET /api/minisprintSystem/book

Description:

Fetches all bookings.

Response:

• 200 OK:

  [
      {
          "id": "number",
          "minisprintName": "string",
          "user": {
              "name": "string",
              "email": "string"
          },
          "is_paid": "boolean"
      },
      ...
  ]

POST /api/minisprintSystem/book

Description:

Creates a new booking.

Request Body:

{
    "minisprintName": "string",
    "user": {
        "name": "string",
        "email": "string"
    },
    "is_paid": "boolean"
}

Response:

• 201 Created:

  {
      "message": "Booking created successfully",
      "id": "number"
  }

• 400 Bad Request: Validation error.

PUT /api/minisprintSystem/book

Description:

Edits an existing booking.

Request Body:

{
    "id": "number",
    "minisprintName": "string",
    "user": {
        "name": "string",
        "email": "string"
    },
    "is_paid": "boolean"
}

Response:

• 200 OK:

  {
      "message": "Booking updated successfully"
  }

• 400 Bad Request: Validation error.

• 404 Not Found: Booking not found.

---

Common Responses

405 Method Not Allowed

• Response:

  {
      "message": "Method not allowed"
  }

Helper Functions

readJSON(filePath)

Reads a JSON file from the given file path and returns the parsed data.

writeJSON(filePath, data)

Writes the provided data as JSON to the given file path.

---

Usage Example

Get all minisprints

GET /api/minisprintSystem/minisprint

Get a specific minisprint by name

GET /api/minisprintSystem/minisprint?name=exampleMinisprint

Get minisprints by active status

GET /api/minisprintSystem/minisprint?isActive=true

Add a new minisprint

POST /api/minisprintSystem/minisprint
Content-Type: application/json
{
    "image": "url_to_image",
    "name": "New Minisprint",
    "description": "Description of the minisprint",
    "price": "$100",
    "startDate": "2024-07-01",
    "duration": "2 weeks",
    "isActive": true,
    "keyLearnings": ["Point 1", "Point 2"],
    "content": [
        {
            "icon": "url_to_icon",
            "title": "Content Title",
            "description": "Content description"
        }
    ],
    "requirements": ["Requirement 1", "Requirement 2"]
}

Edit an existing minisprint

PUT /api/minisprintSystem/minisprint
Content-Type: application/json
{
    "name": "New Minisprint",
    "description": "Updated description"
}

Delete a minisprint

DELETE /api/minisprintSystem/minisprint?name=New Minisprint

Get all bookings

GET /api/minisprintSystem/book

Create a new booking

POST /api/minisprintSystem/book
Content-Type: application/json
{
    "minisprintName": "New Minisprint",
    "user": {
        "name": "John Doe",
        "email": "john.doe@example.com"
    },
    "is_paid": true
}

Edit an existing booking

PUT /api/minisprintSystem/book
Content-Type: application/json
{
    "id": 1,
    "is_paid": false
}