Update Person Name API , replace get by post verb

nlpsandbox · Oct 18, 2020 · f60c52d · f60c52d
1 parent abedaa0
commit f60c52d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 14 deletions.
diff --git a/openapi/person-name-annotator/openapi.yaml b/openapi/person-name-annotator/openapi.yaml
@@ -19,15 +19,15 @@ info:
     This NLP tool detects references of person names in the clinical notes given
     as input and returns a list of person name annotations.
 tags:
-  - name: Person Name
-    description: Operations about person names
   - name: Health
     description: Operations about API health
+  - name: Person Name
+    description: Operations about person names
 servers:
   - url: 'http://example.com/api/v1'
   - url: 'https://example.com/api/v1'
 paths:
-  /person-names:
-    $ref: 'paths/person-names.yaml'
   /health:
-    $ref: '../commons/paths/health.yaml'
+    $ref: '../commons/paths/health.yaml'
+  /person-names:
+    $ref: 'paths/person-names.yaml'
diff --git a/openapi/person-name-annotator/paths/person-names.yaml b/openapi/person-name-annotator/paths/person-names.yaml
@@ -1,9 +1,16 @@
-get:
+post:
   tags:
     - Person Name
   summary: Get all person name annotations
   description: Returns the person name annotations
   operationId: "person_names.read_all"
+  requestBody:
+    content:
+      application/json:
+        schema:
+          type: array
+          items:
+            $ref: ../../commons/components/schemas/Note.yaml
   responses:
       '200':
         description: Success
@@ -14,11 +21,4 @@ get:
               items:
                 $ref: ../../commons/components/schemas/PersonNameAnnotation.yaml
       '403':
-        description: Forbidden
-  requestBody:
-    content:
-      application/json:
-        schema:
-          type: array
-          items:
-            $ref: ../../commons/components/schemas/Note.yaml
+        description: Forbidden