Mayank.Mishra/MinglarBackendNestJS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update CURL example and enhance Swagger documentation for admin profile update

Browse Source
This commit is contained in:
paritosh18
2025-12-08 16:58:30 +05:30
parent 76970c914e
commit f6e01ac9e3
2 changed files with 37 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CURL_EXAMPLE.md
View File

@@ -1,7 +1,7 @@
# CURL Command for Testing addCompanyDetails Lambda
## Prerequisites
1. Replace `YOUR_API_URL` with your actual API Gateway URL
1. Replace `YOUR_API_URL` with your actual API Gateway URL
2. Replace `YOUR_AUTH_TOKEN` with a valid JWT token
3. Replace file paths with actual document files on your system

38
swagger.json
View File

@@ -656,10 +656,44 @@
"patch": {
"tags": ["Minglar Admin - Auth"],
"summary": "Update Admin Profile",
"description": "Update Minglar admin profile with image",
"description": "Update Minglar admin profile with basic details, address and documents (profile image, Aadhar, PAN)",
"security": [{ "bearerAuth": [] }],
"requestBody": {
"content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "profileImage": { "type": "string", "format": "binary" } } } } }
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"userData": {
"type": "string",
"description": "JSON string with basic user details (firstName, lastName, mobileNumber, dateOfBirth)",
"example": "{\\\"firstName\\\": \\\"Sachin\\\", \\\"lastName\\\": \\\"AM\\\", \\\"mobileNumber\\\": \\\"+91987653210\\\", \\\"dateOfBirth\\\": \\\"1990-01-01\\\"}"
},
"addressData": {
"type": "string",
"description": "JSON string with address details (address1, stateXid, countryXid, cityXid, pinCode)",
"example": "{\\\"address1\\\": \\\"Girgardan Ghaat\\\", \\\"stateXid\\\": 1, \\\"countryXid\\\": 1, \\\"cityXid\\\": 1, \\\"pinCode\\\": \\\"12345\\\"}"
},
"profileImage": {
"type": "string",
"format": "binary",
"description": "Profile image file"
},
"aadharCard": {
"type": "string",
"format": "binary",
"description": "Aadhar card image/file"
},
"panCard": {
"type": "string",
"format": "binary",
"description": "PAN card image/file"
}
}
}
}
}
},
"responses": {
"200": { "description": "Profile updated" }