Add API key authentication to data node endpoints

openapi/data-node/components/securitySchemes/ApiKeyAuth.yaml

@@ -0,0 +1,3 @@
+type: apiKey
+in: header
+name: X-API-Key

openapi/data-node/openapi.yaml

@@ -70,4 +70,9 @@ paths:
   /datasets/{datasetId}/fhirStores/{fhirStoreId}/fhir/Note/{noteId}:
     $ref: paths/notes@{noteId}.yaml
   /healthCheck:
-    $ref: ../commons/paths/healthCheck.yaml
+    $ref: ../commons/paths/healthCheck.yaml
+
+components:
+  securitySchemes:
+    ApiKeyAuth:
+      $ref: components/securitySchemes/ApiKeyAuth.yaml

openapi/data-node/paths/annotationStores.yaml

@@ -11,6 +11,8 @@ post:
   summary: Create an annotation store
   description: Create an annotation store with the ID specified
   operationId: createAnnotationStore
+  security:
+    - ApiKeyAuth: []
   parameters:
     - in: query
       name: annotationStoreId
@@ -42,6 +44,8 @@ get:
   summary: List the annotation stores in a dataset
   description: Returns the annotation stores
   operationId: listAnnotationStores
+  security:
+    - ApiKeyAuth: []
   parameters:
     - in: query
       name: limit

openapi/data-node/paths/annotationStores@{annotationStoreId}.yaml

@@ -17,6 +17,8 @@ get:
   summary: Get an annotation store
   description: Returns the annotation store specified
   operationId: getAnnotationStore
+  security:
+    - ApiKeyAuth: []
   responses:
     '200':
       description: Success
@@ -34,6 +36,8 @@ delete:
   summary: Delete an annotation store
   description: Deletes the annotation store specified
   operationId: deleteAnnotationStore
+  security:
+    - ApiKeyAuth: []
   responses:
     '200':
       description: Success

openapi/data-node/paths/annotations.yaml

@@ -17,6 +17,8 @@ post:
   summary: Create an annotation
   description: Create an annotation
   operationId: createAnnotation
+  security:
+    - ApiKeyAuth: []
   parameters:
     - in: query
       name: annotationId
@@ -48,6 +50,8 @@ get:
   summary: List the annotations in an annotation store
   description: Returns the annotations in an annotation store
   operationId: listAnnotations
+  security:
+    - ApiKeyAuth: []
   parameters:
     - in: query
       name: limit

openapi/data-node/paths/annotations@{annotationId}.yaml

@@ -23,6 +23,8 @@ get:
   summary: Get an annotation
   description: Returns the annotation specified
   operationId: getAnnotation
+  security:
+    - ApiKeyAuth: []
   responses:
     '200':
       description: Success
@@ -40,6 +42,8 @@ delete:
   summary: Delete an annotation
   description: Deletes the annotation specified
   operationId: deleteAnnotation
+  security:
+    - ApiKeyAuth: []
   responses:
     '200':
       description: Success

openapi/data-node/paths/datasets.yaml

@@ -4,6 +4,8 @@ post:
   summary: Create a dataset
   description: Create a dataset with the name specified
   operationId: createDataset
+  security:
+    - ApiKeyAuth: []
   parameters:
     - in: query
       name: datasetId
@@ -35,6 +37,8 @@ get:
   summary: Get all datasets
   description: Returns the datasets
   operationId: listDatasets
+  security:
+    - ApiKeyAuth: []
   parameters:
     - in: query
       name: limit

openapi/data-node/paths/datasets@{datasetId}.yaml

@@ -11,6 +11,8 @@ get:
   summary: Get a dataset by ID
   description: Returns the dataset for a given ID
   operationId: getDataset
+  security:
+    - ApiKeyAuth: []
   responses:
     '200':
       description: Success
@@ -28,6 +30,8 @@ delete:
   summary: Delete a dataset by ID
   description: Deletes the dataset for a given ID
   operationId: deleteDataset
+  security:
+    - ApiKeyAuth: []
   responses:
     '200':
       description: Success

openapi/data-node/paths/fhirStores.yaml

@@ -11,6 +11,8 @@ post:
   summary: Create a FHIR store
   description: Create a FHIR store with the ID specified
   operationId: createFhirStore
+  security:
+    - ApiKeyAuth: []
   parameters:
     - in: query
       name: fhirStoreId
@@ -42,6 +44,8 @@ get:
   summary: List the FHIR stores in a dataset
   description: Returns the FHIR stores
   operationId: listFhirStores
+  security:
+    - ApiKeyAuth: []
   parameters:
     - in: query
       name: limit

openapi/data-node/paths/fhirStores@{fhirStoreId}.yaml

@@ -17,6 +17,8 @@ get:
   summary: Get a FHIR store
   description: Returns the FHIR store specified
   operationId: getFhirStore
+  security:
+    - ApiKeyAuth: []
   responses:
     '200':
       description: Success
@@ -34,6 +36,8 @@ delete:
   summary: Delete a FHIR store
   description: Deletes the FHIR store specified
   operationId: deleteFhirStore
+  security:
+    - ApiKeyAuth: []
   responses:
     '200':
       description: Success

openapi/data-node/paths/notes.yaml

@@ -17,6 +17,8 @@ post:
   summary: Create a note
   description: Create a note
   operationId: createNote
+  security:
+    - ApiKeyAuth: []
   parameters:
     - in: query
       name: noteId
@@ -48,6 +50,8 @@ get:
   summary: List notes
   description: Returns the notes in a FHIR store
   operationId: listNotes
+  security:
+    - ApiKeyAuth: []
   parameters:
     - in: query
       name: limit

openapi/data-node/paths/notes@{noteId}.yaml

@@ -23,6 +23,8 @@ get:
   summary: Get a note
   description: Returns the note specified
   operationId: getNote
+  security:
+    - ApiKeyAuth: []
   responses:
     '200':
       description: Success
@@ -40,6 +42,8 @@ delete:
   summary: Delete a note
   description: Deletes the note specified
   operationId: deleteNote
+  security:
+    - ApiKeyAuth: []
   responses:
     '200':
       description: Success

openapi/data-node/paths/patients.yaml

@@ -17,6 +17,8 @@ post:
   summary: Create a FHIR patient
   description: Create a FHIR patient
   operationId: createPatient
+  security:
+    - ApiKeyAuth: []
   parameters:
     - in: query
       name: patientId
@@ -48,6 +50,8 @@ get:
   summary: List the Patients in a FHIR store
   description: Returns the Patients in a FHIR store
   operationId: listPatients
+  security:
+    - ApiKeyAuth: []
   parameters:
     - in: query
       name: limit

openapi/data-node/paths/patients@{patientId}.yaml

@@ -23,6 +23,8 @@ get:
   summary: Get a FHIR patient
   description: Returns the FHIR patient specified
   operationId: getPatient
+  security:
+    - ApiKeyAuth: []
   responses:
     '200':
       description: Success
@@ -40,6 +42,8 @@ delete:
   summary: Delete a FHIR patient
   description: Deletes the FHIR patient specified
   operationId: deletePatient
+  security:
+    - ApiKeyAuth: []
   responses:
     '200':
       description: Success