Automated commit 'Merge pull request #10 from sailpoint/NEROCKET-291

NEROCKET-291 added categories to documentation.' by github action: 6854970920

nerm/schemas/GET/ProfileType.yaml

@@ -4,22 +4,39 @@ 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: ptUid
   name:
     type: string
+    description: This is the name of the profile type.
+    example: Worker
+  category:
+    type: string
+    enum: ['identities', 'organizations', 'populations', 'assignments', 'other']
+    description: This is the category the profile type falls into.
+    example: identities
   bypass_dup_protection:
     type: boolean
+    description: Whether or not duplication protection is bypassed.
+    example: false
   archived:
     type: boolean
+    description: Whether or not the profile type is archived.
+    example: false
   permitted_role_ids:
     type: array
     items: 
       type: string
       format: uuid
+    description: The role ids that are permitted for this profile type.
+    example: ['33f072dd-13b4-41e1-8ea0-16f2a59b57c8']
   profile_type_dup_attributes:
     type: array
     items: 
@@ -28,16 +45,24 @@ properties:
         id:
           type: string
           format: uuid
+          description: The ID of the properties that are used for duplication protection.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         uid:
           type: string
           minLength: 32
           maxLength: 32
+          description: The uid of the properties that are used for duplication protection.
+          example: attribute-uid
         profile_type_id:
           type: string
           format: uuid
+          description: The ID of the profile type.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         ne_attribute_id:
           type: string
           format: uuid
+          description: The ID of the ne attribute.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
   profile_type_namings:
     type: array
     items: 
@@ -46,16 +71,26 @@ properties:
         id:
           type: string
           format: uuid
+          description: The ID of the profile type naming.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         uid:
           type: string
           minLength: 32
           maxLength: 32
+          description: The UID of the profile type naming.
+          example: profile-type-name
         profile_type_id:
           type: string
           format: uuid
+          description: The ID of the associated profile type.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         ne_attribute_id:
           type: string
           format: uuid
+          description: The ID of the associated ne attribute.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         order:
           type: integer
           minimum: 0
+          description: The order that the namings are used in.
+          example: 0

nerm/schemas/PATCH/ProfileType.yaml

@@ -2,15 +2,28 @@ type: object
 properties:
   name:
     type: string
+    description: This is the name of the profile type.
+    example: Worker
+  category:
+    type: string
+    enum: ['identities', 'organizations', 'populations', 'assignments', 'other']
+    description: This is the category the profile type falls into.
+    example: identities
   bypass_dup_protection:
     type: boolean
+    description: Whether or not duplication protection is bypassed.
+    example: false
   archived:
     type: boolean
+    description: Whether or not the profile type is archived.
+    example: false
   permitted_role_ids:
     type: array
     items: 
       type: string
       format: uuid
+    description: The role ids that are permitted for this profile type.
+    example: ['33f072dd-13b4-41e1-8ea0-16f2a59b57c8']
   profile_type_dup_attributes:
     type: array
     items: 
@@ -19,16 +32,24 @@ properties:
         id:
           type: string
           format: uuid
+          description: The ID of the properties that are used for duplication protection.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         uid:
           type: string
           minLength: 32
           maxLength: 32
+          description: The uid of the properties that are used for duplication protection.
+          example: attribute-uid
         profile_type_id:
           type: string
           format: uuid
+          description: The ID of the profile type.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         ne_attribute_id:
           type: string
           format: uuid
+          description: The ID of the ne attribute.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
   profile_type_namings:
     type: array
     items: 
@@ -37,16 +58,26 @@ properties:
         id:
           type: string
           format: uuid
+          description: The ID of the profile type naming.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         uid:
           type: string
           minLength: 32
           maxLength: 32
+          description: The UID of the profile type naming.
+          example: profile-type-name
         profile_type_id:
           type: string
           format: uuid
+          description: The ID of the associated profile type.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         ne_attribute_id:
           type: string
           format: uuid
+          description: The ID of the associated ne attribute.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         order:
           type: integer
           minimum: 0
+          description: The order that the namings are used in.
+          example: 0

nerm/schemas/POST/ProfileType.yaml

@@ -2,17 +2,30 @@ type: object
 properties:
   name:
     type: string
+    description: This is the name of the profile type.
+    example: Worker
+  category:
+    type: string
+    enum: ['identities', 'organizations', 'populations', 'assignments', 'other']
+    description: This is the category the profile type falls into.
+    example: identities
   bypass_dup_protection:
     type: boolean
     default: false
+    description: Whether or not duplication protection is bypassed.
+    example: false
   archived:
     type: boolean
     default: false
+    description: Whether or not the profile type is archived.
+    example: false
   permitted_role_ids:
     type: array
     items: 
       type: string
       format: uuid
+    description: The role ids that are permitted for this profile type.
+    example: ['33f072dd-13b4-41e1-8ea0-16f2a59b57c8']
   profile_type_dup_attributes:
     type: array
     items: 
@@ -21,16 +34,24 @@ properties:
         id:
           type: string
           format: uuid
+          description: The ID of the properties that are used for duplication protection.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         uid:
           type: string
           minLength: 32
           maxLength: 32
+          description: The uid of the properties that are used for duplication protection.
+          example: attribute-uid
         profile_type_id:
           type: string
           format: uuid
+          description: The ID of the profile type.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         ne_attribute_id:
           type: string
           format: uuid
+          description: The ID of the ne attribute.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
   profile_type_namings:
     type: array
     items: 
@@ -39,16 +60,26 @@ properties:
         id:
           type: string
           format: uuid
+          description: The ID of the profile type naming.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         uid:
           type: string
           minLength: 32
           maxLength: 32
+          description: The UID of the profile type naming.
+          example: profile-type-name
         profile_type_id:
           type: string
           format: uuid
+          description: The ID of the associated profile type.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         ne_attribute_id:
           type: string
           format: uuid
+          description: The ID of the associated ne attribute.
+          example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
         order:
           type: integer
           minimum: 0
+          description: The order that the namings are used in.
+          example: 0