NbP

internet2 · Sep 11, 2020 · 85d51f3 · 85d51f3
1 parent 037f14e
commit 85d51f3
Showing 1 changed file with 60 additions and 22 deletions.
diff --git a/idMatchApi.yml b/idMatchApi.yml
@@ -13,12 +13,12 @@ servers:
     description: "SwaggerHub API Auto Mocking"
 
 paths:
-  /person/{sorLabel}/{sorId}:
+  /people/{sorLabel}/{sorId}:
     put:
       tags:
         - idMatch
       summary: Request a Reference Identifier for an SOR Person
-      operationId: "request"
+      operationId: request
       parameters:
         - name: sorLabel
           in: path
@@ -33,32 +33,69 @@ paths:
           schema:
             type: string
 
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/people'
+            example:
+              names:
+                -
+                  type: official
+                  given: Pat
+                  family: Lee
+              dateOfBirth: "1983-03-18"
+              identifiers:
+                -
+                  type: national
+                  identifier: 3B902AE12DF55196
+              telephoneNumbers:
+                -
+                  type: mobile
+                  number: 8185551234
+
+            referenceId:M523441767
+
       responses:
         '201':
           description: Return new referenceId for a person new to ID Match
           content:
             application/json:
               schema:
-                type: object
-                properties:
-                  artist_name:
-                    type: string
-                  artist_genre:
-                    type: string
-                  albums_recorded:
-                    type: integer
+                $ref: '#/components/schemas/people'
+              example:
+                {
+
+                }
+
+        '200':
+          description: Return referenceId for a person known to ID Match
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/people'
+                  example:
+                    names:
+                      -
+                        type: official
+                        given: Pat
+                        family: Lee
+                    dateOfBirth: "1983-03-18"
+                    identifiers:
+                      -
+                        type: national
+                        identifier: 3B902AE12DF55196
+                    telephoneNumbers:
+                      -
+                        type: mobile
+                        number: 8185551234
+
+                  referenceId: M523441767
+
 
         '400':
           $ref: '#/components/responses/400Error'
-  /example:
-    get:
-      summary: Server example operation
-      description: >-
-        This is an example operation to show how security is applied to the
-        call.
-      responses:
-        '200':
-          description: OK
+
   /ping:
     get:
       summary: Server heartbeat operation
@@ -83,13 +120,14 @@ components:
             read: allows reading resources
 
   schemas:
-    person:
+    people:
       required:
+        - sorLabel
         - sorId
       type: object
       properties:
-        sorId:
-          type: integer
+        sorLabel: type: string
+        sorId: type: string
         dateOfBirth:
           type: string
         names: