From 6c7c68dd2896b77c098be2cc92414dfb30c94fbe Mon Sep 17 00:00:00 2001
From: Christoph Beger <ChristophB@users.noreply.github.com>
Date: Fri, 3 Nov 2023 10:51:10 +0100
Subject: [PATCH] Query data sources (#161)

* Add paths to manage organisation data sources

* Add query type filter to `getOrganisationDataSources` path

* Add queryType to DataSource
---
 pom.xml             |  2 +-
 schemas/top-api.yml | 72 +++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 71 insertions(+), 3 deletions(-)

diff --git a/pom.xml b/pom.xml
index 81bce3d..15c94a7 100644
--- a/pom.xml
+++ b/pom.xml
@@ -4,7 +4,7 @@
 
 	<groupId>care.smith.top</groupId>
 	<artifactId>top-api</artifactId>
-	<version>0.9.3</version>
+	<version>0.9.4</version>
 
 	<name>TOP API</name>
 	<description>REST API of the TOP framework</description>
diff --git a/schemas/top-api.yml b/schemas/top-api.yml
index b55abbc..ca73dbd 100644
--- a/schemas/top-api.yml
+++ b/schemas/top-api.yml
@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
   title: TOP API
-  version: 0.9.3
+  version: 0.9.4
   description: |-
     API to manage phenotypes, repositories, ontologies, external terminologies and organisations and to execute phenotypic queries.
 
@@ -482,7 +482,7 @@ paths:
   /data_source:
     get:
       operationId: getDataSources
-      summary: Returns all available and accessible data sources.
+      summary: Returns all available and accessible data sources. Only administrators should be able to perform this operation.
       parameters:
         - name: queryType
           in: query
@@ -567,6 +567,71 @@ paths:
           $ref: '#/components/responses/UnexpectedError'
       tags:
         - organisation
+  '/{organisationId}/data_source':
+    summary: Represents a data source available to a specific organisation.
+    parameters:
+      - $ref: '#/components/parameters/organisationId'
+    get:
+      operationId: getOrganisationDataSources
+      summary: Returns all available and accessible data sources for a specific organisation.
+      parameters:
+        - name: queryType
+          in: query
+          description: Filter by query type for which data sources can be used.
+          required: false
+          schema:
+            $ref: '#/components/schemas/QueryType'
+      responses:
+        '200':
+          description: List of data sources.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/DataSource'
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+        default:
+          $ref: '#/components/responses/UnexpectedError'
+      tags:
+        - query
+    post:
+      operationId: addOrganisationDataSource
+      summary: 'Add a new data source, available to a specific organisation. Only administrators should be able to perform this operation.'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DataSource'
+      responses:
+        '201':
+          description: Data source has been added to the set.
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+        default:
+          $ref: '#/components/responses/UnexpectedError'
+      tags:
+        - query
+    delete:
+      operationId: removeOrganisationDataSource
+      summary: Remove a data source from the set of available data sources of a specific organisation. Only administrators should be able to perform this operation.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DataSource'
+      responses:
+        '204':
+          description: Data source has been removed from the set.
+        '401':
+          $ref: '#/components/responses/Unauthorized'
+        default:
+          $ref: '#/components/responses/UnexpectedError'
+      tags:
+        - query
   /repository:
     parameters:
       - $ref: '#/components/parameters/include'
@@ -2637,8 +2702,11 @@ components:
           description: Human-readable title of the data source.
           type: string
           example: Example Data Source
+        queryType:
+          $ref: '#/components/schemas/QueryType'
       required:
         - id
+        - queryType
     ProjectionEntry:
       description: Single entry of a projection select list.
       type: object