Automated commit 'PLTDP-3876 - Moving RDE API specs from internal to …

…V3 (#1451)

* PLTDP-3876: identity details report request body example changed

* PLTDP-3876: reports/{id}/cancel endpoint added

* PLTDP-3876: added 'reports/result' endpoint

* PLTDP-3876: lint errors fixed

* PLTDP-3876: spacing issue with examples for tequest bodies fixed

* PLTDP-3876: schema and example fixes for response bodies

* PLTDP-3876 PLTDP:3876: 'reporting/reports/{taskResultId}/{fileFormat}' endpoint described

* PLTDP-3876: added 'reporting/reports/{reportName}/genericReport' description, returns example schema updated

* PLTDP-3876: GenericReports schema fixed

* PLTDP-3876: unnecessary quates removed from generic reports path description

* PLTDP-3876: review changes - payloads changed, generic reports endpoint removed

* PLTDP-3876: unused examples removed

* PLTDP-3876: removed 'PDF' from examples as this type is going to be deprecated

* PLTDP-3876: nullable parameters added for nullable payloads

* PLTDP-3876: progress field for TaskResultDetails marked nullable

* PLTDP-3876: moved specs to beta till their endpoints will be callable and maintainable

* PLTDP-3876: moving api specs from internal beta to v3

* PLTDP-3876: changed security description, default value for path var fixed

* PLTDP-3876: schemas updated

* PLTDP-3876: schema for TaskResultDetails fixed

* PLTDP-3876: missing example added

* PLTDP-3876: taskDefName example gated with quotes

* PLTDP-3876: cleared beta files after merge with master

* PLTDP-3876: quotes restored for ReportDetails. It is the same as in master branch with extended description

* PLTDP-3876: review changes applied

* PLTDP-3876: mising example for completed query param added

* PLTDP-3876: changed type schema for 'completed' param

* PLTDP-3876: changed type schema for 'fileFormat' param, enum description should be within type

* PLTDP-3876: all necessary run report payloads to be published as public added.

* PLTDP-3876: report types moved to enum, all necessary arguments described as oneOf in the schema

* PLTDP-3876: description and example for report details added

* PLTDP-3876: description and example for reportType added

* PLTDP-3876: review changes - titles added for arguments, required added to the arguments properties, boolean properties types fixed

* PLTDP-3876: syntax of required fields changed

* PLTDP-3876: property for ACCOUNTS arguments schema cleaned up

* PLTDP-3876: attempt to fix example for arguments

* PLTDP-3876: second attempt to fix example for arguments

* PLTDP-3876: third attempt to fix 'cannot assign to this.SetS3Bucket'

* PLTDP-3876: most of proposed changes done. Need to discuss task result progress

* PLTDP-3876: examples updated according to changes

* PLTDP-3876: report result status updated

* PLTDP-3876: report result reportType fixed

* PLTDP-3876: 'setS3Bucket' property renamed to resolve go SDK collision

* PLTDP-3876: fixing beta api file

* PLTDP-3876: fixing beta api file, removed also next line

* Merged with master

* removed duplicate description key

---------

Co-authored-by: Colin McKibben <[email protected]>' by github action: 6813717402

idn/beta/schemas/sod/models/Exception.yaml

@@ -2,7 +2,6 @@ type: object
 properties:
   id:
     type: string
-    description: The id for this SOD exception
     nullable: true
     example: "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
     description: Unique identifier of the SOD exception object

idn/sailpoint-api.v3.yaml

@@ -550,6 +550,9 @@ tags:
 
       For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. 
       If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/idn/api/v3/update-public-identity-config) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information.
+  - name: Reports Data Extraction
+    description: |
+      Use this API to implement reports lifecycle managing and monitoring.
   - name: Requestable Objects
     description: |
       Use this API to implement requestable object functionality. 
@@ -1071,6 +1074,14 @@ paths:
     $ref: './v3/paths/password-dictionary.yaml'
   /password-org-config:
     $ref: './v3/paths/password-org-config.yaml'
+  /reports/{taskResultId}/result:
+    $ref: './v3/paths/reports-result.yaml'
+  /reports/run:
+    $ref: './v3/paths/reports-run.yaml'
+  /reports/{id}/cancel:
+    $ref: './v3/paths/reports-cancel.yaml'
+  /reports/{taskResultId}:
+    $ref: './v3/paths/reports-get-file.yaml'
   /sod-policies:
     $ref: './v3/paths/sod-policies.yaml'
   /sod-policies/{id}:

idn/beta/paths/reports-get-file.yaml → idn/v3/paths/reports-get-file.yaml

@@ -15,20 +15,34 @@ get:
       required: true
       description: Unique identifier of the task result which handled report
       example: ef38f94347e94562b5bb8424a56397d8
-    - in: path
+    - in: query
       name: fileFormat
       schema:
         type: string
+        enum:
+          - csv
+          - pdf
       required: true
       description: Output format of the requested report file
-      example: 'CSV'
+      example: csv
     - in: query
       name: name
       required: false
       schema:
         type: string
       example: 'Identities Details Report'
       description: preferred Report file name, by default will be used report name from task result.
