automatic patch creation

Signed-off-by: Timo Glastra <timo@animo.id>

Author: TimoGlastra

generator/README.md

@@ -36,34 +36,17 @@ cd aries-cloudcontroller/generator
 
 # Fix the openapi file (add missing operation ids from data/operation-id-map.yml)
 ./scripts/process-openapi.sh
+
+# Apply manual patches to the openapi file
+./scripts/apply-patch.sh
 ```
 
-### Manual modifications
-
-The code is set up to require the least amount of manual modifications. However, sometimes it's easier to manually fix some issues. The goal is to make those manual modifications to the open api file, not the generated code.
-
-#### `connection_protocol` enum
-
-Fixed in main, not part of 0.7.0. Replace line 4220-4235 in `data/openapi.yml`
-
-```diff
-# line 4220-4235
--          - c
--          - o
--          - n
--          - e
--          - t
--          - i
--          - s
--          - /
--          - "1"
--          - "."
--          - "0"
--          - d
--          - x
--          - h
--          - a
--          - g
-+          - connections/1.0
-+          - didexchange/1.0
+## Updating the patch file
+
+1. Make changes to the OpenAPI file and then run:
+
+```sh
+cd aries-cloudcontroller/generator
+
+./scripts/create-patch.sh
 ```

generator/data/openapi.patch

@@ -1,5 +1,5 @@
 diff --git a/generator/data/openapi.yml b/generator/data/openapi.yml
-index 4582107..0186d58 100644
+index 4582107..54bbbf4 100644
 --- a/generator/data/openapi.yml
 +++ b/generator/data/openapi.yml
 @@ -705,7 +705,7 @@ paths:
@@ -89,40 +89,42 @@ index 4582107..0186d58 100644
        type: object
        properties:
          schema:
-@@ -7620,7 +7611,7 @@ components:
-           maximum: 18446744073709551615
-           minimum: 0
+@@ -7617,10 +7608,7 @@ components:
+         mechanism:
+           type: string
+         time:
+-          maximum: 18446744073709551615
+-          minimum: 0
            type: integer
 -          format: int32
-+          format: uint64
            example: 1629715147
      TAAInfo:
        type: object
-@@ -7765,6 +7756,7 @@ components:
+@@ -7765,6 +7753,7 @@ components:
            example: 2021-08-23 10:39:07+00:00
      TxnOrCredentialDefinitionSendResult:
        type: object
 +      additionalProperties: false
        properties:
          sent:
            $ref: '#/components/schemas/CredentialDefinitionSendResult'
-@@ -7775,6 +7767,7 @@ components:
+@@ -7775,6 +7764,7 @@ components:
            - $ref: '#/components/schemas/TransactionRecord'
      TxnOrPublishRevocationsResult:
        type: object
 +      additionalProperties: false
        properties:
          sent:
            $ref: '#/components/schemas/PublishRevocations'
-@@ -7785,6 +7778,7 @@ components:
+@@ -7785,6 +7775,7 @@ components:
            - $ref: '#/components/schemas/TransactionRecord'
      TxnOrRevRegResult:
        type: object
 +      additionalProperties: false
        properties:
          sent:
            $ref: '#/components/schemas/RevRegResult'
-@@ -7795,6 +7789,7 @@ components:
+@@ -7795,6 +7786,7 @@ components:
            - $ref: '#/components/schemas/TransactionRecord'
      TxnOrSchemaSendResult:
        type: object

generator/data/openapi.yml

@@ -7608,10 +7608,7 @@ components:
         mechanism:
           type: string
         time:
-          maximum: 18446744073709551615
-          minimum: 0
           type: integer
-          format: uint64
           example: 1629715147
     TAAInfo:
       type: object

generator/scripts/apply-patch.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+cd "$(dirname "$0")" || exit
+
+# Apply the patches required
+cd .. && git apply --verbose data/openapi.patch

generator/scripts/create-patch.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+cd "$(dirname "$0")" || exit
+
+cp ../data/openapi.yml ../data/openapi-updated.yml
+sh ./convert-to-openapi3.sh
+sh ./process-openapi.sh
+
+cd ..
+
+git diff --no-index --patch data/openapi.yml data/openapi-updated.yml > data/openapi.patch
+
+# Move back to the updated file
+mv data/openapi-updated.yml data/openapi.yml
+
+# Replace openapi-updated references with openapi
+sed -i '' 's/a\/data\/openapi.yml/a\/generator\/data\/openapi.yml/g' data/openapi.patch
+sed -i '' 's/b\/data\/openapi-updated.yml/b\/generator\/data\/openapi.yml/g' data/openapi.patch

generator/scripts/process-openapi.sh

@@ -9,7 +9,4 @@ ${CONTAINER_RUNTIME} run --name ${CONTAINER_NAME} --rm -it \
     -v "$(pwd)/../data/openapi.yml:/app/openapi.yml:z" \
     -v "$(pwd)/../data/operation-id-map.yml:/app/operation-id-map.yml:z" \
     -v "$(pwd)/../process-openapi.py:/app/process-openapi.py:z" \
-    ${CONTAINER_NAME} python /app/process-openapi.py
-
-# Apply the patches required
-cd .. && git apply --verbose data/openapi.patch
+    ${CONTAINER_NAME} python /app/process-openapi.py