fix: checkstyle errors

datakaveri · Sep 19, 2023 · 2e78987 · 2e78987
1 parent d88a7a7
commit 2e78987
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 3 deletions.
diff --git a/docs/openapi.yaml b/docs/openapi.yaml
@@ -490,7 +490,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/listTypesSuccessResponse'
+                oneOf:
+                 - $ref: '#/components/schemas/listTypesSuccessResponse'
+                 - $ref: '#/components/schemas/listTypesOwner'
         '400':
           description: Bad Request
           content:
@@ -2119,6 +2121,45 @@ components:
         type: 'urn:dx:cat:InvalidSyntax'
         title: Invalid Syntax
         detail: Wrong Item Type
+    listTypesOwner:
+      type: object
+      title: Response for list owner
+      description: API response when item type is owner
+      properties:
+        type:
+          type: string
+          description: |
+            URN type of the response indicating if the query was successful or if any errors have
+            been triggered.
+        title:
+          description: A human readable title to the message response.
+        totalHits:
+          type: integer
+          description: Total number of documents which matched the query.
+          format: int32
+        results:
+          type: array
+          description: Results which matched the query. This is an array of objects.
+          items:
+            type: object
+      required:
+        - type
+      example:
+        type: urn:dx:cat:Success
+        title: Success
+        totalHits: 1
+        results:
+          - '@context': https://voc.iudx.org.in/
+            type:
+              - iudx:Owner
+            name: IudxOwner
+            description: owner item for IUDX entities
+            id: cc18c925-8990-3a07-9cac-0bb2bd8166f6
+            itemStatus: ACTIVE
+            itemCreatedAt: 2023-09-08T10:00:02+0530
+
+
+
     invalidIdErrorResponse:
       type: object
       title: Invalid ID

diff --git a/src/main/java/iudx/catalogue/server/apiserver/ListApis.java b/src/main/java/iudx/catalogue/server/apiserver/ListApis.java
@@ -3,8 +3,9 @@
  *
  * <h1>SearchApis.java</h1>
  *
- * Callback handlers for List APIS
+ * <p>Callback handlers for List APIS
  */
+
 package iudx.catalogue.server.apiserver;
 
 import static iudx.catalogue.server.apiserver.util.Constants.*;

diff --git a/src/main/java/iudx/catalogue/server/database/DatabaseService.java b/src/main/java/iudx/catalogue/server/database/DatabaseService.java
@@ -114,7 +114,7 @@ DatabaseService nlpSearchLocationQuery(JsonArray request, JsonObject queryParams
   DatabaseService listItems(JsonObject request, Handler<AsyncResult<JsonObject>> handler);
 
   /**
-   *  The listOwnerOrCos implements the fetch of entire owner or cos item from the database
+   *  The listOwnerOrCos implements the fetch of entire owner or cos item from the database.
    *
    * @param request which is a JsonObject
    * @param handler which is a Request Handler