Release 0.1.2 (#39)

* Rename DateAnnotation.dateFormat to .format * Remove Note.filename * Add responses/NotFound.yaml and returned it for note not found * Add BadRequest.yaml and Unauthorized.yaml * Most standard reponses of the data node return JSON object * Surround reponse code by single quotes * Standard reponse of /health now return JSON object * Bump to version 0.1.2
nlpsandbox · Oct 15, 2020 · 81cb1f7 · 81cb1f7
1 parent 38d2198
commit 81cb1f7
Show file tree

Hide file tree

Showing 18 changed files with 58 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -10,10 +10,10 @@ order.
 
 | API | Type | Version |
 |---|---|---|
-| [Data Node](/openapi/data-node) | Data Node | 0.1.1 |
-| [Date Annotator](/openapi/date-annotator) | NLP Tool | 0.1.1 |
-| [Person Name Annotator](/openapi/person-name-annotator) | NLP Tool | 0.1.1 |
-| [Physical Address Annotator](/openapi/physical-address-annotator) | NLP Tool | 0.1.1 |
+| [Data Node](/openapi/data-node) | Data Node | 0.1.2 |
+| [Date Annotator](/openapi/date-annotator) | NLP Tool | 0.1.2 |
+| [Person Name Annotator](/openapi/person-name-annotator) | NLP Tool | 0.1.2 |
+| [Physical Address Annotator](/openapi/physical-address-annotator) | NLP Tool | 0.1.2 |
 
 ## Web services
 

diff --git a/openapi/commons/components/responses/BadRequest.yaml b/openapi/commons/components/responses/BadRequest.yaml
@@ -0,0 +1,5 @@
+description: Invalid request
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/Error.yaml
diff --git a/openapi/commons/components/responses/NotFound.yaml b/openapi/commons/components/responses/NotFound.yaml
@@ -0,0 +1,5 @@
+description: The specified resource was not found
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/Error.yaml
diff --git a/openapi/commons/components/responses/Unauthorized.yaml b/openapi/commons/components/responses/Unauthorized.yaml
@@ -0,0 +1,5 @@
+description: Unauthorized
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/Error.yaml
diff --git a/openapi/commons/components/schemas/DateAnnotation.yaml b/openapi/commons/components/schemas/DateAnnotation.yaml
@@ -1,7 +1,7 @@
 type: object
 description: A date annotation in a text
 properties:
-  dateFormat:
+  format:
     description: Date format (ISO 8601)
     type: string
 allOf:

diff --git a/openapi/commons/components/schemas/Error.yaml b/openapi/commons/components/schemas/Error.yaml
@@ -0,0 +1,9 @@
+type: object
+properties:
+  code:
+    type: string
+  message:
+    type: string
+required:
+  - code
+  - message
diff --git a/openapi/commons/components/schemas/Note.yaml b/openapi/commons/components/schemas/Note.yaml
@@ -4,15 +4,11 @@ properties:
   text:
     description: The content of the note
     type: string
-    example: October 3, Ms Chloe Price met with...
+    example: On March 11, Ms Chloe Price met with her family.
   patientPublicId:
-    readOnly: true
+    # readOnly: true
     allOf:
       - $ref: PatientPublicId.yaml
-  filename:
-    description: The filename of the source note
-    type: string
-    example: 260-01.xml
   type:
     description: The note type
     type: string

diff --git a/openapi/commons/paths/health.yaml b/openapi/commons/paths/health.yaml
@@ -12,6 +12,6 @@ get:
           schema:
             $ref: ../components/schemas/Health.yaml
     '403':
-      description: Forbidden
+      $ref: ../components/responses/Unauthorized.yaml
     '404':
-      description: Note not found
+      $ref: ../components/responses/NotFound.yaml
diff --git a/openapi/data-node/openapi.yaml b/openapi/data-node/openapi.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.2
 info:
-  version: 0.1.1
+  version: 0.1.2
   title: NLP Sandbox Data Node API
   contact:
     name: The NLP Sandbox Team

diff --git a/openapi/data-node/paths/annotations/dates.yaml b/openapi/data-node/paths/annotations/dates.yaml
@@ -14,19 +14,19 @@ get:
         default: 10
         minimum: 10
   responses:
-    "200":
+    '200':
       content:
         application/json:
           schema:
             type: object
             properties:
               items:
                 type: array
-                $ref: '../../../commons/components/schemas/DateAnnotation.yaml'
+                $ref: ../../../commons/components/schemas/DateAnnotation.yaml
             allOf:
-              - $ref: '../../../commons/components/schemas/PageResponse.yaml'
+              - $ref: ../../../commons/components/schemas/PageResponse.yaml
       description: Success
-    "403":
-      description: Forbidden
-    "404":
-      description: Date not found
+    '403':
+      $ref: ../../../commons/components/responses/Unauthorized.yaml
+    '404':
+      $ref: ../../../commons/components/responses/NotFound.yaml
diff --git a/openapi/data-node/paths/notes.yaml b/openapi/data-node/paths/notes.yaml
@@ -14,20 +14,20 @@ get:
         default: 10
         minimum: 10
   responses:
-    "200":
+    '200':
       content:
         application/json:
           schema:
             type: object
             properties:
               items:
                 type: array
-                $ref: '../../commons/components/schemas/Note.yaml'
+                $ref: ../../commons/components/schemas/Note.yaml
             allOf:
-              - $ref: '../../commons/components/schemas/PageResponse.yaml'
+              - $ref: ../../commons/components/schemas/PageResponse.yaml
       description: Success
-    "403":
-      description: Forbidden
-    "404":
-      description: Note not found
+    '403':
+      $ref: ../../commons/components/responses/Unauthorized.yaml
+    '404':
+      $ref: ../../commons/components/responses/NotFound.yaml
 
diff --git a/openapi/data-node/paths/notes@{id}.yaml b/openapi/data-node/paths/notes@{id}.yaml
@@ -19,9 +19,9 @@ get:
           schema:
             $ref: ../../commons/components/schemas/Note.yaml
     '403':
-      description: Forbidden
+      $ref: ../../commons/components/responses/Unauthorized.yaml
     '404':
-      description: Note not found
+      $ref: ../../commons/components/responses/NotFound.yaml
 put:
   tags:
     - Note
@@ -42,9 +42,9 @@ put:
     '200':
       description: OK
     '400':
-      description: Invalid note supplied
+      $ref: ../../commons/components/responses/BadRequest.yaml
     '404':
-      description: Note not found
+      $ref: ../../commons/components/responses/NotFound.yaml
   requestBody:
     content:
       application/json:

diff --git a/openapi/date-annotator/openapi.yaml b/openapi/date-annotator/openapi.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.2
 info:
-  version: 0.1.1
+  version: 0.1.2
   title: NLP Sandbox Date Annotator API
   contact:
     name: The NLP Sandbox Team

diff --git a/openapi/date-annotator/paths/dates.yaml b/openapi/date-annotator/paths/dates.yaml
@@ -14,7 +14,7 @@ get:
               items:
                 $ref: ../../commons/components/schemas/DateAnnotation.yaml
       '403':
-        description: Forbidden
+        $ref: ../../commons/components/responses/Unauthorized.yaml
   requestBody:
     content:
       application/json:

diff --git a/openapi/person-name-annotator/openapi.yaml b/openapi/person-name-annotator/openapi.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.2
 info:
-  version: 0.1.1
+  version: 0.1.2
   title: NLP Sandbox Person Name Annotator API
   contact:
     name: The NLP Sandbox Team

diff --git a/openapi/physical-address-annotator/openapi.yaml b/openapi/physical-address-annotator/openapi.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.2
 info:
-  version: 0.1.1
+  version: 0.1.2
   title: NLP Sandbox Physical Address Annotator API
   contact:
     name: The NLP Sandbox Team

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nlp-sandbox-schemas",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "license": "Apache-2.0",
   "repository": "github:Sage-Bionetworks/nlp-sandbox-schemas",
   "devDependencies": {