OHRM5X-2144: Add employee leave balances API doc (orangehrm#1672)

* OHRM5X-1995: Improve InstallerCountryListCommand

* OHRM5X-2155: Bump REST API version

* Fix email queue failing status

* [BC Break] Refactor LeaveCommentModel & LeaveRequestCommentModel

* OHRM5X-2160: Bump MariaDB max supported version to 10.11

Author: RajithaKumara

.github/workflows/scheduled_test.yml

@@ -4,6 +4,9 @@ on:
   push:
     branches:
       - main
+  pull_request:
+    paths:
+      - '.github/workflows/scheduled_test.yml'
   schedule:
     - cron: "0 2 * * *"
 
@@ -31,6 +34,7 @@ jobs:
           - "mariadb:10.8"
           - "mariadb:10.9"
           - "mariadb:10.10"
+          - "mariadb:10.11"
 
     services:
       mysql:

installer/Command/InstallerCountryListCommand.php

@@ -22,6 +22,7 @@
 use OrangeHRM\Installer\Framework\InstallerCommand;
 use OrangeHRM\Installer\Util\InstanceCreationHelper;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
 class InstallerCountryListCommand extends InstallerCommand
@@ -34,6 +35,14 @@ public function getCommandName(): string
         return 'install:country-list';
     }
 
+    /**
+     * @inheritDoc
+     */
+    protected function configure(): void
+    {
+        $this->addOption('country', 'c', InputOption::VALUE_REQUIRED);
+    }
+
     /**
      * @inheritDoc
      */
@@ -45,6 +54,19 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         );
         asort($countries);
         $countries = array_map(fn ($country) => strtolower($country), $countries);
+
+        $country = $input->getOption('country');
+        if ($country !== null) {
+            $countries = array_flip($countries);
+            $country = $countries[strtolower($country)] ?? null;
+            if ($country == null) {
+                $this->getIO()->error('Invalid country');
+                return self::FAILURE;
+            }
+            $this->getIO()->writeln($country);
+            return self::SUCCESS;
+        }
+
         $countries = array_map(static function ($k, $v) {
             return " <comment>[$k]</comment> $v";
         }, array_keys($countries), array_values($countries));

installer/config/system_requirements.php

@@ -32,7 +32,7 @@
 
     'mariadbversion' => [
         'min' => '5.5',
-        'max' => '10.10',
+        'max' => '10.11',
         'excludeRange' => [],
     ],
 

src/client/src/orangehrmMaintenancePlugin/components/VerifyPassword.vue

