chore: #7 add authorization header to Beacon and CKAN APIs

GenomicDataInfrastructure · Apr 5, 2024 · 02f043b · 02f043b
1 parent e1dfa48
commit 02f043b
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/_http/.env.example b/_http/.env.example
@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2024 PNED G.I.E.
+#
+# SPDX-License-Identifier: Apache-2.0
+
 KEYCLOAK_HOST=https://keycloak-test.healthdata.nl
 KEYCLOAK_REALM=ckan
 KEYCLOAK_PROVIDER_ALIAS=LSAAI

diff --git a/src/main/openapi/beacon.yaml b/src/main/openapi/beacon.yaml
@@ -14,6 +14,13 @@ paths:
     post:
       summary: Searches for individuals based on criteria
       operationId: list_individuals
+      parameters:
+        - name: Authorization
+          in: header
+          description: The authorization header
+          required: true
+          schema:
+            type: string
       tags:
         - "beacon-query"
       requestBody:
@@ -28,6 +35,8 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/BeaconIndividualsResponse"
+        "401":
+          description: "Unauthorized"
       security:
         - beacon_auth:
             - read:beacon
@@ -37,13 +46,22 @@ paths:
       operationId: list_filtering_terms
       tags:
         - "beacon-query"
+      parameters:
+        - name: Authorization
+          in: header
+          description: The authorization header
+          required: true
+          schema:
+            type: string
       responses:
         "200":
           description: A list of filtering terms
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/BeaconFilteringTermsResponse"
+        "401":
+          description: "Unauthorized"
       security:
         - beacon_auth:
             - read:beacon

diff --git a/src/main/openapi/ckan.yaml b/src/main/openapi/ckan.yaml
@@ -60,6 +60,12 @@ paths:
           required: false
           schema:
             type: string
+        - name: Authorization
+          in: header
+          description: The authorization header
+          required: false
+          schema:
+            type: string
       responses:
         "200":
           description: A list of packages matching the search criteria
@@ -80,6 +86,12 @@ paths:
           required: true
           schema:
             type: string
+        - name: Authorization
+          in: header
+          description: The authorization header
+          required: false
+          schema:
+            type: string
       responses:
         "200":
           description: The package with the specified ID