changes for PR

serviceAPIs/queryAPI.yaml

@@ -37,7 +37,7 @@ paths:
       summary: Create a new client
       description: Creates a new client with the provided details.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       requestBody:
         description: The details required to create a client
         required: true
@@ -74,7 +74,7 @@ paths:
       summary: Get a client by ID
       description: Retrieves a specific client by its ID.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       responses:
         "200":
           description: Client details.
@@ -100,7 +100,7 @@ paths:
       summary: Update a client
       description: Updates an existing client with new details.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       requestBody:
         description: The details to update
         required: true
@@ -131,7 +131,7 @@ paths:
       summary: List queries
       description: Retrieves a list of queries based on filter criteria.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       responses:
         "200":
           description: A list of queries.
@@ -157,7 +157,7 @@ paths:
       summary: Create a new query
       description: Creates a new query with the provided details.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       requestBody:
         description: The details required to create a query
         required: true
@@ -194,7 +194,7 @@ paths:
       summary: Get a query by ID
       description: Retrieves a specific query by its ID.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       responses:
         "200":
           description: Query details.
@@ -220,7 +220,7 @@ paths:
       summary: Update a query
       description: Updates an existing query with new details.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       requestBody:
         description: The update values for the desired query.
         required: true
@@ -253,7 +253,7 @@ paths:
       summary: Test a query
       description: Executes a test run of a query with the provided parameters.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       requestBody:
         description: The query test requirements.
         required: true
@@ -290,7 +290,7 @@ paths:
       summary: Get client sync status
       description: Retrieves the sync status by its client ID.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       responses:
         "200":
           description: Client status details.
@@ -320,7 +320,7 @@ paths:
       summary: Get a collector by client ID
       description: Retrieves a specific collector by its client ID.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       responses:
         "200":
           description: Collector details.
@@ -346,7 +346,7 @@ paths:
       summary: Set a collector
       description: Set client collector with new details.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       requestBody:
         description: The details to be set for the collector.
         required: true
@@ -379,7 +379,7 @@ paths:
       summary: List the documents for a client
       description: Retrieves the list of documents by the client ID.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       responses:
         "200":
           description: Client documents list.
@@ -409,7 +409,7 @@ paths:
       summary: Get document details by its id
       description: Retrieves the details of a document by its id.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       responses:
         "200":
           description: Document details.
@@ -439,7 +439,7 @@ paths:
       summary: Trigger an export
       description: Initiates the export process.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       requestBody:
         description: The export requirements.
         required: true
@@ -476,7 +476,7 @@ paths:
       summary: Check export state.
       description: Checks the current state of an export.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       responses:
         "200":
           description: Export has been completed.
@@ -588,7 +588,7 @@ paths:
         Logs the user out by invalidating the session and redirecting to
         Cognito logout endpoint.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       responses:
         "302":
           description: Redirect to Cognito logout page or application home page
@@ -617,7 +617,7 @@ paths:
       description: >-
         Returns the HTML menu page for authenticated users.
       security:
-        - placeholderAuth: []
+        - jwtAuth: []
       responses:
         "200":
           description: Home page HTML
@@ -686,11 +686,13 @@ components:
       example: "100;window=10"
 
   securitySchemes:
-    placeholderAuth:
-      type: apiKey
-      in: header
-      name: X-API-Key
-      description: "Placeholder security scheme for future implementation"
+    jwtAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+      description: >-
+       JWT token obtained after Cognito authentication. Implements RFC8725 JWT
+       best practices for security.
     cognitoAuth:
       type: oauth2
       description: >-