Merge pull request #36 from Onto-Med/development

Development

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>care.smith.top</groupId>
 	<artifactId>top-api</artifactId>
-	<version>0.3.3</version>
+	<version>0.3.4</version>
 
 	<name>TOP API</name>
 	<description>REST API of the TOP framework</description>

schemas/top-api.yml

@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
   title: TOP API
-  version: 0.3.3
+  version: 0.3.4
   description: API to manage phenotypes, repositories, ontologies and organisations
 
 servers:
@@ -65,6 +65,23 @@ paths:
         default:
           $ref: "#/components/responses/UnexpectedError"
 
+  /statistic:
+    summary: Get statistics about available content. Returned data may be cached.
+    get:
+      operationId: getStatistics
+      security:
+        - BearerAuth: []
+        - BasicAuth: []
+      responses:
+        200:
+          description: Object holding statistics
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Statistic"
+        default:
+          $ref: "#/components/responses/UnexpectedError"
+
   /user_account:
     parameters:
       - $ref: "#/components/parameters/include"
@@ -972,11 +989,6 @@ paths:
         required: true
         schema:
           type: string
-      - name: version
-        description: Defaults to the latest version number.
-        in: query
-        schema:
-          $ref: "#/components/schemas/VersionNumber"
       - $ref: "#/components/parameters/include"
     get:
       summary: Returns all forks of a particular entity.
@@ -1003,6 +1015,12 @@ paths:
       operationId: createFork
       tags:
         - fork
+      parameters:
+        - name: version
+          description: Defaults to the latest version number.
+          in: query
+          schema:
+            $ref: "#/components/schemas/VersionNumber"
       requestBody:
         description: Fork instructions like destination
         required: true
@@ -1011,7 +1029,7 @@ paths:
             schema:
               $ref: "#/components/schemas/ForkCreateInstruction"
       responses:
-        200:
+        201:
           description: List of affected entities (i.e., entities created in the destination repository).
           content:
             application/json:
@@ -1759,6 +1777,29 @@ components:
           type: string
           readOnly: true
 
+    Statistic:
+      description:
+        Holds statistics about content. The scope may be a subset of content stored on the server.
+        Statistics may vary depending on user permissions.
+      type: object
+      properties:
+        organisations:
+          description: Number of organisations
+          type: integer
+          format: int32
+        repositories:
+          description: Number of repositories
+          type: integer
+          format: int32
+        categories:
+          description: Number of phenotype categories
+          type: integer
+          format: int32
+        phenotypes:
+          description: Number of phenotypes
+          type: integer
+          format: int32
+
   securitySchemes:
     BearerAuth:
       type: http