Automated commit 'Merge pull request #15 from sailpoint/NEROCKET-353

NEROCKET-353 Update API docs to reflect the Profile Type Category wor…' by github action: 7141904115

nerm/schemas/GET/Profile.yaml

@@ -4,32 +4,49 @@ properties:
     type: string
     format: uuid
     readOnly: true
+    description: The objects ID
+    example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
   uid:
     type: string
     minLength: 32
     maxLength: 32
     readOnly: true
+    description: The objects UID
+    example: profileUid
   name:
     type: string
+    description: This is the name of the profile.
+    example: Profile Name
   profile_type_id:
     type: string
     format: uuid
+    description: This is the ID of the profile type the profile belongs to
+    example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
   status:
     type: string
     enum: [Active, Inactive, On Leave, Terminated]
+    description: This is the status of the profile
+    example: Active
   id_proofing_status:
     type: string
     enum: [pending, pass, fail]
+    description: This is the ID proofing staus of the profile
+    example: pending
   created_at:
     type: string
     format: date-time
+    description: The date and time the profile was created
+    example: 2023-11-21T14:23:54.256-05:00
   updated_at:
     type: string
     format: date-time
+    description: The date and time the profile was updated
+    example: 2023-11-21T14:23:54.256-05:00
   attributes:
     type: object
     additionalProperties:
       type: string
+    description: Attributes that belong to this profile.
     example:
       text_attribute_uid: static text
       date_attribute_uid: 01/15/2020

nerm/schemas/GET/ProfileType.yaml

@@ -17,6 +17,11 @@ properties:
     type: string
     description: This is the name of the profile type.
     example: Worker
+  category:
+    type: string
+    enum: ['employee', 'non-employee', 'organization', 'assignment', 'other']
+    description: This is the category the profile type falls into.
+    example: employee
   bypass_dup_protection:
     type: boolean
     description: Whether or not duplication protection is bypassed.

nerm/schemas/PATCH/ProfileType.yaml

@@ -4,6 +4,11 @@ properties:
     type: string
     description: This is the name of the profile type.
     example: Worker
+  category:
+    type: string
+    enum: ['employee', 'non-employee', 'organization', 'assignment', 'other']
+    description: This is the category the profile type falls into.
+    example: employee  
   bypass_dup_protection:
     type: boolean
     description: Whether or not duplication protection is bypassed.

nerm/schemas/POST/ProfileType.yaml

@@ -4,6 +4,11 @@ properties:
     type: string
     description: This is the name of the profile type.
     example: Worker
+  category:
+    type: string
+    enum: ['employee', 'non-employee', 'organization', 'assignment', 'other']
+    description: This is the category the profile type falls into.
+    example: employee
   bypass_dup_protection:
     type: boolean
     default: false