Resolve conflicts

.github/workflows/update-clients.yml

@@ -8,6 +8,10 @@ on:
       title:
         description: "Title For PR's"
         required: true
+      branch:
+        description: "OpenAPI branch"
+        required: true
+        default: "develop"
 
 jobs:
   title:
@@ -31,7 +35,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           path: "DocumentReader-web-openapi"
-          ref: "develop"
+          ref: ${{ github.event.inputs.branch }}
 
       - name: Checkout JS Client Repo
         uses: actions/checkout@v4
@@ -75,7 +79,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           path: "DocumentReader-web-openapi"
-          ref: "develop"
+          ref: ${{ github.event.inputs.branch }}
 
       - name: Checkout Java Client Repo
         uses: actions/checkout@v4
@@ -111,7 +115,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           path: "DocumentReader-web-openapi"
-          ref: "develop"
+          ref: ${{ github.event.inputs.branch }}
 
       - name: Checkout Python Client Repo
         uses: actions/checkout@v4
@@ -147,7 +151,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           path: "DocumentReader-web-openapi"
-          ref: "develop"
+          ref: ${{ github.event.inputs.branch }}
 
       - name: Checkout C# Client Repo
         uses: actions/checkout@v4

.github/workflows/validate-spec.yml

@@ -17,16 +17,16 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version: 14
+          node-version: 20
           registry-url: https://registry.npmjs.org/
 
       - name: Install redoc
         run: |
-          npm install -g redoc-cli
-          redoc-cli bundle index.yml
+          npm install -g @redocly/cli
+          redocly build-docs index.yml
 
       - name: Revert changes
         if: ${{ false }}
         run: |
           npm install -g @openapitools/openapi-generator-cli
-          openapi-generator-cli validate -i index.yml
+          openapi-generator-cli validate --recommend -i index.yml

.github/workflows/verify-clients.yml

@@ -26,6 +26,7 @@ jobs:
         working-directory: python-client
         run: |
           ./update-models.sh
+          ./setup.sh
 
   verify-csharp:
     runs-on: ubuntu-latest
@@ -45,6 +46,7 @@ jobs:
         working-directory: csharp-client
         run: |
           ./update-models.sh
+          ./setup.sh
 
   verify-js:
     runs-on: ubuntu-latest
@@ -63,9 +65,8 @@ jobs:
       - name: Verify update JS client
         working-directory: js-client
         run: |
-          npm install
           ./update-models.sh
-          npm run check-types
+          ./setup.sh
 
   verify-java:
     runs-on: ubuntu-latest

README.md

@@ -23,37 +23,31 @@
 * **rt - \*.yml** - files describing results types
 * **p - \*.yml** - files describing endpoints
 
-
 ## Updating clients according to the current spec
 
-To update clients, use `update clients` GitHub action. Specify title PR and press run. For each client **PR** with changes will be created.
-
-:warning: NOTE: Static typed clients, such as Java or C#, require adding all new **enums** to `update-models.sh` ENUM_MAPPINGS section.
+When changes are added, the `update clients` action is automatically triggered. For each client **PR** with changes will be created.
 
-:warning: NOTE: For some clients generator produces not-valid client code. See `update-models.sh` for ad-hocks fixing generator issues.   
+:warning: NOTE: Before working with a client, read `dev.md` which is available in each client repository.
 
-:warning: NOTE: Do **not edit** generated code. Create wrappers, decorators, etc in ext folder.
+:warning: NOTE: Do **not edit** generated code. Create wrappers, decorators, etc. in ext folder.
 
-:bulb: All clients have RawResultItem container that is used for deserialization for undescribed types. This container is a simple map/dict. 
+:bulb: All clients have RawResultItem and AuthenticityCheckResultItem containers that are used for deserialization oneOf schemas. These containers are a simple map/dict. 
 
 
 ##  Spec validation
-```
-docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate --recommend -i /local/index.yml 
+
+```bash
+docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli validate --recommend -i /local/index.yml
 ```
 
 ## Building Redoc single page html documentation
 
-Edit **rt.yml** - remove **components.schemas.ResultItem.discriminator** node
-
-Edit **rt-authenticity.yml** - remove **components.schemas.AuthenticityCheckResultItem.discriminator**
-
-Then run next command:
-```
+```bash
 npx @redocly/cli build-docs index.yml -o=document-reader-static-doc.html
 ```
 
 ## Bundle scheme to single .json file
+
 ```bash
-npx openapi-generator-cli generate -i index.yml  -g openapi  --skip-validate-spec
+npx @openapitools/openapi-generator-cli generate -i index.yml -g openapi --skip-validate-spec
 ```

authenticity/e-check-diagnose.yml

@@ -1,7 +1,8 @@
-openapi: 3.0.3
+openapi: 3.0.4
 components:
   schemas:
     CheckDiagnose:
+      title: "CheckDiagnose"
       type: integer
       description: "Enumeration contains identifiers which determinate the single document element authenticity check outcome reason: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/check-diagnose/"
       enum:

authenticity/e-critical.yml

@@ -1,7 +1,8 @@
-openapi: 3.0.3
+openapi: 3.0.4
 components:
   schemas:
     Critical:
