Add 500 schema and endpoints (#141)

* Add 500 schema and endpoints to data node paths * Add 500 reponse to all remaining paths of all services
nlpsandbox · Jan 21, 2021 · e330f4a · e330f4a
1 parent de13036
commit e330f4a
Show file tree

Hide file tree

Showing 19 changed files with 84 additions and 20 deletions.
diff --git a/openapi/commons/components/responses/InternalServerError.yaml b/openapi/commons/components/responses/InternalServerError.yaml
@@ -0,0 +1,5 @@
+description: The request cannot be fulfilled due to an unexpected server error
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/Error.yaml
diff --git a/openapi/commons/paths/healthCheck.yaml b/openapi/commons/paths/healthCheck.yaml
@@ -12,4 +12,6 @@ get:
           schema:
             $ref: ../components/schemas/HealthCheck.yaml
     '404':
-      $ref: ../components/responses/NotFound.yaml
+      $ref: ../components/responses/NotFound.yaml
+    '500':
+      $ref: ../components/responses/InternalServerError.yaml
diff --git a/openapi/commons/paths/service.yaml b/openapi/commons/paths/service.yaml
@@ -12,4 +12,6 @@ get:
           schema:
             $ref: ../components/schemas/Service.yaml
     '404':
-      $ref: ../components/responses/NotFound.yaml
+      $ref: ../components/responses/NotFound.yaml
+    '500':
+      $ref: ../components/responses/InternalServerError.yaml
diff --git a/openapi/data-node/paths/annotationStores.yaml b/openapi/data-node/paths/annotationStores.yaml
@@ -34,6 +34,8 @@ post:
       $ref: ../../commons/components/responses/BadRequest.yaml
     '409':
       $ref: ../../commons/components/responses/Conflict.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
 get:
   tags:
     - AnnotationStore
@@ -61,4 +63,6 @@ get:
             $ref: ../components/schemas/PageOfAnnotationStores.yaml
       description: Success
     '400':
-      $ref: ../../commons/components/responses/BadRequest.yaml
+      $ref: ../../commons/components/responses/BadRequest.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/data-node/paths/annotationStores@{annotationStoreId}.yaml b/openapi/data-node/paths/annotationStores@{annotationStoreId}.yaml
@@ -26,6 +26,8 @@ get:
             $ref: ../components/schemas/AnnotationStore.yaml
     '404':
       $ref: ../../commons/components/responses/NotFound.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
 delete:
   tags:
     - AnnotationStore
@@ -40,4 +42,6 @@ delete:
           schema:
             $ref: ../../commons/components/schemas/EmptyObject.yaml
     '404':
-      $ref: ../../commons/components/responses/NotFound.yaml
+      $ref: ../../commons/components/responses/NotFound.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/data-node/paths/annotations.yaml b/openapi/data-node/paths/annotations.yaml
@@ -33,6 +33,8 @@ post:
       $ref: ../../commons/components/responses/BadRequest.yaml
     '409':
       $ref: ../../commons/components/responses/Conflict.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
 get:
   tags:
     - Annotation
@@ -60,4 +62,6 @@ get:
             $ref: ../components/schemas/PageOfAnnotations.yaml
       description: Success
     '400':
-      $ref: ../../commons/components/responses/BadRequest.yaml
+      $ref: ../../commons/components/responses/BadRequest.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/data-node/paths/annotations@{annotationId}.yaml b/openapi/data-node/paths/annotations@{annotationId}.yaml
@@ -32,6 +32,8 @@ get:
             $ref: ../../commons/components/schemas/Annotation.yaml
     '404':
       $ref: ../../commons/components/responses/NotFound.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
 delete:
   tags:
     - Annotation
@@ -46,4 +48,6 @@ delete:
           schema:
             $ref: ../../commons/components/schemas/EmptyObject.yaml
     '404':
-      $ref: ../../commons/components/responses/NotFound.yaml
+      $ref: ../../commons/components/responses/NotFound.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/data-node/paths/datasets.yaml b/openapi/data-node/paths/datasets.yaml
@@ -27,6 +27,8 @@ post:
       $ref: ../../commons/components/responses/BadRequest.yaml
     '409':
       $ref: ../../commons/components/responses/Conflict.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
 get:
   tags:
     - Dataset
@@ -55,4 +57,5 @@ get:
       description: Success
     '400':
       $ref: ../../commons/components/responses/BadRequest.yaml
-
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/data-node/paths/datasets@{datasetId}.yaml b/openapi/data-node/paths/datasets@{datasetId}.yaml
@@ -20,6 +20,8 @@ get:
             $ref: ../components/schemas/Dataset.yaml
     '404':
       $ref: ../../commons/components/responses/NotFound.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
 delete:
   tags:
     - Dataset
@@ -34,4 +36,6 @@ delete:
           schema:
             $ref: ../../commons/components/schemas/EmptyObject.yaml
     '404':
-      $ref: ../../commons/components/responses/NotFound.yaml
+      $ref: ../../commons/components/responses/NotFound.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/data-node/paths/fhirStores.yaml b/openapi/data-node/paths/fhirStores.yaml
@@ -34,6 +34,8 @@ post:
       $ref: ../../commons/components/responses/BadRequest.yaml
     '409':
       $ref: ../../commons/components/responses/Conflict.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
 get:
   tags:
     - FhirStore
@@ -62,3 +64,5 @@ get:
       description: Success
     '400':
       $ref: ../../commons/components/responses/BadRequest.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/data-node/paths/fhirStores@{fhirStoreId}.yaml b/openapi/data-node/paths/fhirStores@{fhirStoreId}.yaml
@@ -26,6 +26,8 @@ get:
             $ref: ../components/schemas/FhirStore.yaml
     '404':
       $ref: ../../commons/components/responses/NotFound.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
 delete:
   tags:
     - FhirStore
@@ -40,4 +42,6 @@ delete:
           schema:
             $ref: ../../commons/components/schemas/EmptyObject.yaml
     '404':
-      $ref: ../../commons/components/responses/NotFound.yaml
+      $ref: ../../commons/components/responses/NotFound.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/data-node/paths/notes.yaml b/openapi/data-node/paths/notes.yaml
@@ -33,6 +33,8 @@ post:
       $ref: ../../commons/components/responses/BadRequest.yaml
     '409':
       $ref: ../../commons/components/responses/Conflict.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
 get:
   tags:
     - Note
@@ -61,3 +63,5 @@ get:
       description: Success
     '400':
       $ref: ../../commons/components/responses/BadRequest.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/data-node/paths/notes@{noteId}.yaml b/openapi/data-node/paths/notes@{noteId}.yaml
@@ -32,6 +32,8 @@ get:
             $ref: ../../commons/components/schemas/Note.yaml
     '404':
       $ref: ../../commons/components/responses/NotFound.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
 delete:
   tags:
     - Note
@@ -47,3 +49,5 @@ delete:
             $ref: ../../commons/components/schemas/EmptyObject.yaml
     '404':
       $ref: ../../commons/components/responses/NotFound.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/data-node/paths/patients.yaml b/openapi/data-node/paths/patients.yaml
@@ -33,6 +33,8 @@ post:
       $ref: ../../commons/components/responses/BadRequest.yaml
     '409':
       $ref: ../../commons/components/responses/Conflict.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
 get:
   tags:
     - Patient
@@ -61,3 +63,5 @@ get:
       description: Success
     '400':
       $ref: ../../commons/components/responses/BadRequest.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/data-node/paths/patients@{patientId}.yaml b/openapi/data-node/paths/patients@{patientId}.yaml
@@ -32,6 +32,8 @@ get:
             $ref: ../../commons/components/schemas/Patient.yaml
     '404':
       $ref: ../../commons/components/responses/NotFound.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
 delete:
   tags:
     - Patient
@@ -47,3 +49,5 @@ delete:
             $ref: ../../commons/components/schemas/EmptyObject.yaml
     '404':
       $ref: ../../commons/components/responses/NotFound.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/date-annotator/paths/textDateAnnotations.yaml b/openapi/date-annotator/paths/textDateAnnotations.yaml
@@ -17,4 +17,6 @@ post:
           schema:
             $ref: ../components/schemas/TextDateAnnotations.yaml
     '403':
-      $ref: ../../commons/components/responses/Unauthorized.yaml
+      $ref: ../../commons/components/responses/Unauthorized.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/person-name-annotator/paths/textPersonNameAnnotations.yaml b/openapi/person-name-annotator/paths/textPersonNameAnnotations.yaml
@@ -17,4 +17,6 @@ post:
           schema:
             $ref: ../components/schemas/TextPersonNameAnnotations.yaml
     '403':
-      $ref: ../../commons/components/responses/Unauthorized.yaml
+      $ref: ../../commons/components/responses/Unauthorized.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/phi-deidentifier/paths/deidentifiedNotes.yaml b/openapi/phi-deidentifier/paths/deidentifiedNotes.yaml
@@ -10,11 +10,13 @@ post:
         schema:
           $ref: ../components/schemas/DeidentifyRequest.yaml
   responses:
-      '200':
-        description: Success
-        content:
-          application/json:
-            schema:
-              $ref: ../components/responses/DeidentifyResponse.yaml
-      '403':
-        $ref: ../../commons/components/responses/Unauthorized.yaml
+    '200':
+      description: Success
+      content:
+        application/json:
+          schema:
+            $ref: ../components/responses/DeidentifyResponse.yaml
+    '403':
+      $ref: ../../commons/components/responses/Unauthorized.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml
diff --git a/openapi/physical-address-annotator/paths/textPhysicalAddressAnnotations.yaml b/openapi/physical-address-annotator/paths/textPhysicalAddressAnnotations.yaml
@@ -17,4 +17,6 @@ post:
           schema:
             $ref: ../components/schemas/TextPhysicalAddressAnnotations.yaml
     '403':
-      $ref: ../../commons/components/responses/Unauthorized.yaml
+      $ref: ../../commons/components/responses/Unauthorized.yaml
+    '500':
+      $ref: ../../commons/components/responses/InternalServerError.yaml