Merge pull request #13 from sailpoint-oss/NEROCKET-64

NEROCKET-64 removing deprecated admin param for User API doc

nerm/schemas/PATCH/User.yaml

@@ -5,27 +5,42 @@ properties:
     format: uuid
     required: true
     writeOnly: true
+    example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
+    description: ID of the object to retrieve or update
   name:
     type: string
+    description: The name
+    example: myusername
   email:
     type: string
     format: email
+    description: The email
+    example: test@sailpoint.com
   type:
     type: string
     enum: [NeprofileUser, NeaccessUser]
     default: NeprofileUser
+    description: Type of user
+    example: NeprofileUser
   profile_id:
     type: string
     format: uuid
+    description: ID of the profile
+    example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
   title:
     type: string
+    description: The title
+    example: Director
   status:
     type: string
     enum: [Active, Disabled]
+    description: Status of the user
+    example: Active
   login:
-    type: string
-  admin:
-    type: boolean
+    type: string 
+    description: The login
+    example: myLogin 
   group_strings:
     type: string
+    description: The group strings
     example: "Administrator_group,Developer_group"

nerm/schemas/POST/User.yaml

@@ -3,29 +3,41 @@ properties:
   name:
     type: string
     required: true
+    description: The user name
+    example: Bob
   email:
     type: string
     format: email
     required: true
+    description: The user email
+    example: test@sailpoint.com
   type:
     type: string
     enum: ['NeprofileUser', 'NeaccessUser']
     default: NeprofileUser
+    description: The user type
+    example: NeprofileUser
   profile_id:
     type: string
     format: uuid
+    description: The user profile id
+    example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
   title:
     type: string
+    description: The user description
+    example: my_user_title
   status:
     type: string
     enum: [Active, Disabled]
     required: true
+    description: The user status
+    example: Active
   login:
     type: string
     required: true
-  admin:
-    type: boolean
-    default: false
+    description: The user login
+    example: my_user  
   group_strings:
     type: string
+    description: The user group strings
     example: "Administrator_group,Developer_group"