docs

Author: mstgnz

docs/api.md

@@ -56,6 +56,68 @@ X-RateLimit-Reset: 1640995200
 
 ## Endpoints
 
+### System Operations
+
+#### Health Check
+```http
+GET /health
+```
+Returns health status of all services (MinIO, AWS, Cache).
+
+Response:
+```json
+{
+    "status": "healthy",
+    "services": {
+        "minio": "connected",
+        "aws": "connected",
+        "cache": "connected"
+    },
+    "timestamp": "2024-01-15T10:30:00Z"
+}
+```
+
+#### Metrics
+```http
+GET /metrics
+```
+Returns Prometheus format metrics.
+
+#### WebSocket Connection
+```http
+GET /ws
+```
+Establishes WebSocket connection for real-time monitoring.
+
+#### Monitor Stats
+```http
+GET /monitor
+```
+Returns current system statistics.
+
+Response:
+```json
+{
+    "status": true,
+    "message": "success",
+    "data": {
+        "timestamp": "2024-01-15T10:30:00Z",
+        "active_uploads": 5,
+        "upload_speed": 1048576,
+        "cache_hit_rate": 85.5,
+        "cpu_usage": 45.2,
+        "memory_usage": 60.8,
+        "disk_usage": {
+            "/data": 75,
+            "/uploads": 45
+        },
+        "errors": [
+            "Failed to process image: invalid format"
+        ]
+    }
+}
+```
+
 ### Image Operations
 
 #### Get Image
@@ -86,42 +148,132 @@ Body:
 - `bucket`: Bucket name
 - `path`: Storage path (optional)
 - `aws_upload`: Boolean flag for AWS upload (optional)
+- `width`: Target width in pixels (optional)
+- `height`: Target height in pixels (optional)
+
+Response: Standard success response
+
+#### Batch Upload
+```http
+POST /batch/upload
+```
+Headers:
+- `Content-Type: multipart/form-data`
+- `Authorization: Bearer <token>`
+
+Body:
+- `files[]`: Multiple image files (max 10)
+- `bucket`: Target bucket name
+- `path`: Storage path (optional)
+- `aws_upload`: Boolean flag for AWS upload (optional)
+- `width`: Target width in pixels (optional)
+- `height`: Target height in pixels (optional)
 
 Response:
 ```json
 {
     "status": true,
-    "message": "Success",
-    "data": {
-        "minioUpload": "Minio Successfully Uploaded size 1024",
-        "minioResult": {
-            "bucket": "test-bucket",
-            "key": "path/image.jpg",
-            "size": 1024
+    "message": "Batch upload successful",
+    "data": [
+        {
+            "filename": "image1.jpg",
+            "success": true,
+            "result": {...}
         },
-        "awsUpload": "S3 Successfully Uploaded",
-        "awsResult": "...",
-        "imageName": "image.jpg",
-        "objectName": "path/image.jpg",
-        "link": "https://cdn.example.com/bucket/path/image.jpg"
-    }
+        {
+            "filename": "image2.jpg",
+            "success": true,
+            "result": {...}
+        }
+    ]
 }
 ```
 
-#### Upload Image with AWS
+#### Upload from URL
 ```http
-POST /upload-with-aws
+POST /upload-url
+```
+Headers:
+- `Content-Type: application/json`
+- `Authorization: Bearer <token>`
+
+Body:
+```json
+{
+    "url": "https://example.com/image.jpg",
+    "bucket": "my-bucket",
+    "path": "optional/path",
+    "aws_upload": false
+}
 ```
-Similar to `/upload` but stores in both Minio and AWS S3.
 
-#### Upload Image from URL
+Response: Standard success response
+
+#### Resize Image
 ```http
-POST /upload-url
+POST /resize
 ```
+Headers:
+- `Content-Type: multipart/form-data`
+- `Authorization: Bearer <token>`
+
 Body:
-- `url`: Source image URL
+- `file`: Image file
+- `width`: Target width in pixels (optional)
+- `height`: Target height in pixels (optional)
+
+Response: Resized image file
+
+#### Delete Image
+```http
+DELETE /:bucket/*
+```
+Parameters:
 - `bucket`: Bucket name
-- `path`: Storage path (optional)
+- `*`: Image path
+- `aws_delete`: Boolean query parameter for AWS deletion (optional)
+
+Response: Standard success response
+
+#### Batch Delete
+```http
+DELETE /batch/delete
+```
+Headers:
+- `Content-Type: application/json`
+- `Authorization: Bearer <token>`
+
+Body:
+```json
+{
+    "bucket": "my-bucket",
+    "files": [
+        "path/to/image1.jpg",
+        "path/to/image2.jpg"
+    ],
+    "aws_delete": false
+}
+```
+
+Response:
+```json
+{
+    "status": true,
+    "message": "Batch deletion successful",
+    "data": [
+        {
+            "filename": "image1.jpg",
+            "success": true,
+            "error": null
+        },
+        {
+            "filename": "image2.jpg",
+            "success": true,
+            "error": null
+        }
+    ]
+}
+```
 
 ### Storage Operations
 
@@ -140,32 +292,6 @@ GET /minio/:bucket/create
 GET /minio/:bucket/delete
 ```
 
-### Monitoring
-```http
-GET /metrics
-```
-Returns Prometheus metrics for:
-- HTTP request counts
-- Request durations
-- Image processing durations
-- Storage operation durations
-
-## Error Responses
-```json
-{
-    "status": false,
-    "message": "Error description",
-    "data": null
-}
-```
-
-Common HTTP Status Codes:
-- 200: Success
-- 400: Bad Request
-- 401: Unauthorized
-- 429: Too Many Requests
-- 500: Internal Server Error 
-
 ## Error Codes
 - `RATE_LIMIT_EXCEEDED`: Request rate limit exceeded
 - `INVALID_TOKEN`: Authentication token is invalid
@@ -174,4 +300,8 @@ Common HTTP Status Codes:
 - `INVALID_FILE_TYPE`: Unsupported file type
 - `STORAGE_ERROR`: Error during storage operation
 - `AWS_UPLOAD_FAILED`: AWS S3 upload failed
-- `MINIO_UPLOAD_FAILED`: MinIO upload failed 
+- `MINIO_UPLOAD_FAILED`: MinIO upload failed
+- `BATCH_SIZE_EXCEEDED`: Too many files in batch operation
+- `BATCH_OPERATION_FAILED`: Batch operation partially failed
+- `CIRCUIT_BREAKER_OPEN`: Service temporarily unavailable
+- `TOO_MANY_REQUESTS`: Concurrent request limit exceeded