fossology · GMishx · Oct 3, 2023 · Aug 8, 2023 · Oct 3, 2023
diff --git a/src/www/ui/api/Controllers/ObligationController.php b/src/www/ui/api/Controllers/ObligationController.php
@@ -74,15 +74,47 @@ function obligationsDetails($request, $response, $args)
       return $response->withJson($returnVal->getArray(), $returnVal->getCode());
     }
 
+    $obligation = $this->createExtendedObligationFromId($obligationId);
+    return $response->withJson($obligation->getArray(), 200);
+  }
+
+  /**
+   * Get details of all obligations
+   *
+   * @param  ServerRequestInterface $request
+   * @param  ResponseHelper         $response
+   * @param  array                  $args
+   * @return ResponseHelper
+   */
+
+  function obligationsAllDetails($request, $response, $args)
+  {
+    $obligationArray = [];
+    $listVal = $this->obligationMap->getObligations();
+    foreach ($listVal as $val) {
+      $obligationId = intval($val['ob_pk']);
+      $obligationArray[] = $this->createExtendedObligationFromId($obligationId)
+        ->getArray();
+    }
+    return $response->withJson($obligationArray, 200);
+  }
+
+  /**
+   * Create extended Obligation Model object for a given obligation ID.
+   *
+   * @param int $obligationId Obligation ID to get object for
+   * @return Obligation Obligation model object for given id
+   */
+  private function createExtendedObligationFromId($obligationId)
+  {
     $obligationInfo = $this->obligationMap->getObligationById($obligationId);
     $licenses = $this->obligationMap->getLicenseList($obligationId);
     $candidateLicenses = $this->obligationMap->getLicenseList($obligationId,
       true);
     $associatedLicenses = explode(";", $licenses);
     $associatedCandidateLicenses = explode(";", $candidateLicenses);
 
-    $obligation = Obligation::fromArray($obligationInfo, true,
+    return Obligation::fromArray($obligationInfo, true,
       $associatedLicenses, $associatedCandidateLicenses);
-    return $response->withJson($obligation->getArray(), 200);
   }
 }
diff --git a/src/www/ui/api/Models/Obligation.php b/src/www/ui/api/Models/Obligation.php
@@ -93,6 +93,7 @@ class Obligation
    * @param string $text
    * @param string $classification
    * @param string $comment
+   * @param boolean $extended
    */
   public function __construct($id, $topic = "", $type = "", $text = "",
     $classification = "", $comment = "", $extended = false)

diff --git a/src/www/ui/api/documentation/openapi.yaml b/src/www/ui/api/documentation/openapi.yaml
@@ -282,6 +282,25 @@ paths:
                 $ref: '#/components/schemas/ObligationExtended'
         default:
           $ref: '#/components/responses/defaultResponse'
+  /obligations:
+    get:
+      operationId: getAllObligationsData
+      tags:
+        - Admin
+      summary: Get details of a all obligations
+      description: >
+        Get the details of all obligations from the server.
+      responses:
+        '200':
+          description: The API information
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/ObligationExtended'
+        default:
+          $ref: '#/components/responses/defaultResponse'
 
   /uploads/{id}:
     parameters:

diff --git a/src/www/ui/api/index.php b/src/www/ui/api/index.php
@@ -24,24 +24,24 @@
 use Fossology\Lib\Util\TimingLogger;
 use Fossology\UI\Api\Controllers\AuthController;
 use Fossology\UI\Api\Controllers\BadRequestController;
+use Fossology\UI\Api\Controllers\ConfController;
+use Fossology\UI\Api\Controllers\CopyrightController;
+use Fossology\UI\Api\Controllers\CustomiseController;
+use Fossology\UI\Api\Controllers\FileInfoController;
 use Fossology\UI\Api\Controllers\FileSearchController;
 use Fossology\UI\Api\Controllers\FolderController;
 use Fossology\UI\Api\Controllers\GroupController;
 use Fossology\UI\Api\Controllers\InfoController;
-use Fossology\UI\Api\Controllers\FileInfoController;
 use Fossology\UI\Api\Controllers\JobController;
-use Fossology\UI\Api\Controllers\CopyrightController;
 use Fossology\UI\Api\Controllers\LicenseController;
 use Fossology\UI\Api\Controllers\MaintenanceController;
-use Fossology\UI\Api\Controllers\OverviewController;
 use Fossology\UI\Api\Controllers\ObligationController;
+use Fossology\UI\Api\Controllers\OverviewController;
 use Fossology\UI\Api\Controllers\ReportController;
 use Fossology\UI\Api\Controllers\SearchController;
-use Fossology\UI\Api\Controllers\ConfController;
 use Fossology\UI\Api\Controllers\UploadController;
 use Fossology\UI\Api\Controllers\UploadTreeController;
 use Fossology\UI\Api\Controllers\UserController;
-use Fossology\UI\Api\Controllers\CustomiseController;
 use Fossology\UI\Api\Helper\ResponseFactoryHelper;
 use Fossology\UI\Api\Helper\ResponseHelper;
 use Fossology\UI\Api\Middlewares\FossologyInitMiddleware;
@@ -229,6 +229,7 @@ function (\Slim\Routing\RouteCollectorProxy $app) {
   function (\Slim\Routing\RouteCollectorProxy $app) {
     $app->get('/list', ObligationController::class . ':obligationsList');
     $app->get('/{id:\\d+}', ObligationController::class . ':obligationsDetails');
+    $app->get('', ObligationController::class . ':obligationsAllDetails');
     $app->any('/{params:.*}', BadRequestController::class);
   });