feat: #29 Adding documentation on --filteredOperations new flag

Signed-off-by: Laurent Broudoux <[email protected]>

Author: lbroudoux

README.md

@@ -11,7 +11,9 @@ It allows to launch tests or import API artifacts with minimal dependencies.
 
 ## Build Status
 
-Current development version is `0.5.3-SNAPSHOT`. [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/microcks/microcks-cli/build-verify.yml?logo=github&style=for-the-badge)](https://github.com/microcks/microcks-cli/actions)
+Current development version is `0.5.3`. [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/microcks/microcks-cli/build-verify.yml?logo=github&style=for-the-badge)](https://github.com/microcks/microcks-cli/actions).
+
+It is available as a container image named `quay.io/microcks/microcks-cli:nightly`.
 
 ## Usage instructions
 
@@ -47,9 +49,11 @@ The flags:
 * `--keycloakClientId` for the Keycloak Realm Service Account ClientId,
 * `--keycloakClientSecret` for the Keycloak Realm Service Account ClientSecret.
 
+> Since `0.5.2` release, `microcks-cli` also works in unauthenticated mode, without Keycloak being deployed and configured with your Microcks instance. However, you still have to specify the Keycloak flags on the command even if you put random values there. For eg. `--keycloakClientId=foo --keycloakClientSecret=bar`.
+
 Real life example command and execution:
 
-```
+```sh
 $ ./microcks-cli test 'Beer Catalog API:0.9' http://localhost:9090/api/ POSTMAN \
         --microcksURL=http://localhost:8080/api/ \
         --keycloakClientId=microcks-serviceaccount \
@@ -59,6 +63,7 @@ $ ./microcks-cli test 'Beer Catalog API:0.9' http://localhost:9090/api/ POSTMAN
 MicrocksClient got status for test "5c1781cf6310d94f8169384e" - success: false, inProgress: true
 MicrocksTester waiting for 2 seconds before checking again.
 MicrocksClient got status for test "5c1781cf6310d94f8169384e" - success: true, inProgress: false
+Full TestResult details are available here: http://localhost:8080/#/tests/5c1781cf6310d94f8169384e 
 ```
 
 #### Advanced options
@@ -68,19 +73,21 @@ The `test` command provides additional flags for advanced usages and options:
 * `--verbose` allows to dump on standard output all the HTTP requests and responses,
 * `--insecure` allows to interact with Microcks and Keycloak instances through HTTPS without checking certificates issuer CA,
 * `--caCerts=<path1,path2>` allows to specify additional certificates CRT files to add to trusted roots ones,
-* `--secretName='<Secret Name>'` is an optional flag specifying the name of a Secret to use for connecting endpoint
+* `--secretName='<Secret Name>'` is an optional flag specifying the name of a Secret to use for connecting endpoint,
+* `--filteredOperations=<JSON>` allows to filter a list of operations to launch a test for,
 * `--operationsHeaders=<JSON>` allows to override some operations headers for the tests to launch.
 
 Overriden test operations headers is a JSON strings where 1st level keys are operation name (eg. `GET /beer`) or `globals` for header applying to all the operations of the API. Headers are specified as an array of objects defining `key` and `values` properties.
 
 Here's below an example of using some of this flags:
 
 ```sh
-$ ./microcks-cli test 'Beer Catalog API:0.9' http://localhost:9090/api/ POSTMAN \                           
+$ ./microcks-cli test 'Beer Catalog API:0.9' http://localhost:9090/api/ OPEN_API_SCHEMA \                           
         --microcksURL=http://localhost:8080/api/ \
         --keycloakClientId=microcks-serviceaccount \
         --keycloakClientSecret=7deb71e8-8c80-4376-95ad-00a399ee3ca1 \
         --insecure --verbose  --waitFor=3sec \
+        --filterOperations='["GET /beer", "GET /beer/{name}"]' \
         --operationsHeaders='{"globals": [{"name": "x-api-key", "values": "my-values"}], "GET /beer": [{"name": "x-trace-id", "values": "xcvbnsdfghjklm"}]}'
 
 MicrocksClient got status for test "64c25f7ddec62569f9a0ed95" - success: true, inProgress: false 
@@ -107,6 +114,8 @@ The flags:
 * `--keycloakClientId` for the Keycloak Realm Service Account ClientId,
 * `--keycloakClientSecret` for the Keycloak Realm Service Account ClientSecret.
 
+> Since `0.5.2` release, `microcks-cli` also works in unauthenticated mode, without Keycloak being deployed and configured with your Microcks instance. However, you still have to specify the Keycloak flags on the command even if you put random values there. For eg. `--keycloakClientId=foo --keycloakClientSecret=bar`.
+
 Real life example command and execution:
 
 ```sh