Update idMatchApi.yml

internet2 · Sep 2, 2020 · 56ba1b7 · 56ba1b7
1 parent 7e13d9f
commit 56ba1b7
Showing 1 changed file with 67 additions and 11 deletions.
diff --git a/idMatchApi.yml b/idMatchApi.yml
@@ -2,17 +2,14 @@ openapi: 3.0.0
 info:
   version: 1.1.0
   title: ID Match API
-  description: 
-
-ID Match API Specification from Internet2 Trust and Identity, and Spherical Cow Group
-
+  description: ID Match API Specification from Internet2 Trust and Identity, and Spherical Cow Group
 security:
   - accessCode:
       - read
       - write
 servers:
   - description: SwaggerHub API Auto Mocking
-    url: https://virtserver.swaggerhub.com/I2_TrustAndIdentity/ID_Match/1.0.0
+    url: https://virtserver.swaggerhub.com/I2/idMatch/1.0.0
 
 paths:
   /sis:
@@ -30,7 +27,7 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: '#/components/schemas/corePerson'
+                  $ref: '#/components/schemas/person'
         '400':
           $ref: '#/components/responses/400Error'
 
@@ -41,7 +38,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/corePerson'
+              $ref: '#/components/schemas/person'
       responses:
         '200':
           description: Found (or added) person record
@@ -108,7 +105,7 @@ components:
             read: allows reading resources
 
   schemas:
-    corePerson:
+    person:
       required:
         - sorId
       type: object
@@ -122,12 +119,71 @@ components:
           items:
             type: object
             properties:
-              nameType:
+              type:
+                type: string
+              given:
+                type: string
+              family:
+                type: string
+        address:
+          type: array
+          items:
+            type: object
+            properties:
+              country:
+                type: string
+              formatted:
+                type: string
+              language:
+                type: string
+              locality:
+                type: string
+              postalCode:
+                type: string
+              region:
+                type: string
+              room:
+                type: string
+              streetAddress:
+                type: string
+              type:
+                type: string
+              verified:
+                type: string
+        emailAddress:
+          type: array
+          items:
+            type: object
+            properties:
+              address:
+                type: string
+              type:
                 type: string
-              givenName:
+              verified:
+                type: string
+        identifier:
+          type: array
+          items:
+            type: object
+            properties:
+              id:
                 type: string
-              familyName:
+              type:
                 type: string
+        primaryAffiliation:
+          type: string
+        gender:
+          type: string
+        telephoneNumber:
+          type: array
+          items:
+            type: object
+            properties:
+              number:
+                type: string
+              type:
+                type: string
+
   parameters:
     PageLimit:
       name: limit