docs

backend/controllers/api/RulesController.js

@@ -1,7 +1,7 @@
 import express from 'express';
 
 /**
- * RulesController. API for the game rules manager
+ * RulesController. API for the game rules manager, граничен клас за комуникация с модула за игрови правила
  */
 class RulesController{
     
@@ -9,15 +9,15 @@ class RulesController{
     route = '/api/rule'
 
     /**
-     * Initializes the RulesController plugin
-     * @param {App} app The application instance
+     * Initializes the RulesController plugin, инициализация
+     * @param {App} app The application instance, апликация
      */
     init(app){
         const router = express.Router();
         const { rules } = app;
 
         /**
-         * API: PUT /api/rule/ Create or update rule
+         * API: PUT /api/rule/ Create or update rule, създаване/обновяване на игрово правило
          * @function createOrUpdate
          * @memberof RulesController
          */
@@ -26,7 +26,7 @@ class RulesController{
         });
 
         /**
-         * API: POST /api/rule/ List rules by given criteria
+         * API: POST /api/rule/ List rules by given criteria, търсене в игровите правила
          * @function list
          * @returns {Rule[]}
          * @memberof RulesController
@@ -35,9 +35,9 @@ class RulesController{
         })
 
         /**
-         * API: GET /api/rule/:id Retrieve rule by ID
+         * API: GET /api/rule/:id Retrieve rule by ID, извличане на игрово правило
          * @function read
-         * @param {string} id The id of the rule
+         * @param {string} id The id of the rule, идентификатор
          * @returns {Rule}
          * @memberof RulesController
          */
@@ -45,9 +45,9 @@ class RulesController{
         })
 
         /**
-         * API: DELETE /api/rule/:id Delete rule by ID
+         * API: DELETE /api/rule/:id Delete rule by ID, изтриване на игрово правило
          * @function remove
-         * @param {string} id The id of the rule
+         * @param {string} id The id of the rule, идентификатор
          * @memberof RulesController
          */
         router.delete('/:id', async (req, res)=>{