@@ -51,7 +51,7 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
-        "zircote/swagger-php": "^4.5"
+        "zircote/swagger-php": "~4.7.9"
     },
     "autoload": {
         "psr-4": {

src/composer.json

@@ -52,7 +52,7 @@ class Config
 
     public const PRODUCT_NAME = 'OrangeHRM OS';
     public const PRODUCT_VERSION = '5.4';
-    public const ORANGEHRM_API_VERSION = '2.2.0';
+    public const ORANGEHRM_API_VERSION = '2.4.0';
     public const PRODUCT_MODE = self::MODE_DEV;
     public const REGISTRATION_URL = 'https://ospenguin.orangehrm.com';
 

src/composer.lock

@@ -260,25 +260,29 @@ public function getValidationRuleForDelete(): ParamRuleCollection
     }
 
     /**
-     *@OA\Get(
+     * @OA\Get(
      *     path="/api/v2/admin/email-subscriptions/{emailSubscriptionId}/subscribers/{id}",
      *     tags={"Admin/Email Configuration"},
-     * @OA\PathParameter(
-     *     name="id",
-     *     @OA\Schema(type="integer")
-     * ),
-     * @OA\Response(
-     *     response="200",
-     *     description="Success",
-     *     @OA\JsonContent(
-     *         @OA\Property(
-     *             property="data",
-     *             ref="#/components/schemas/Admin-EmailSubscriberModel"
-     *         ),
-     *         @OA\Property(property="meta", type="object")
-     *     )
-     * ),
-     * @OA\Response(response="404", ref="#/components/responses/RecordNotFound")
+     *     @OA\PathParameter(
+     *         name="emailSubscriptionId",
+     *         @OA\Schema(type="integer")
+     *     ),
+     *     @OA\PathParameter(
+     *         name="id",
+     *         @OA\Schema(type="integer")
+     *     ),
+     *     @OA\Response(
+     *         response="200",
+     *         description="Success",
+     *         @OA\JsonContent(
+     *             @OA\Property(
+     *                 property="data",
+     *                 ref="#/components/schemas/Admin-EmailSubscriberModel"
+     *             ),
+     *             @OA\Property(property="meta", type="object")
+     *         )
+     *     ),
+     *     @OA\Response(response="404", ref="#/components/responses/RecordNotFound")
      * )
      *
      * @inheritDoc
@@ -329,10 +333,6 @@ public function getValidationRuleForGetOne(): ParamRuleCollection
      *         name="id",
      *         @OA\Schema(type="integer")
      *     ),
-     *     @OA\PathParameter(
-     *         name="id",
-     *         @OA\Schema(type="integer")
-     *     ),
      *     @OA\RequestBody(
      *         @OA\JsonContent(
      *             type="object",

src/lib/config/Config.php

@@ -70,25 +70,25 @@ public function setJobCategoryService(JobCategoryService $jobCategoryService)
     }
 
     /**
-     *@OA\Get(
+     * @OA\Get(
      *     path="/api/v2/admin/job-categories/{id}",
      *     tags={"Admin/Job Category"},
-     * @OA\PathParameter(
-     *     name="id",
-     *     @OA\Schema(type="integer")
-     * ),
-     * @OA\Response(
-     *     response="200",
-     *     description="Success",
-     *     @OA\JsonContent(
-     *         @OA\Property(
-     *             property="data",
-     *             ref="#/components/schemas/Admin-JobCategoryModel"
-     *         ),
-     *         @OA\Property(property="meta", type="object")
-     *     )
-     * ),
-     * @OA\Response(response="404", ref="#/components/responses/RecordNotFound")
+     *     @OA\PathParameter(
+     *         name="id",
+     *         @OA\Schema(type="integer")
+     *     ),
+     *     @OA\Response(
+     *         response="200",
+     *         description="Success",
+     *         @OA\JsonContent(
+     *             @OA\Property(
+     *                 property="data",
+     *                 ref="#/components/schemas/Admin-JobCategoryModel"
+     *             ),
+     *             @OA\Property(property="meta", type="object")
+     *         )
+     *     ),
+     *     @OA\Response(response="404", ref="#/components/responses/RecordNotFound")
      * )
      *
      * @inheritDoc
@@ -125,7 +125,7 @@ public function getValidationRuleForGetOne(): ParamRuleCollection
      *         name="sortField",
      *         in="query",
      *         required=false,
-     *         description="Available values : jc.name"
+     *         @OA\Schema(type="string", enum={"jc.name"})
      *     ),
      *     @OA\Parameter(ref="#/components/parameters/sortOrder"),
      *     @OA\Parameter(ref="#/components/parameters/limit"),

src/plugins/orangehrmAdminPlugin/Api/EmailSubscriberAPI.php

@@ -38,9 +38,7 @@
  *     @OA\Property(
  *         property="employees",
  *         type="array",
- *         @OA\Items(
- *             @OA\Property(ref="#/components/schemas/Pim-EmployeeModel"),
- *         )
+ *         @OA\Items(ref="#/components/schemas/Pim-EmployeeModel")
  *     )
  * )
  */

src/plugins/orangehrmAdminPlugin/Api/JobCategoryAPI.php

@@ -189,6 +189,10 @@ public function getValidationRuleForGetAll(): ParamRuleCollection
      * @OA\Post(
      *     path="/api/v2/admin/pay-grades/{payGradeId}/currencies",
      *     tags={"Admin/Pay Grade"},
+     *     @OA\PathParameter(
+     *         name="payGradeId",
+     *         @OA\Schema(type="integer")
+     *     ),
      *     @OA\RequestBody(
      *         @OA\JsonContent(
      *             type="object",
@@ -301,6 +305,10 @@ public function getValidationRuleForUpdate(): ParamRuleCollection
      * @OA\Delete(
      *     path="/api/v2/admin/pay-grades/{payGradeId}/currencies",
      *     tags={"Admin/Pay Grade"},
+     *     @OA\PathParameter(
+     *         name="payGradeId",
+     *         @OA\Schema(type="integer")
+     *     ),
      *     @OA\RequestBody(ref="#/components/requestBodies/DeleteRequestBody"),
      *     @OA\Response(response="200", ref="#/components/responses/DeleteResponse")
      * )