Merge pull request #8 from saddamarbaa/docs/add-remove-reviews-comments-api-docs

docs: add api docs for delete reviews & comments endpoint

Author: saddamarbaa

src/services/product.service.ts

@@ -294,7 +294,7 @@ export const deleteReviewService = async (
       customResponse<typeof data>({
         success: true,
         error: false,
-        message: `Successfully deleted review to product : ${req.params.productId} `,
+        message: `Successfully deleted review from product by ID : ${req.params.productId} `,
         status: 200,
         data,
       })

swagger/swagger.yaml

@@ -309,6 +309,63 @@ paths:
               schema:
                 '$ref': '#/components/schemas/ServerErrorResponse'
 
+  /products/reviews/{productId}:
+    delete:
+      security:
+        - Authorization: []
+      summary: Delete review and comment based on request id
+      tags:
+        - Product
+      parameters:
+        - in: path
+          name: productId
+          required: true
+          description: Unique id
+          schema:
+            type: string
+            minimum: 1
+            example: 6398540ee6e5ae8c37c333ac
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                    description:
+                  error:
+                    type: boolean
+                    example: false
+                  status:
+                    type: integer
+                    example: 200
+                  message:
+                    type: string
+                    example: Successfully deleted review from product by ID ...
+                  data:
+                    type: object
+                    properties:
+                      product:
+                        type: object
+                        '$ref': '#/components/schemas/ProductResponse'
+        '400':
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                '$ref': '#/components/schemas/BadRequestResponse'
+
+        '500':
+          description: 500 Internal Server Error
+          content:
+            application/json:
+              schema:
+                '$ref': '#/components/schemas/ServerErrorResponse'
+
   # Cart
 
   /cart: