NbP

internet2 · Feb 10, 2021 · 63cc225 · 63cc225
1 parent 47ec67c
commit 63cc225
Showing 1 changed file with 62 additions and 74 deletions.
diff --git a/id-match-api.yml b/id-match-api.yml
@@ -33,24 +33,36 @@ paths:
           schema:
             type: string
         - in: query
-          name: name.0
+          name: name
           schema:
             type: string
-          description: The
+          description: The matching person's family name
         - in: query
           name: dateOfBirth
           schema:
             type: string
-          description: The
+          description: The matching person's date of birth
       responses:
         '200':
           description: An existing identity was found matching the specified attributes.
-        '201':
-          description: Return new referenceId for a person new to ID Match
+          content:
+            application/json:
+              schema:
+                type: string
+              example:
+                referenceId: M225127891
+
+        '404':
+          description: Not found
+          content:
+            text/plain:
+              schema:
+                type: string
+                enum: ["No Match Found"]
     post:
       tags:
         - idMatch
-      summary: POST-based; Search only, similar to a regular request, except that a new identity will never be created as a result of the request
+      summary: GET-based; Search only, similar to a regular request, except that a new identity will never be created as a result of the request
       operationId: requestSerchOnlyPost
       parameters:
         - name: sorLabel
@@ -87,29 +99,6 @@ paths:
                   type: mobile
                   number: 8185551234
       responses:
-        '201':
-          description: Return new referenceId for a person new 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
-
         '200':
           description: Return referenceId for a person known to ID Match
           content:
@@ -125,28 +114,8 @@ paths:
                 dateOfBirth: "1983-03-18"
                 identifiers:
                   -
-                    type: national
-                    identifier: 3B902AE12DF55196
-                telephoneNumbers:
-                  -
-                    type: mobile
-                    number: 8185551234
-                referenceId: M523441767
-
-        '300':
-          description: Multiple Choices
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/people'
-              example:
-                names:
-                  -
-                     type: official
-                     given: Pat
-                     family: Lee
-                dateOfBirth: "1983-03-18"
-                identifiers:
+                    type: referenceId
+                    identifier: M225127891
                   -
                     type: national
                     identifier: 3B902AE12DF55196
@@ -155,10 +124,17 @@ paths:
                     type: mobile
                     number: 8185551234
                 referenceId: M523441767
-
         '400':
           $ref: '#/components/responses/400Error'
 
+        '404':
+          description: Not found
+          content:
+            text/plain:
+              schema:
+                type: string
+                enum: ["No Match Found"]
+
     put:
       tags:
         - idMatch
@@ -200,31 +176,38 @@ paths:
                   number: 8185551234
 
       responses:
-        '201':
-          description: Return new referenceId for a person new to ID Match
+        '200':
+          description: Return referenceId for a person known to ID Match. May return additional identifiers known to the Match service
           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
+                    type: official
+                    given: Pat
+                    family: Lee
+                    dateOfBirth: "1983-03-18"
+                    identifiers:
+                      -
+                        type: referenceId
+                        identifier: M523441767
+                      -
+                        type: enterprise
+                        identifier: 905003148
+                      -
+                        type: national
+                        identifier: 3B902AE12DF55196
 
-        '200':
-          description: Return referenceId for a person known to ID Match
+                    telephoneNumbers:
+                      -
+                        type: mobile
+                        number: 8185551234
+
+
+        '201':
+          description: Return new referenceId for a person new to ID Match
           content:
             application/json:
               schema:
@@ -235,27 +218,32 @@ paths:
                      type: official
                      given: Pat
                      family: Lee
-                dateOfBirth: "1983-03-18"
+                dateOfBirth: 1983-03-18
                 identifiers:
                   -
-                    type: national
-                    identifier: 3B902AE12DF55196
+                    type: referenceId
+                    identifier: M225127891
                 telephoneNumbers:
                   -
                     type: mobile
                     number: 8185551234
                 referenceId: M523441767
 
 
+        '300':
+          description: Multiple Choices
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/people'
         '400':
           $ref: '#/components/responses/400Error'
 
   /ping:
     get:
       summary: Server heartbeat operation
       description: >-
-        This operation shows how to override the global security defined
-        above as we want to open it up for all users.
+        This operation should be available to all users.
       security: []
       responses:
         '200':