+    - in: query
+      name: auditable
+      required: false
+      schema:
+        type: boolean
+        default: false
+      example: true
+      description: >-
+        Enables auditing for current report download.
+        Will create an audit event and sent it to the REPORT cloud-audit kafka topic. 
+        Event will be created if there is any result present by requested taskResultId.
   responses:
     '200':
       description: Details about running report task.

idn/beta/paths/reports-result.yaml → idn/v3/paths/reports-result.yaml

@@ -1,22 +1,29 @@
-post:
+get:
   tags:
     - Reports Data Extraction
   description: >-
     Get the report results for a report that was run or is running.
     Returns empty report result in case there are no active task definitions with used in payload task definition name.
-  operationId: showReportResult
+  operationId: getReportResult
   summary: "Get Report Result"
   security:
     - UserContextAuth: [sp:report-result:read]
-  requestBody:
-    content:
-      application/json:
-        schema:
-          $ref: '../schemas/reports/ReportDetails.yaml'
-        examples:
-          identityDetailsReport:
-            $ref: '../schemas/reports/examples/identities-details-report-details.yaml'
-    required: true
+  parameters:
+    - in: path
+      name: taskResultId
+      schema:
+        type: string
+      required: true
+      description: Unique identifier of the task result which handled report
+      example: ef38f94347e94562b5bb8424a56397d8
+    - in: query
+      name: completed
+      schema:
+        type: boolean
+        default: false
+      required: false
+      description: state of task result to apply ordering when results are fetching from the DB
+      example: true
   responses:
     '200':
       description: Details about report that was run or is running.

idn/beta/paths/reports-run.yaml → idn/v3/paths/reports-run.yaml

@@ -14,10 +14,8 @@ post:
         schema:
           $ref: '../schemas/reports/ReportDetails.yaml'
         examples:
-          identityDetailsReport:
+          Identities Details Report:
             $ref: '../schemas/reports/examples/identities-details-report-details.yaml'
-          searchExportReport:
-            $ref: '../schemas/reports/examples/search-export-report-details.yaml'
     required: true
   responses:
     '200':

idn/v3/schemas/reports/ReportDetails.yaml

@@ -0,0 +1,32 @@
+type: object
+description: >-
+  Details about report to be processed.
+properties:
+  reportType:
+    type: string
+    enum:
+      - ACCOUNTS
+      - IDENTITIES_DETAILS
+      - IDENTITIES
+      - IDENTITY_PROFILE_IDENTITY_ERROR
+      - ORPHAN_IDENTITIES
+      - SEARCH_EXPORT
+      - UNCORRELATED_ACCOUNTS
+    description: >-
+      Use this property to define what report should be processed in the RDE service.
+    example: IDENTITIES_DETAILS
+  arguments:
+    oneOf:
+      - $ref: '../reports/arguments/accounts-export-report-arguments.yaml'
+      - $ref: '../reports/arguments/identities-details-report-arguments.yaml'
+      - $ref: '../reports/arguments/identities-report-arguments.yaml'
+      - $ref: '../reports/arguments/identity-profile-identity-error-report-arguments.yaml'
+      - $ref: '../reports/arguments/orphan-uncorrelated-report-arguments.yaml'
+      - $ref: '../reports/arguments/search-export-report-arguments.yaml'
+    example: {
+      "application": "2c9180897e7742b2017e781782f705b9",
+      "sourceName": "DataScienceWorkday",
+      "defaultS3Bucket": true
+    }
+    description: >-
+      The string-object map(dictionary) with the arguments needed for report processing.

idn/v3/schemas/reports/ReportResults.yaml

@@ -0,0 +1,67 @@
+type : object
+description: >-
+  Details about report result or current state.
+properties:
+  reportType:
+    type: string
+    enum:
+      - ACCOUNTS
+      - IDENTITIES_DETAILS
+      - IDENTITIES
+      - IDENTITY_PROFILE_IDENTITY_ERROR
+      - ORPHAN_IDENTITIES
+      - SEARCH_EXPORT
+      - UNCORRELATED_ACCOUNTS
+    description: >-
+      Use this property to define what report should be processed in the RDE service.
+    example: IDENTITIES_DETAILS
+  taskDefName:
+    type: string
+    description: >-
+      Name of the task definition which is started to process requesting report. Usually the same as report name
+    example: Identities Details Report
+  id:
+    type: string
+    description: >-
+      Unique task definition identifier.
+    example: a248c16fe22222b2bd49615481311111
+  created:
+    type: string
+    description: >-
+      Report processing start date
+    format: date-time
+    example: '2020-09-07T42:14:00.364Z'
+  status:
+    type: string
+    enum:
+      - SUCCESS
+      - FAILURE
+      - WARNING
+      - TERMINATED
+    description: >-
+      Report current state or result status.
+    example: SUCCESS
+  duration:
+    type: integer
+    format: int64
+    description: >-
+      Report processing time in ms.
+    example: 342
+  rows:
+    type: integer
+    format: int64
+    description: >-
+      Report size in rows.
+    example: 37
+  availableFormats:
+    type: array
+    items:
+      type: string
+      enum:
+        - CSV
+        - PDF
+    description: >-
+      Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'. 
+      In case report won't have this argument there will be ['CSV', 'PDF'] as default.
+    example:
+      - CSV