Automated commit 'Merge pull request #1889 from sailpoint/DEVREL-1729

Update phone number example' by github action: 11840486794
sailpoint-oss · Nov 14, 2024 · 05574cd · 05574cd
1 parent 9b8efab
commit 05574cd
Show file tree

Hide file tree

Showing 14 changed files with 42 additions and 23 deletions.
diff --git a/idn/beta/schemas/ApprovalStatus.yaml b/idn/beta/schemas/ApprovalStatus.yaml
@@ -5,4 +5,5 @@ enum:
   - PENDING
   - NOT_READY
   - CANCELLED
-description: Enum representing the non-employee request approval status
+description: Enum representing the non-employee request approval status
+example: APPROVED
diff --git a/idn/beta/schemas/NonEmployeeApprovalItemBase.yaml b/idn/beta/schemas/NonEmployeeApprovalItemBase.yaml
@@ -18,9 +18,11 @@ properties:
     type: number
     description: Approval order
     example: 1
+    format: float
   comment:
     type: string
     description: comment of approver
+    example: true
   modified:
     type: string
     format: date-time

diff --git a/idn/beta/schemas/NonEmployeeRecord.yaml b/idn/beta/schemas/NonEmployeeRecord.yaml
@@ -4,9 +4,11 @@ properties:
     type: string
     format: UUID
     description: Non-Employee record id.
+    example: "ac10e21c-931c-1ef2-8193-1c51e7ff0003"
   accountName:
     type: string
     description: Requested identity account name.
+    example: william.smith
   firstName:
     type: string
     description: Non-Employee's first name.
@@ -22,7 +24,7 @@ properties:
   phone:
     type: string
     description: Non-Employee's phone.
-    example: "5555555555"
+    example: "5125555555"
   manager:
     type: string
     description: The account ID of a valid identity to serve as this non-employee's manager.
@@ -35,7 +37,9 @@ properties:
     type: object
     additionalProperties:
       type: string
-    description: Attribute blob/bag for a non-employee.
+    description: Additional attributes for a non-employee. Up to 10 custom attributes can be added.
+    example:
+      description: Auditing
   startDate:
     type: string
     format: date-time

diff --git a/idn/beta/schemas/NonEmployeeRequest.yaml b/idn/beta/schemas/NonEmployeeRequest.yaml
@@ -21,7 +21,7 @@ allOf:
       phone:
         type: string
         description: Non-Employee's phone.
-        example: "5555555555"
+        example: "5125555555"
       manager:
         type: string
         description: The account ID of a valid identity to serve as this non-employee's manager.
@@ -32,7 +32,9 @@ allOf:
         type: object
         additionalProperties:
           type: string
-        description: Attribute blob/bag for a non-employee.
+        description: Additional attributes for a non-employee. Up to 10 custom attributes can be added.
+        example:
+          description: Auditing
       approvalItems:
         description: List of approval item for the request
         type: array
@@ -42,7 +44,8 @@ allOf:
         $ref: './ApprovalStatus.yaml'
       comment:
         type: string
-        description: comment of requester
+        description: Comment of requester
+        example: approved
       completionDate:
         type: string
         format: date-time

diff --git a/idn/beta/schemas/NonEmployeeRequestBody.yaml b/idn/beta/schemas/NonEmployeeRequestBody.yaml
@@ -19,7 +19,7 @@ properties:
   phone:
     type: string
     description: Non-Employee's phone.
-    example: "5555555555"
+    example: "5125555555"
   manager:
     type: string
     description: The account ID of a valid identity to serve as this non-employee's manager.
@@ -32,8 +32,9 @@ properties:
     type: object
     additionalProperties:
       type: string
-      #maxItems: 10
-    description: Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.
+    description: Additional attributes for a non-employee. Up to 10 custom attributes can be added.
+    example:
+      description: Auditing
   startDate:
     type: string
     format: date-time

diff --git a/idn/beta/schemas/NonEmployeeRequestLite.yaml b/idn/beta/schemas/NonEmployeeRequestLite.yaml
@@ -4,6 +4,7 @@ properties:
     type: string
     format: UUID
     description: Non-Employee request id.
+    example: "ac10e21c-931c-1ef2-8193-1c51e7ff0003"
   requester:
     $ref: './IdentityReferenceWithId.yaml'
     example:

diff --git a/idn/beta/schemas/NonEmployeeRequestWithoutApprovalItem.yaml b/idn/beta/schemas/NonEmployeeRequestWithoutApprovalItem.yaml
@@ -21,7 +21,7 @@ allOf:
       phone:
         type: string
         description: Non-Employee's phone.
-        example: "5555555555"
+        example: "5125555555"
       manager:
         type: string
         description: The account ID of a valid identity to serve as this non-employee's manager.
@@ -32,12 +32,15 @@ allOf:
         type: object
         additionalProperties:
           type: string
-        description: Attribute blob/bag for a non-employee.
+        description: Additional attributes for a non-employee. Up to 10 custom attributes can be added.
+        example:
+          description: Auditing
       approvalStatus:
         $ref: './ApprovalStatus.yaml'
       comment:
         type: string
