Update orchestrator API to v17.0

UiPath · Nov 28, 2023 · 89d7fc2 · 89d7fc2
1 parent ba48c87
commit 89d7fc2
Show file tree

Hide file tree

Showing 4 changed files with 792 additions and 171 deletions.
diff --git a/definitions/du.framework.yaml b/definitions/du.framework.yaml
@@ -297,13 +297,13 @@ paths:
           content:
             text/plain:
               schema:
-                $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetProjectsResponse'
+                $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetDocumentTypeDetailsResponse'
             application/json:
               schema:
-                $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetProjectsResponse'
+                $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetDocumentTypeDetailsResponse'
             text/json:
               schema:
-                $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetProjectsResponse'
+                $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetDocumentTypeDetailsResponse'
         "401":
           description: Unauthorized
           content:
@@ -702,6 +702,18 @@ paths:
             text/json:
               schema:
                 $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetExtractorDetailsResponse'
+        "400":
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse'
         "401":
           description: Unauthorized
           content:
@@ -2867,6 +2879,30 @@ components:
           format: uri
           nullable: true
       additionalProperties: false
+    UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.ExtractorField:
+      type: object
+      properties:
+        name:
+          type: string
+          nullable: true
+        displayName:
+          type: string
+          nullable: true
+        type:
+          type: string
+          nullable: true
+        section:
+          type: string
+          nullable: true
+        isMultiValue:
+          type: boolean
+        color:
+          type: string
+          nullable: true
+        hotkey:
+          type: string
+          nullable: true
+      additionalProperties: false
     UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetClassifierDetailsDocumentTypeResponse:
       type: object
       properties:
@@ -2918,6 +2954,34 @@ components:
           nullable: true
           readOnly: true
       additionalProperties: false
+    UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetDocumentTypeDetailsResponse:
+      type: object
+      properties:
+        id:
+          type: string
+          nullable: true
+        name:
+          type: string
+          nullable: true
+        numberOfDocuments:
+          type: integer
+          format: int32
+          nullable: true
+        numberOfPages:
+          type: integer
+          format: int32
+          nullable: true
+        classifiers:
+          type: array
+          items:
+            $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.DiscoveredResourceSummaryResponse'
+          nullable: true
+        extractors:
+          type: array
+          items:
+            $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.DiscoveredResourceSummaryResponse'
+          nullable: true
+      additionalProperties: false
     UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetDocumentTypesResponse:
       type: object
       properties:
@@ -2959,6 +3023,11 @@ components:
           type: string
           format: uri
           nullable: true
+        fields:
+          type: array
+          items:
+            $ref: '#/components/schemas/UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.ExtractorField'
+          nullable: true
       additionalProperties: false
     UiPath.DocumentUnderstanding.Framework.Api.Controllers.Model.Discovery.GetExtractorsResponse:
       type: object
@@ -3299,6 +3368,7 @@ components:
       enum:
         - FormsAi
         - SemiStructuredAi
+        - Helix
         - Unknown
       type: string
     UiPath.DocumentUnderstanding.Framework.Shared.Core.Helpers.ErrorResponse:
@@ -3333,6 +3403,16 @@ components:
             $ref: '#/components/schemas/UiPath.DocumentProcessing.Contracts.Results.ClassificationResult'
           nullable: true
       additionalProperties: false
+    UiPath.DocumentUnderstanding.Framework.Shared.Core.Model.ClassificationPrompt:
+      type: object
+      properties:
+        name:
+          type: string
+          nullable: true
+        description:
+          type: string
+          nullable: true
+      additionalProperties: false
     UiPath.DocumentUnderstanding.Framework.Validation.Services.Model.DocumentClassificationActionDataModel:
       type: object
       properties:

diff --git a/definitions/identity.yaml b/definitions/identity.yaml
@@ -1,17 +1,18 @@
 openapi: 3.0.1
 info:
   title: IdentityServer External API
-  version: 23.9.6-release.20
+  version: 3.0.3
+  x-uipath-version: 3.0.3
 servers:
   - url: https://cloud.uipath.com/identity_
 paths:
-  /api/AuditQuery/{organizationId}:
+  /api/AuditQuery/{partitionGlobalId}:
     get:
       tags:
         - AuditQuery
       operationId: AuditQuery_GetAuditEvents
       parameters:
-        - name: organizationId
+        - name: partitionGlobalId
           in: path
           required: true
           schema:
@@ -50,13 +51,13 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/AuditQueryRecordDtoPagedResult'
-  /api/AuditQuery/{organizationId}/download:
+  /api/AuditQuery/{partitionGlobalId}/download:
     get:
       tags:
         - AuditQuery
       operationId: AuditQuery_DownloadAuditEvents
       parameters:
-        - name: organizationId
+        - name: partitionGlobalId
           in: path
           required: true
           schema:
@@ -223,7 +224,7 @@ paths:
       tags:
         - MessageTemplate
       summary: Get a message template by Id.
-      operationId: MessageTemplate_GetTemplate
+      operationId: MessageTemplate_GetTemplate_By_Id
       parameters:
         - name: templateId
           in: path
@@ -492,7 +493,7 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/SCIMGroupFilteredResponse'
-  /scim/groups/{groupID}:
+  /scim/groups/{groupId}:
     get:
       tags:
         - ScimGroups
@@ -518,7 +519,6 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/SCIMGroupDTO'
-  /scim/groups/{groupId}:
     delete:
       tags:
         - ScimGroups
@@ -2049,9 +2049,9 @@ components:
         modelAsString: false
   securitySchemes:
     Bearer:
-      type: apiKey
+      type: http
       description: 'JWT Authorization header using the Bearer scheme. Example: "Bearer {token}"'
-      name: Authorization
-      in: header
+      scheme: bearer
+      bearerFormat: JWT
 security:
   - Bearer: []