Added ability to manually trigger workflows, enabled workflows for all branches, updated openapi-generator-cli command, clean-up

Author: jaaufauvre

.github/workflows/broken-links.yml

@@ -1,9 +1,11 @@
+name: broken links?
 'on':
   push:
-    branches: main
+    branches:
+      - "**"
   schedule:
     - cron: 0 16 * * *
-name: broken links?
+  workflow_dispatch:
 jobs:
   linkChecker:
     runs-on: ubuntu-latest

.github/workflows/sonar.yml

@@ -2,13 +2,14 @@ name: Sonar
 'on':
   push:
     branches:
-      - main
+      - "**"
   pull_request_target:
     branches:
-      - main
+      - "**"
     types: [opened, synchronize, reopened, labeled]
   schedule:
     - cron: 0 16 * * *
+  workflow_dispatch:
 jobs:
   sonarcloud:
     name: Sonar

.github/workflows/test.yml

@@ -2,14 +2,13 @@ name: Build & Test
 'on':
   push:
     branches:
-      - main
+      - "**"
   pull_request:
-    types:
-      - opened
-      - synchronize
-      - reopened
+    branches:
+      - "**"
   schedule:
     - cron: 0 16 * * *
+  workflow_dispatch:
 jobs:
   build:
     runs-on: ubuntu-latest

README.md

@@ -128,8 +128,8 @@ decrypted_response_payload = decrypt_payload(body, config)
 The above can be either stored to a file or passed to 'FieldLevelEncryptionConfig' as dictionary:
 ```python
 config_dictionary = {
-                        "paths": {...},
-                        (...)
+                        "paths": {…},
+                        …
                         "decryptionKey": "./path/to/your/private.key",
                         "oaepPaddingDigestAlgorithm": "SHA256"
                     }
@@ -182,9 +182,9 @@ Output:
         "to": {
             "encryptedFoo": {
                 "iv": "7f1105fb0c684864a189fb3709ce3d28",
-                "encryptedKey": "67f467d1b653d98411a0c6d3c(...)ffd4c09dd42f713a51bff2b48f937c8",
-                "encryptedData": "b73aabd267517fc09ed72455c2(...)dffb5fa04bf6e6ce9ade1ff514ed6141",
-                "publicKeyFingerprint": "80810fc13a8319fcf0e2e(...)82cc3ce671176343cfe8160c2279",
+                "encryptedKey": "67f467d1b653d98411a0c6d3c…ffd4c09dd42f713a51bff2b48f937c8",
+                "encryptedData": "b73aabd267517fc09ed72455c2…dffb5fa04bf6e6ce9ade1ff514ed6141",
+                "publicKeyFingerprint": "80810fc13a8319fcf0e2e…82cc3ce671176343cfe8160c2279",
                 "oaepHashingAlgorithm": "SHA256"
             }
         }
@@ -204,10 +204,10 @@ response = {
     "to": {
       "encryptedFoo": {
         "iv": "e5d313c056c411170bf07ac82ede78c9",
-        "encryptedKey": "e3a56746c0f9109d18b3a2652b76(...)f16d8afeff36b2479652f5c24ae7bd",
-        "encryptedData": "809a09d78257af5379df0c454dcdf(...)353ed59fe72fd4a7735c69da4080e74f",
+        "encryptedKey": "e3a56746c0f9109d18b3a2652b76…f16d8afeff36b2479652f5c24ae7bd",
+        "encryptedData": "809a09d78257af5379df0c454dcdf…353ed59fe72fd4a7735c69da4080e74f",
         "oaepHashingAlgorithm": "SHA256",
-        "publicKeyFingerprint": "80810fc13a8319fcf0e2e(...)3ce671176343cfe8160c2279"
+        "publicKeyFingerprint": "80810fc13a8319fcf0e2e…3ce671176343cfe8160c2279"
       }
     }
   }
@@ -244,12 +244,12 @@ from client_encryption.api_encryption import add_encryption_layer
 config = {
   "paths": {
     "$": {
-      ...
+      …
     }
   },
   "ivFieldName": "iv",
   "encryptedKeyFieldName": "encryptedKey",
-  ...
+  …
   "oaepPaddingDigestAlgorithm": "SHA256"
 }
 
@@ -270,14 +270,14 @@ This method will add the field level encryption in the generated OpenApi client,
 OpenAPI client can be generated, starting from your OpenAPI Spec using the following command:
 
 ```shell
-java -jar openapi-generator-cli.jar generate -i openapi-spec.yaml -l python -o out
+openapi-generator-cli generate -i openapi-spec.yaml -l python -o out
 ```
 
 Client library will be generated in the `out` folder.
 
 See also: 
 
-- [OpenAPI Generator (executable)](https://mvnrepository.com/artifact/org.openapitools/openapi-generator-cli)
+- [OpenAPI Generator CLI Installation](https://openapi-generator.tech/docs/installation/)
 
 ##### Usage of the `api_encryption.add_encryption_layer`:
 
@@ -306,12 +306,12 @@ To use it:
    Example:
 
    ```python
-   request_body = {...}
+   request_body = {…}
    response = MyServiceApi(api_client).do_some_action_post(body=request_body)
    # requests and responses will be automatically encrypted and decrypted
    # accordingly with the configuration object used
 
-   # ... use the (decrypted) response object here ...
+   # … use the (decrypted) response object here …
    decrypted = response.json()
 
    ```