-        description: comment of requester
+        description: Comment of requester
+        example: approved
       completionDate:
         type: string
         format: date-time

diff --git a/idn/beta/schemas/NonEmployeeSchemaAttribute.yaml b/idn/beta/schemas/NonEmployeeSchemaAttribute.yaml
@@ -8,6 +8,7 @@ properties:
   system:
     type: boolean
     description: True if this schema attribute is mandatory on all non-employees sources.
+    default: false
     example: true
   modified:
     type: string
@@ -41,6 +42,7 @@ properties:
     type: boolean
     description: If true, the schema attribute is required for all non-employees in the source
     example: true
+    default: false
 required:
   - type
   - technicalName

diff --git a/idn/beta/schemas/NonEmployeeSchemaAttributeType.yaml b/idn/beta/schemas/NonEmployeeSchemaAttributeType.yaml
@@ -4,3 +4,4 @@ enum:
   - DATE
   - IDENTITY
 description: Enum representing the type of data a schema attribute accepts.
+example: TEXT
diff --git a/idn/v3/schemas/non-employee/NonEmployeeRecord.yaml b/idn/v3/schemas/non-employee/NonEmployeeRecord.yaml
@@ -24,7 +24,7 @@ properties:
   phone:
     type: string
     description: Non-Employee's phone.
-    example: "5555555555"
+    example: "5125555555"
   manager:
     type: string
     description: The account ID of a valid identity to serve as this non-employee's manager.
@@ -37,7 +37,7 @@ properties:
     type: object
     additionalProperties:
       type: string
-    description: Attribute blob/bag for a non-employee.
+    description: Additional attributes for a non-employee. Up to 10 custom attributes can be added.
     example:
       description: Auditing
   startDate:

diff --git a/idn/v3/schemas/non-employee/NonEmployeeRequest.yaml b/idn/v3/schemas/non-employee/NonEmployeeRequest.yaml
@@ -21,7 +21,7 @@ allOf:
       phone:
         type: string
         description: Non-Employee's phone.
-        example: "5555555555"
+        example: "5125555555"
       manager:
         type: string
         description: The account ID of a valid identity to serve as this non-employee's manager.
@@ -32,7 +32,7 @@ allOf:
         type: object
         additionalProperties:
           type: string
-        description: Attribute blob/bag for a non-employee.
+        description: Additional attributes for a non-employee. Up to 10 custom attributes can be added.
         example:
           description: Auditing
       approvalItems:
@@ -44,7 +44,7 @@ allOf:
         $ref: './ApprovalStatus.yaml'
       comment:
         type: string
-        description: comment of requester
+        description: Comment of requester
         example: approved
       completionDate:
         type: string

diff --git a/idn/v3/schemas/non-employee/NonEmployeeRequestBody.yaml b/idn/v3/schemas/non-employee/NonEmployeeRequestBody.yaml
@@ -19,7 +19,7 @@ properties:
   phone:
     type: string
     description: Non-Employee's phone.
-    example: "5555555555"
+    example: "5125555555"
   manager:
     type: string
     description: The account ID of a valid identity to serve as this non-employee's manager.
@@ -32,8 +32,7 @@ properties:
     type: object
     additionalProperties:
       type: string
-      #maxItems: 10
-    description: Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.
+    description: Additional attributes for a non-employee. Up to 10 custom attributes can be added.
     example:
       description: Auditing
   startDate:

diff --git a/idn/v3/schemas/non-employee/NonEmployeeRequestWithoutApprovalItem.yaml b/idn/v3/schemas/non-employee/NonEmployeeRequestWithoutApprovalItem.yaml
@@ -21,7 +21,7 @@ allOf:
       phone:
         type: string
         description: Non-Employee's phone.
-        example: "5555555555"
+        example: "5125555555"
       manager:
         type: string
         description: The account ID of a valid identity to serve as this non-employee's manager.
@@ -32,14 +32,14 @@ allOf:
         type: object
         additionalProperties:
           type: string
-        description: Attribute blob/bag for a non-employee.
+        description: Additional attributes for a non-employee. Up to 10 custom attributes can be added.
         example:
           description: Auditing
       approvalStatus:
         $ref: './ApprovalStatus.yaml'
       comment:
         type: string
-        description: comment of requester
+        description: Comment of requester
         example: approved
       completionDate:
         type: string

diff --git a/idn/v3/schemas/non-employee/NonEmployeeSchemaAttribute.yaml b/idn/v3/schemas/non-employee/NonEmployeeSchemaAttribute.yaml
@@ -9,6 +9,7 @@ properties:
     type: boolean
     description: True if this schema attribute is mandatory on all non-employees sources.
     example: true
+    default: false
   modified:
     type: string
     format: date-time
@@ -41,6 +42,7 @@ properties:
     type: boolean
     description: If true, the schema attribute is required for all non-employees in the source
     example: true
+    default: false
 required:
   - type
   - technicalName