+      title: "Critical"
       type: integer
       description: "Enumeration contains identifiers determining the criticality of the security element"
       enum:

authenticity/e-result-type.yml

@@ -1,8 +1,10 @@
-openapi: 3.0.3
+openapi: 3.0.4
 components:
   schemas:
     AuthenticityResultType:
+      title: "AuthenticityResultType"
       type: integer
+      format: int64
       description: "Enumeration describes available authenticity checks: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/."
       enum:
         - 1

authenticity/e-visibility.yml

@@ -1,7 +1,8 @@
-openapi: 3.0.3
+openapi: 3.0.4
 components:
   schemas:
     Visibility:
+      title: "Visibility"
       type: integer
       description: "Enumeration contains visibility status of the security element"
       enum:

authenticity/rt-fiber.yml

@@ -1,48 +1,52 @@
-openapi: 3.0.3
+openapi: 3.0.4
 components:
   schemas:
-
-    FiberResult:
-      title: "Fibers Check"
-      allOf:
-        - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem"
-        - type: object
-          properties:
-            RectCount:
-              description: "For UV_Fibers authenticity result type"
-              type: integer
-            ExpectedCount:
-              description: "Expected fibers number. For UV_Fibers authentication result type"
-              type: integer
-            LightValue:
-              description: "For UV_Background authentication result type"
-              $ref: "../common.yml#/components/schemas/Light"
-            LightDisp:
-              description: "For UV_Background authentication result type"
-              type: integer
-            RectArray:
-              description: "Coordinates of located areas for defined fibers type"
-              type: array
-              items:
-                $ref: "../common.yml#/components/schemas/RectangleCoordinates"
-            Width:
-              description: "Fibers width value for located areas (in pixels)"
-              type: array
-              items:
-                type: integer
-            Length:
-              description: "Fibers length value for located areas (in pixels)"
-              type: array
-              items:
-                type: integer
-            Area:
-              description: "Fibers value for areas (in pixels)"
-              type: array
-              items:
-                type: integer
-            ColorValues:
-              description: "Fibers color value"
-              example: [BLUE, GREEN, RED]
-              type: array
-              items:
-                type: integer
+    FiberItem:
+      title: "FiberItem"
+      type: object
+      required:
+        - RectCount
+        - ExpectedCount
+        - RectArray
+        - Width
+        - Length
+        - Area
+        - ColorValues
+      properties:
+        RectCount:
+          description: "For UV_Fibers authenticity result type"
+          type: integer
+        ExpectedCount:
+          description: "Expected fibers number. For UV_Fibers authentication result type"
+          type: integer
+        LightValue: # For UV_Background authentication result type
+          $ref: "../common.yml#/components/schemas/Light"
+        LightDisp:
+          description: "For UV_Background authentication result type"
+          type: integer
+        RectArray:
+          description: "Coordinates of located areas for defined fibers type"
+          type: array
+          items:
+            $ref: "../common.yml#/components/schemas/RectangleCoordinates"
+        Width:
+          description: "Fibers width value for located areas (in pixels)"
+          type: array
+          items:
+            type: integer
+        Length:
+          description: "Fibers length value for located areas (in pixels)"
+          type: array
+          items:
+            type: integer
+        Area:
+          description: "Fibers value for areas (in pixels)"
+          type: array
+          items:
+            type: integer
+        ColorValues:
+          description: "Fibers color value"
+          example: [BLUE, GREEN, RED]
+          type: array
+          items:
+            type: integer

authenticity/rt-ident.yml

@@ -1,24 +1,26 @@
-openapi: 3.0.3
+openapi: 3.0.4
 components:
   schemas:
-
-    IdentResult:
-      title: "Ident Check"
-      allOf:
-        - $ref: "../rt-authenticity.yml#/components/schemas/AuthenticityCheckResultItem"
-        - type: object
-          properties:
-            ElementType:
-              $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType"
-            LightIndex:
-              $ref: "../common.yml#/components/schemas/Light"
-            Area:
-              $ref: "../common.yml#/components/schemas/RectangleCoordinates"
-            Image:
-              description: "Original image"
-              $ref: "../common.yml#/components/schemas/ImageData"
-            EtalonImage:
-              description: "Reference image"
-              $ref: "../common.yml#/components/schemas/ImageData"
-            AreaList:
-              $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer"
+    IdentItem:
+      title: "IdentItem"
+      type: object
+      required:
+        - ElementType
+        - LightIndex
+        - Image
+        - EtalonImage
+      properties:
+        ElementType:
+          $ref: "../e-security-feature-type.yml#/components/schemas/SecurityFeatureType"
+        LightIndex:
+          $ref: "../common.yml#/components/schemas/Light"
+        Area:
+          $ref: "../common.yml#/components/schemas/RectangleCoordinates"
+        Image: # Original image
+          $ref: "../common.yml#/components/schemas/ImageData"
+        EtalonImage: # Reference image
+          $ref: "../common.yml#/components/schemas/ImageData"
+        AreaList:
+          $ref: "../rt-authenticity.yml#/components/schemas/AreaContainer"
+        ElementID:
+          type: integer