From 7fb1d4f1f5a281b2fd980ac5be0eac52cb74ee9b Mon Sep 17 00:00:00 2001
From: Vivy Bot <git@arrafif.com>
Date: Fri, 6 Feb 2026 22:26:11 +0700
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20add=20documentation=20fo?=
 =?UTF-8?q?r=20get=20episode=20detail=20controller?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../getEpisodeDetails.controller.ts           | 33 +++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/src/modules/episode/controllers/getEpisodeDetails.controller.ts b/src/modules/episode/controllers/getEpisodeDetails.controller.ts
index a1f83f1..35982cd 100644
--- a/src/modules/episode/controllers/getEpisodeDetails.controller.ts
+++ b/src/modules/episode/controllers/getEpisodeDetails.controller.ts
@@ -8,6 +8,39 @@ export interface GetEpisodeDetailsParams {
   episode?: string;
 }
 
+/**
+ * @function getEpisodeDetailsController
+ * @description Controller to handle fetching episode details based on provided parameters.
+ *
+ * @param {Context & { params: GetEpisodeDetailsParams }} ctx
+ * The context object containing the request body.
+ * The params must include:
+ * - mediaSlug?: string - The slug of the media to which the episode belongs.
+ * - episode?: string - The identifier of the episode.
+ *
+ * @example
+ * Request route: GET /episodes/:mediaSlug/:episode
+ *
+ * @returns {Promise<Object>}
+ * A response object indicating success or failure.
+ * Return example:
+ * {
+ *   success: true,
+ *   status: 200,
+ *   message: "Episode details fetched successfully.",
+ *   data: { ...episodeDetails } // Data returned only if the env run on development mode
+ * }
+ *
+ * @throws {Object}
+ * An error response object if validation fails or an error occurs during bulk insert operation.
+ * Return example:
+ * {
+ *   success: false,
+ *   status: <Status Code>,
+ *   message: "<Error Message>",
+ *   error: { ...errorDetails } // Additional error details if available and the env run on development mode
+ * }
+ */
 export const getEpisodeDetailsController = async (
   ctx: Context & { params: GetEpisodeDetailsParams },
 ) => {