Merge pull request #138 from Facts-and-Files/feat/storyFieldList

feat: add fieldList parameter to story index response

Author: trenc

src/app/Http/Controllers/ResponseController.php

@@ -177,7 +177,7 @@ protected function filterDataByFieldlist(
         $fieldlist[] = $queries['orderBy'] ?? $initialSortColumn;
         $fieldlist = array_merge($defaults, $fieldlist);
         $fieldlist = array_unique($fieldlist);
-        $dataArray = $data->toArray()[0] ?: $data->toArray();
+        $dataArray = $data->toArray()[0] ?? $data->toArray();
         $fieldsToRemove = array_filter(array_keys($dataArray), function($field) use ($fieldlist) {
             return !in_array($field, $fieldlist);
         });

src/app/Http/Controllers/StoryController.php

@@ -28,6 +28,8 @@ public function index(Request $request): JsonResponse
 
         $data = $this->getDataByRequest($request, $model, $queryColumns, $initialSortColumn);
 
+        $data = $this->filterDataByFieldlist($data, $request, ['StoryId'], $initialSortColumn);
+
         if (!$data) {
             return $this->sendError('Invalid data', $request . ' not valid', 400);
         }

src/public/v2/documentation/swagger-initializer.js

@@ -1,22 +1,21 @@
 window.onload = function() {
-  //<editor-fold desc="Changeable Configuration Block">
-
-  // the following lines will be replaced by docker/configurator, when it runs in a docker-container
-  window.ui = SwaggerUIBundle({
-    url: window.location.origin + "/v2/documentation/api-docs.yaml",
-    dom_id: '#swagger-ui',
-    // deepLinking: true,
-    persistAuthorization: true,
-    filter: true,
-    presets: [
-      SwaggerUIBundle.presets.apis,
-      SwaggerUIStandalonePreset
-    ],
-    plugins: [
-      SwaggerUIBundle.plugins.DownloadUrl
-    ],
-    layout: "StandaloneLayout"
-  });
-
-  //</editor-fold>
+    window.ui = SwaggerUIBundle({
+        url: window.location.origin + "/v2/documentation/api-docs.yaml",
+        dom_id: '#swagger-ui',
+        docExpansion: 'none',
+        deepLinking: true,
+        persistAuthorization: true,
+        filter: true,
+        defaultModelsExpandDepth: 0,
+        docExpansion: 'none',
+        tagsSorter: 'alpha',
+        presets: [
+            SwaggerUIBundle.presets.apis,
+            SwaggerUIStandalonePreset,
+        ],
+        plugins: [
+            // SwaggerUIBundle.plugins.DownloadUrl
+        ],
+        layout: 'StandaloneLayout',
+    });
 };

src/storage/api-docs/api-docs.yaml

@@ -1,7 +1,7 @@
 openapi: 3.1.1
 
 info:
-  version: 1.56.0
+  version: 1.57.0
   title: Transcribathon Platform API v2
   description: This is the documentation of the Transcribathon API v2 used by [https:transcribathon.eu](https://transcribathon.eu/).<br />
          For authorization you can use the the bearer token you are provided with.

src/storage/api-docs/stories-path.yaml

@@ -37,6 +37,10 @@ get:
       description: Determine the type of query for the parameter (DcTitle, RecordId). If set, a broad search ( LIKE %term%) is processed otherwise the exact term is searched for
       schema:
         type: boolean
+    - in: query
+      name: fieldlist
+      description: Comma-separated list of fields that will be shown in the response
+      type: string
   responses:
     200:
       description: Ok