README.md corrections (#21)

* README.md corrections Signed-off-by: Maxim Nesen <[email protected]>
helidon-io · Oct 4, 2023 · 4efab4d · 4efab4d
1 parent 12c23cc
commit 4efab4d
Show file tree

Hide file tree

Showing 31 changed files with 212 additions and 55 deletions.
diff --git a/examples/integrations/cdi/pokemons/README.md b/examples/integrations/cdi/pokemons/README.md
@@ -3,7 +3,7 @@
 With Java:
 ```bash
 mvn package
-java -jar target/helidon-integrations-examples-pokemons-jpa.jar
+java -jar target/helidon-integrations-examples-pokemons.jar
 ```
 
 ## Exercise the application

diff --git a/examples/integrations/micrometer/mp/README.md b/examples/integrations/micrometer/mp/README.md
@@ -39,7 +39,7 @@ curl -X GET http://localhost:8080/greet
 curl -X GET http://localhost:8080/greet/Joe
 {"message":"Hello Joe!"}
 
-curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting
+curl -X PUT -H "Content-Type: application/json" -d '{"message" : "Hola"}' http://localhost:8080/greet/greeting
 
 curl -X GET http://localhost:8080/greet/Jose
 {"message":"Hola Jose!"}

diff --git a/examples/integrations/micrometer/se/README.md b/examples/integrations/micrometer/se/README.md
@@ -45,15 +45,15 @@ java -jar target/helidon-examples-integrations-micrometer-se.jar
 These normal greeting app endpoints work just as in the original greeting app:
 
 ```bash
-curl -X GET http://localhost:8080/greet
+curl -X GET http://localhost:[PORT]/greet
 {"message":"Hello World!"}
 
-curl -X GET http://localhost:8080/greet/Joe
+curl -X GET http://localhost:[PORT]/greet/Joe
 {"message":"Hello Joe!"}
 
 curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting
 
-curl -X GET http://localhost:8080/greet/Jose
+curl -X GET http://localhost:[PORT]/greet/Jose
 {"message":"Hola Jose!"}
 ```
 

diff --git a/examples/jbatch/README.md b/examples/jbatch/README.md
@@ -7,7 +7,7 @@ Minimal Helidon MP + jBatch PoC.
 With JDK11+
 ```bash
 mvn package
-java -jar target/helidon-jbatch-example.jar
+java -jar target/helidon-example-jbatch.jar
 ```
 
 ## Exercise the application

diff --git a/examples/logging/logback-aot/README.md b/examples/logging/logback-aot/README.md
@@ -36,7 +36,7 @@ mvn clean package
 
 Run from command line:
 ```shell script
-java -jar target/helidon-examples-logging-sfl4j.jar
+java -jar target/helidon-examples-logging-slf4j-aot.jar
 ```
 
 Execute endpoint:
@@ -56,5 +56,5 @@ mvn clean package -Pnative-image
 
 Run from command line:
 ```shell script
-./target/helidon-examples-logging-sfl4j
+./target/helidon-examples-logging-slf4j-aot
 ```
diff --git a/examples/logging/slf4j/README.md b/examples/logging/slf4j/README.md
@@ -26,7 +26,7 @@ mvn clean package
 
 Run from command line:
 ```shell script
-java -jar target/helidon-examples-logging-sfl4j.jar
+java -jar target/helidon-examples-logging-slf4j.jar
 ```
 
 # Running as native image
@@ -41,5 +41,5 @@ mvn clean package -Pnative-image
 
 Run from command line:
 ```shell script
-./target/helidon-examples-logging-sfl4j
+./target/helidon-examples-logging-slf4j
 ```
diff --git a/examples/media/multipart/README.md b/examples/media/multipart/README.md
@@ -17,7 +17,7 @@ mvn package
 First, start the server:
 
 ```
-java -jar target/helidon-examples-microprofile-multipart.jar
+java -jar target/helidon-examples-media-multipart.jar
 ```
 
 Then open <http://localhost:8080/ui> in your browser.
diff --git a/examples/messaging/kafkaConsume.sh b/examples/messaging/kafkaConsume.sh
diff --git a/examples/messaging/kafkaProduce.sh b/examples/messaging/kafkaProduce.sh
diff --git a/examples/messaging/kafkaRun.sh b/examples/messaging/kafkaRun.sh
diff --git a/examples/metrics/filtering/mp/README.md b/examples/metrics/filtering/mp/README.md
@@ -0,0 +1,46 @@
+# Helidon Metrics Filtering MP Example
+
+This project implements a simple Hello World REST service using Helidon SE and demonstrates the 
+optional metrics exemplar support.
+
+## Build and run
+
+With JDK11+
+```bash
+mvn package
+java -jar target/helidon-examples-metrics-filtering-mp.jar
+```
+
+## Exercise the application
+
+```
+curl -X GET http://localhost:8080/greet
+{"message":"Hello World!"}
+
+curl -X GET http://localhost:8080/greet/Joe
+{"message":"Hello Joe!"}
+
+curl -X PUT -H "Content-Type: application/json" -d '{"message" : "Hola"}' http://localhost:8080/greet/greeting
+
+curl -X GET http://localhost:8080/greet/Jose
+{"message":"Hola Jose!"}
+
+curl -X GET http://localhost:8080/greet          
+{"message":"Hola World!"}
+```
+
+## Retrieve application metrics
+
+```
+# Prometheus format with exemplars
+
+curl -s -X GET http://localhost:8080/metrics/application
+# TYPE application_counterForPersonalizedGreetings_total counter
+# HELP application_counterForPersonalizedGreetings_total 
+application_counterForPersonalizedGreetings_total 2 # {trace_id="78e61eed351f4c9d"} 1 1617812495.016000
+. . .
+# TYPE application_timerForGets_mean_seconds gauge
+application_timerForGets_mean_seconds 0.005772598385062112 # {trace_id="b22f13c37ba8b879"} 0.001563945 1617812578.687000
+# TYPE application_timerForGets_max_seconds gauge
+application_timerForGets_max_seconds 0.028018165 # {trace_id="a1b127002725143c"} 0.028018165 1617812467.524000
+```
diff --git a/examples/metrics/filtering/se/README.md b/examples/metrics/filtering/se/README.md
@@ -0,0 +1,46 @@
+# Helidon Filtering Metrics SE Example
+
+This project implements a simple Hello World REST service using Helidon SE and demonstrates the 
+optional metrics exemplar support.
+
+## Build and run
+
+With JDK11+
+```bash
+mvn package
+java -jar target/helidon-examples-metrics-se.jar
+```
+
+## Exercise the application
+
+```
+curl -X GET http://localhost:8080/greet
+{"message":"Hello World!"}
+
+curl -X GET http://localhost:8080/greet/Joe
+{"message":"Hello Joe!"}
+
+curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting
+
+curl -X GET http://localhost:8080/greet/Jose
+{"message":"Hola Jose!"}
+
+curl -X GET http://localhost:8080/greet          
+{"message":"Hola World!"}
+```
+
+## Retrieve application metrics
+
+```
+# Prometheus format with exemplars
+
+curl -s -X GET http://localhost:8080/metrics/application
+# TYPE application_counterForPersonalizedGreetings_total counter
+# HELP application_counterForPersonalizedGreetings_total 
+application_counterForPersonalizedGreetings_total 2 # {trace_id="78e61eed351f4c9d"} 1 1617812495.016000
+. . .
+# TYPE application_timerForGets_mean_seconds gauge
+application_timerForGets_mean_seconds 0.005772598385062112 # {trace_id="b22f13c37ba8b879"} 0.001563945 1617812578.687000
+# TYPE application_timerForGets_max_seconds gauge
+application_timerForGets_max_seconds 0.028018165 # {trace_id="a1b127002725143c"} 0.028018165 1617812467.524000
+```
diff --git a/examples/metrics/http-status-count-se/README.md b/examples/metrics/http-status-count-se/README.md
@@ -97,6 +97,6 @@ curl -H "Accept: application/json" -X GET http://localhost:8080/metrics
 curl -s -X GET http://localhost:8080/health
 ```
 ```listing
-{"outcome":"UP",...
+{"status":"UP",....
 
 ```
diff --git a/examples/microprofile/bean-validation/README.md b/examples/microprofile/bean-validation/README.md
@@ -24,16 +24,21 @@ java -jar target/helidon-examples-microprofile-bean-validation.jar
 ## Exercise the application
 
 ```
-curl -X GET http://localhost:8080/greet
-{"message":"Hello World!"}
-
-curl -X GET -I http://localhost:8080/greet/null
-
-
-HTTP/1.1 400 Bad Request
-Content-Type: application/json
-transfer-encoding: chunked
-connection: keep-alive
-
+curl -X GET http://localhost:8080/valid/<email>
+{"message":"Valid <email>!"}
+
+curl -X GET -I http://localhost:8080/valid/null
+
+
+1 constraint violation(s) occurred during method validation.
+Constructor or Method: public jakarta.json.JsonObject io.helidon.examples.microprofile.bean.validation.ValidEmailResource.getMessage(java.lang.String)
+Argument values: [null]
+Constraint violations: 
+ (1) Kind: PARAMETER
+ parameter index: 0
+ message: must be a well-formed email address
+ root bean: io.helidon.examples.microprofile.bean.validation.ValidEmailResource$Proxy$_$$_WeldSubclass@58f396f6
+ property path: getMessage.arg0
+ constraint: @jakarta.validation.constraints.Email(flags={}, groups={}, regexp=".*", message="{jakarta.validation.constraints.Email.message}", payload={})
 
 ```
diff --git a/examples/microprofile/cors/README.md b/examples/microprofile/cors/README.md
@@ -25,7 +25,7 @@ curl -X GET http://localhost:8080/greet
 curl -X GET http://localhost:8080/greet/Joe
 {"message":"Hello Joe!"}
 
-curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting
+curl -X PUT -H "Content-Type: application/json" -d '{"message" : "Hola"}' http://localhost:8080/greet/greeting
 
 curl -X GET http://localhost:8080/greet/Jose
 {"message":"Hola Jose!"}
@@ -107,7 +107,7 @@ curl -i -X PUT \
     -H "Access-Control-Allow-Methods: PUT" \
     -H "Access-Control-Allow-Origin: http://foo.com" \
     -H "Content-Type: application/json" \
-    -d "{ \"greeting\" : \"Cheers\" }" \
+    -d "{ \"message\" : \"Cheers\" }" \
     http://localhost:8080/greet/greeting
 
 HTTP/1.1 204 No Content

diff --git a/examples/microprofile/hello-world-explicit/README.md b/examples/microprofile/hello-world-explicit/README.md
@@ -12,9 +12,9 @@ java -jar target/helidon-examples-microprofile-hello-world-explicit.jar
 Then try the endpoints:
 
 ```
-curl -X GET http://localhost:7001/helloworld
-curl -X GET http://localhost:7001/helloworld/earth
+curl -X GET http://localhost:[PORT]/helloworld
+curl -X GET http://localhost:[PORT]/helloworld/earth
 ```
 
-By default the server will use a dynamic port, see the messages displayed
+By default, the server will use a dynamic port, see the messages displayed
 when the application starts.
diff --git a/examples/microprofile/http-status-count-mp/README.md b/examples/microprofile/http-status-count-mp/README.md
@@ -37,7 +37,7 @@ curl -X GET http://localhost:8080/greet/Joe
 {"message":"Hello Joe!"}
 ```
 ```bash
-curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting
+curl -X PUT -H "Content-Type: application/json" -d '{"message" : "Hola"}' http://localhost:8080/greet/greeting
 
 curl -X GET http://localhost:8080/greet/Jose
 ```

diff --git a/examples/microprofile/oidc/README.md b/examples/microprofile/oidc/README.md
@@ -25,3 +25,5 @@ in `application.yaml`.
 mvn package
 java -jar target/helidon-examples-microprofile-security-oidc-login.jar
 ```
+
+Then open http://localhost:7987/test in the browser
diff --git a/examples/microprofile/openapi-basic/README.md b/examples/microprofile/openapi-basic/README.md
@@ -19,7 +19,7 @@ curl -X GET http://localhost:8080/greet
 curl -X GET http://localhost:8080/greet/Joe
 {"message":"Hello Joe!"}
 
-curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting
+curl -X PUT -H "Content-Type: application/json" -d '{"message" : "Hola"}' http://localhost:8080/greet/greeting
 
 curl -X GET http://localhost:8080/greet/Jose
 {"message":"Hola Jose!"}

diff --git a/examples/microprofile/openapi-basic/pom.xml b/examples/microprofile/openapi-basic/pom.xml
@@ -50,6 +50,10 @@
             <artifactId>jersey-media-json-binding</artifactId>
             <scope>runtime</scope>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.jboss</groupId>
             <artifactId>jandex</artifactId>

diff --git a/examples/openapi-tools/quickstart-mp/mp-client/README.md b/examples/openapi-tools/quickstart-mp/mp-client/README.md
@@ -1,7 +1,11 @@
-# OpenAPI Helidon Quickstart
+# Helidon Client with OpenAPI 
 
-This is a sample for Helidon Quickstart project.
+## Build and run
 
+With JDK11+
+```bash
+mvn package
+java -jar target/openapi-mp-client.jar
+```
 
-## Overview
-This project was generated using the Helidon OpenAPI Generator.
+
diff --git a/examples/openapi-tools/quickstart-mp/mp-server/README.md b/examples/openapi-tools/quickstart-mp/mp-server/README.md
@@ -5,15 +5,16 @@
 With JDK11+
 ```bash
 mvn package
-java -jar target/openapi-java-server.jar
+java -jar target/openapi-mp-server.jar
 ```
 
 ## Exercise the application
 
 ```
-curl -X GET http://localhost:8080
-curl -X GET http://localhost:8080/{name}
-curl -X PUT http://localhost:8080/greeting
+curl -X GET http://localhost:8080/greet
+curl -X GET http://localhost:8080/greet/{name}
+curl -X PUT http://localhost:8080/greet/greeting
+curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Morning"}' http://localhost:8080/greet/greeting
 
 ```
 

diff --git a/examples/openapi-tools/quickstart-se/se-server/README.md b/examples/openapi-tools/quickstart-se/se-server/README.md
@@ -14,7 +14,7 @@ java -jar target/openapi-java-server.jar
 curl -X GET http://localhost:8080/greet
 curl -X GET http://localhost:8080/greet/{name}
 curl -X PUT http://localhost:8080/greet/greeting
-
+curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Morning"}' http://localhost:8080/greet/greeting
 ```
 
 ## Try health and metrics

diff --git a/examples/quickstarts/helidon-quickstart-mp/README.md b/examples/quickstarts/helidon-quickstart-mp/README.md
@@ -19,7 +19,7 @@ curl -X GET http://localhost:8080/greet
 curl -X GET http://localhost:8080/greet/Joe
 {"message":"Hello Joe!"}
 
-curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting
+curl -X PUT -H "Content-Type: application/json" -d '{"message" : "Hola"}' http://localhost:8080/greet/greeting
 
 curl -X GET http://localhost:8080/greet/Jose
 {"message":"Hola Jose!"}

diff --git a/examples/quickstarts/helidon-standalone-quickstart-mp/README.md b/examples/quickstarts/helidon-standalone-quickstart-mp/README.md
@@ -20,7 +20,7 @@ curl -X GET http://localhost:8080/greet
 curl -X GET http://localhost:8080/greet/Joe
 {"message":"Hello Joe!"}
 
-curl -X PUT -H "Content-Type: application/json" -d '{"greeting" : "Hola"}' http://localhost:8080/greet/greeting
+curl -X PUT -H "Content-Type: application/json" -d '{"message" : "Hola"}' http://localhost:8080/greet/greeting
 
 curl -X GET http://localhost:8080/greet/Jose
 {"message":"Hola Jose!"}

diff --git a/examples/security/basic-auth-with-static-content/README.md b/examples/security/basic-auth-with-static-content/README.md
@@ -15,17 +15,17 @@ There are two examples with exactly the same behavior:
 
 ```bash
 mvn package
-java -jar target/helidon-examples-security-webserver-basic-auth.jar
+java -jar target/helidon-examples-security-webserver-basic-uath.jar
 ```
 
 Try the application:
 
 The application starts on a random port, the following assumes it is `56551`
 ```bash
-curl http://localhost:56551/public
-curl -u "jill:password" http://localhost:56551/noRoles
-curl -u "john:password" http://localhost:56551/user
-curl -u "jack:password" http://localhost:56551/admin
-curl -v -u "john:password" http://localhost:56551/deny
-curl -u "jack:password" http://localhost:56551/noAuthn
+curl http://localhost:[PORT]/public
+curl -u "jill:password" http://localhost:[PORT]/noRoles
+curl -u "john:password" http://localhost:[PORT]/user
+curl -u "jack:password" http://localhost:[PORT]/admin
+curl -v -u "john:password" http://localhost:[PORT]/deny
+curl -u "jack:password" http://localhost:[PORT]/noAuthn
 ```
diff --git a/examples/security/webserver-digest-auth/README.md b/examples/security/webserver-digest-auth/README.md
@@ -21,10 +21,10 @@ Try the application:
 
 The application starts on a random port, the following assumes it is `56551`
 ```bash
-curl http://localhost:56551/public
-curl --digest -u "jill:password" http://localhost:56551/noRoles
-curl --digest -u "john:password" http://localhost:56551/user
-curl --digest -u "jack:password" http://localhost:56551/admin
-curl -v --digest -u "john:password" http://localhost:56551/deny
-curl --digest -u "jack:password" http://localhost:56551/noAuthn
+curl http://localhost:[PORT]/public
+curl --digest -u "jill:password" http://localhost:[PORT]/noRoles
+curl --digest -u "john:password" http://localhost:[PORT]/user
+curl --digest -u "jack:password" http://localhost:[PORT]/admin
+curl -v --digest -u "john:password" http://localhost:[PORT]/deny
+curl --digest -u "jack:password" http://localhost:[PORT]/noAuthn
 ```