🆙 add validation and openapi specification to endpoint

papaemmelab · Dec 20, 2023 · a3e2ab5 · a3e2ab5
1 parent 2d70d49
commit a3e2ab5
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 7 deletions.
diff --git a/openapi.yml b/openapi.yml
@@ -47,6 +47,31 @@ paths:
                 $ref: '#/components/schemas/IpssrResponse'
         '500':
           description: An error occurred while calculating IPSS-R risk score
+  /annotateFile:
+    post:
+      summary: Annotate a file with patients, with IPSS-M and IPSS-R risk scores.
+      requestBody:
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                file:
+                  type: string
+                  format: binary
+                  description: csv/tsv or excel file to be annotated. One patient per row.
+      responses:
+        '200':
+          description: Successful operation. Stream the annotated file as CSV.
+          content:
+            text/plain:
+              schema:
+                type: string
+        '400':
+          description: Bad request
+        '500':
+          description: An error occurred while annotating the file.
 components:
   schemas:
     Clinical: