Automated commit by github action: 3448223941

static/api-specs/idn/beta/paths/non-employee-approval-list.yaml

@@ -1,7 +1,7 @@
 get:
   operationId: nonEmployeeApprovalList
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: Get List of Non-Employee Approval Requests
@@ -9,6 +9,7 @@ get:
     This gets a list of non-employee approval requests.
   parameters:
     - in: query
+      example: "ac10d20a-841e-1e7d-8184-32d2e22c0179"
       name: requested-for
       schema:
         type: string
@@ -19,6 +20,7 @@ get:
     - $ref: '../../v3/parameters/offset.yaml'
     - $ref: '../../v3/parameters/count.yaml'
     - in: query
+      example: "filters=approvalStatus eq 'PENDING'"
       name: filters
       schema:
         type: string
@@ -28,6 +30,7 @@ get:
         **approvalStatus**: *eq* <br/><br/>
         *Example:* approvalStatus eq "PENDING"
     - in: query
+      example: "sorters=-created"
       name: sorters
       schema:
         type: string

static/api-specs/idn/beta/paths/non-employee-approval-summary.yaml

@@ -1,7 +1,7 @@
 get:
   operationId: nonEmployeeApprovalSummary
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: Get Summary of Non-Employee Approval Requests
@@ -12,6 +12,7 @@ get:
     2. The current user is an approver, in which case "me" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her.
   parameters:
     - in: path
+      example: "ac10d20a-841e-1e7d-8184-32d2e22c0179"
       name: requested-for
       schema:
         type: string

static/api-specs/idn/beta/paths/non-employee-approve-get.yaml

@@ -1,7 +1,7 @@
 get:
   operationId: nonEmployeeApprovalGet
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: Get a non-employee approval item detail
@@ -10,12 +10,14 @@ get:
   parameters:
     - in: path
       name: id
+      example: "ac10d20a-841e-1e7d-8184-32d2e22c0179"
       description: >-
         Non-Employee approval item id (UUID)
       required: true
       schema:
         type: string
     - in: query
+      example: "include-detail=false"
       name: include-detail
       description: >-
         The object nonEmployeeRequest will not be included detail when set to false. *Default value is true*

static/api-specs/idn/beta/paths/non-employee-approve-request.yaml

@@ -1,7 +1,7 @@
 post:
   operationId: nonEmployeeApproveRequest
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Approve a Non-Employee Request

static/api-specs/idn/beta/paths/non-employee-bulk-upload-jobs-fail.yaml

@@ -1,6 +1,6 @@
 post:
-  # security:
+  security:
-  #   - oauth2: [idn:helpdesk]
+   - oauth2: [idn:nelm:manage]
   operationId: nonEmployeeBulkUploadJobFail
   tags:
     - Non-Employee Lifecycle Management

static/api-specs/idn/beta/paths/non-employee-record.yaml

@@ -1,7 +1,7 @@
 get:
   operationId: nonEmployeeRecordGet
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:read]
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: Get a Non-Employee Record
@@ -41,7 +41,7 @@ get:
 put:
   operationId: nonEmployeeRecordUpdate
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Update Non-Employee Record
@@ -84,7 +84,7 @@ put:
 patch:
   operationId: nonEmployeeRecordPatch
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Patch Non-Employee Record
@@ -132,8 +132,8 @@ patch:
       $ref: '../../v3/responses/500.yaml'
 delete:
   operationId: nonEmployeeRecordDelete
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:delete]
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Delete Non-Employee Record

static/api-specs/idn/beta/paths/non-employee-records-bulk-delete.yaml

@@ -1,7 +1,7 @@
 post:
   operationId: nonEmployeeRecordBulkDelete
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:delete]
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Delete Multiple Non-Employee Records

static/api-specs/idn/beta/paths/non-employee-records.yaml

@@ -1,7 +1,7 @@
 post:
   operationId: nonEmployeeRecordCreation
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:create]
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Create Non-Employee Record
@@ -39,7 +39,7 @@ post:
 get:
   operationId: nonEmployeeRecordList
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: List Non-Employee Records

static/api-specs/idn/beta/paths/non-employee-reject-request.yaml

@@ -1,7 +1,7 @@
 post:
   operationId: nonEmployeeRejectRequest
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Reject a Non-Employee Request

static/api-specs/idn/beta/paths/non-employee-request-summary-get.yaml

@@ -1,7 +1,7 @@
 get:
   operationId: nonEmployeeRequestSummaryGet
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: Get Summary of Non-Employee Requests
@@ -12,6 +12,7 @@ get:
     2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages.
   parameters:
     - in: path
+      example: "ac10d20a-841e-1e7d-8184-32d2e22c0179"
       name: requested-for
       description: >-
         The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use "me" instead to indicate the current user.

static/api-specs/idn/beta/paths/non-employee-request.yaml

@@ -1,7 +1,7 @@
 get:
   operationId: nonEmployeeRequestGet
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: Get a Non-Employee Request
@@ -37,8 +37,8 @@ get:
       $ref: '../../v3/responses/500.yaml'
 delete:
   operationId: nonEmployeeRequestDeletion
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:delete]
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Delete Non-Employee Request

static/api-specs/idn/beta/paths/non-employee-requests.yaml

@@ -1,7 +1,7 @@
 post:
   operationId: nonEmployeeRequestCreation
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Create Non-Employee Request
@@ -57,7 +57,7 @@ post:
 get:
   operationId: nonEmployeeRequestList
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: List Non-Employee Requests

static/api-specs/idn/beta/paths/non-employee-source-aggregate.yaml

@@ -1,7 +1,7 @@
 post:
   operationId: nonEmployeeSourceAggregateGet
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:create]
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Aggregate all accounts for a Non-Employee Source

static/api-specs/idn/beta/paths/non-employee-source.yaml

@@ -1,7 +1,7 @@
 get:
   operationId: nonEmployeeSourceGet
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: Get a Non-Employee Source
@@ -35,8 +35,8 @@ get:
       $ref: '../../v3/responses/500.yaml'
 patch:
   operationId: nonEmployeeSourcePatch
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:update]
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Patch a Non-Employee Source
@@ -90,8 +90,8 @@ patch:
       $ref: '../../v3/responses/500.yaml'
 delete:
   operationId: nonEmployeeSourceDelete
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:delete]
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Delete Non-Employee Source

static/api-specs/idn/beta/paths/non-employee-sources-bulk-upload-details.yaml

@@ -1,7 +1,7 @@
 get:
   operationId: nonEmployeeBulkUploadDetails
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:read]
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: Details of bulk upload job on source
@@ -13,6 +13,7 @@ get:
     This is for internal use only.
   parameters:
     - in: path
+      example: "2c918085842e69ae018432d22ccb212f"
       name: id
       description: >-
         Source ID (UUID)

static/api-specs/idn/beta/paths/non-employee-sources-bulk-upload-non-employees.yaml

@@ -1,7 +1,7 @@
 post:
   operationId: nonEmployeeRecordsBulkUpload
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:create]
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Imports, or Updates, Non-Employee Records

static/api-specs/idn/beta/paths/non-employee-sources-bulk-upload-status.yaml

@@ -1,7 +1,7 @@
 get:
   operationId: nonEmployeeBulkUploadStatus
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:read]
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: Obtain the status of bulk upload on the source
@@ -13,6 +13,7 @@ get:
     'idn:nesr:read'
   parameters:
     - in: path
+      example: "2c918085842e69ae018432d22ccb212f"
       name: id
       description: >-
         Source ID (UUID)

static/api-specs/idn/beta/paths/non-employee-sources-export-non-employees.yaml

@@ -1,7 +1,7 @@
 get:
   operationId: nonEmployeeRecordsExport
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:read]
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: Exports Non-Employee Records to CSV
@@ -13,6 +13,7 @@ get:
     'idn:nesr:read'
   parameters:
     - in: path
+      example: "2c918085842e69ae018432d22ccb212f"
       name: id
       description: >-
         Source Id (UUID)

static/api-specs/idn/beta/paths/non-employee-sources-export-schema-attributes-template.yaml

@@ -1,7 +1,7 @@
 get:
   operationId: nonEmployeeExportSourceSchemaTemplate
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:read]
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: Exports Source Schema Template
@@ -13,6 +13,7 @@ get:
     idn:nesr:read'
   parameters:
     - in: path
+      example: "2c918085842e69ae018432d22ccb212f"
       name: id
       description: >-
         Source Id (UUID)

static/api-specs/idn/beta/paths/non-employee-sources-schema-attribute.yaml

@@ -1,19 +1,21 @@
 get:
   operationId: getSchemaAttribute
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: Get Schema Attribute Non-Employee Source
   description: This API gets a schema attribute by Id for the specified Non-Employee SourceId.
   parameters:
     - in: path
+      example: "2c918085842e69ae018432d22ccb212f"
       name: attributeId
       schema:
         type: string
       required: true
       description: The Schema Attribute Id (UUID)
     - in: path
+      example: "2c918085842e69ae018432d22ccb212f"
       name: sourceId
       schema:
         type: string
@@ -24,8 +26,12 @@ get:
       description: The Schema Attribute
       content:
         application/json:
+          example: |
+            id,system,modified,created,type,label,technicalName,helpText,placeholder,required
           schema:
             $ref: '../schemas/NonEmployeeSchemaAttribute.yaml'
+    '400':
+      $ref: '../../v3/responses/400.yaml'
     '401':
       $ref: '../../v3/responses/401.yaml'
     '403':
@@ -36,8 +42,8 @@ get:
       $ref: '../../v3/responses/500.yaml'
 patch:
   operationId: patchSchemaAttribute
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:update]
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Patch a Schema Attribute for Non-Employee Source
@@ -95,8 +101,8 @@ patch:
       $ref: '../../v3/responses/500.yaml'
 delete:
   operationId: deleteSchemaAttribute
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:delete]
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Delete a Schema Attribute for Non-Employee Source

static/api-specs/idn/beta/paths/non-employee-sources-schema-attributes.yaml

@@ -11,6 +11,7 @@ get:
                any custom attributes. At most, a total of 18 attributes will be returned.
   parameters:
     - in: path
+      example: "2c918085842e69ae018432d22ccb212f"
       name: sourceId
       schema:
         type: string
@@ -23,9 +24,19 @@ get:
         application/json:
           schema:
             type: array
+            example: [{
+              "type": "TEXT",
+              "label": "string",
+              "technicalName": "string",
+              "helpText": "string",
+              "placeholder": "string",
+              "required": true
+            }]
             items:
               $ref: '../schemas/NonEmployeeSchemaAttribute.yaml'
             maxItems: 18
+    '400':
+      $ref: '../../v3/responses/400.yaml'
     '401':
       $ref: '../../v3/responses/401.yaml'
     '403':
@@ -38,8 +49,8 @@ get:
       $ref: '../../v3/responses/500.yaml'
 post:
   operationId: createSchemaAttribute
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:create]
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Create a new Schema Attribute for Non-Employee Source
@@ -85,8 +96,8 @@ post:
       $ref: '../../v3/responses/500.yaml'
 delete:
   operationId: deleteSchemaAttributes
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:delete]
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Delete all custom schema attributes for Non-Employee Source

static/api-specs/idn/beta/paths/non-employee-sources.yaml

@@ -1,7 +1,7 @@
 post:
   operationId: nonEmployeeSourcesCreation
-  # security:
+  security:
-  #   - oauth2: [idn:nesr:create]
+    - oauth2: [idn:nelm:manage]
   tags:
     - Non-Employee Lifecycle Management
   summary: Create Non-Employee Source
@@ -38,7 +38,7 @@ post:
 get:
   operationId: nonEmployeeSourcesList
   security:
-    - oauth2: []
+    - oauth2: [idn:nelm:read]
   tags:
     - Non-Employee Lifecycle Management
   summary: List Non-Employee Sources

static/api-specs/idn/beta/schemas/NonEmployeeSource.yaml

@@ -22,3 +22,9 @@ allOf:
         format: date-time
         description: When the request was created.
         example: "2019-08-23T18:40:35.772Z"
+      nonEmployeeCount:
+        nullable: true
+        type: integer
+        description: The number of non-employee records on all sources that *requested-for* user manages.
+        example: 2
+        format: int32

static/api-specs/idn/beta/schemas/NonEmployeeSourceWithNECount.yaml

@@ -3,5 +3,7 @@ allOf:
   - type: object
     properties:
       nonEmployeeCount:
-        type: number
+        type: integer
+        example: 2
+        format: int32
         description: Number of non-employee records associated with this source.