This is an automated email from the ASF dual-hosted git repository.
yamer pushed a commit to branch main
in repository
https://gitbox.apache.org/repos/asf/incubator-kie-kogito-examples.git
The following commit(s) were added to refs/heads/main by this push:
new 6a0b0a8ff [incubator-kie-issues#1780] Cleanup rules springboot
examples (#2059)
6a0b0a8ff is described below
commit 6a0b0a8ffa827c1704267ae872c5e4f10050a350
Author: bncriju <[email protected]>
AuthorDate: Thu Jan 23 22:32:02 2025 +0530
[incubator-kie-issues#1780] Cleanup rules springboot examples (#2059)
* Corrected README.md files for 5 examples
* Modified Swagger Info
---
.../decisiontable-springboot-example/README.md | 3 ++-
.../rules-legacy-scesim-springboot-example/README.md | 5 +++--
.../rules-legacy-springboot-example/README.md | 5 +++--
.../ruleunit-event-driven-springboot/README.md | 10 ++++++++--
.../ruleunit-springboot-example/README.md | 3 ++-
5 files changed, 18 insertions(+), 8 deletions(-)
diff --git
a/kogito-springboot-examples/decisiontable-springboot-example/README.md
b/kogito-springboot-examples/decisiontable-springboot-example/README.md
index e0096074a..33bd66ac8 100644
--- a/kogito-springboot-examples/decisiontable-springboot-example/README.md
+++ b/kogito-springboot-examples/decisiontable-springboot-example/README.md
@@ -35,7 +35,8 @@ java -jar target/decisiontable-springboot-example.jar
## OpenAPI (Swagger) documentation
[Specification at swagger.io](https://swagger.io/docs/specification/about/)
-You can take a look at the [OpenAPI
definition](http://localhost:8080/v3/api-docs) - automatically generated and
included in this service - to determine all available operations exposed by
this service. For easy readability you can visualize the OpenAPI definition
file using a UI tool like for example available [Swagger
UI](https://editor.swagger.io).
+The [Swagger](http://localhost:8080/swagger-ui/index.html) page shows all the
available endpoints, and it could be used to test them.
+You can take a look at the [OpenAPI
definition](http://localhost:8080/v3/api-docs) - automatically generated and
included in this service - to determine all available operations exposed by
this service. For easy readability you can visualize the OpenAPI definition
file using a UI tool like for example available [Swagger
Editor](https://editor.swagger.io).
In addition, various clients to interact with this service can be easily
generated using this OpenAPI definition.
diff --git
a/kogito-springboot-examples/rules-legacy-scesim-springboot-example/README.md
b/kogito-springboot-examples/rules-legacy-scesim-springboot-example/README.md
index 1d3b145fa..4d61cd957 100644
---
a/kogito-springboot-examples/rules-legacy-scesim-springboot-example/README.md
+++
b/kogito-springboot-examples/rules-legacy-scesim-springboot-example/README.md
@@ -43,13 +43,14 @@ mvn clean compile spring-boot:run
```sh
mvn clean package
-java -jar target/ruleunit-springboot-example.jar
+java -jar target/rules-legacy-scesim-springboot-example.jar
```
## OpenAPI (Swagger) documentation
[Specification at swagger.io](https://swagger.io/docs/specification/about/)
-You can take a look at the [OpenAPI
definition](http://localhost:8080/v3/api-docs) - automatically generated and
included in this service - to determine all available operations exposed by
this service. For easy readability you can visualize the OpenAPI definition
file using a UI tool like for example available [Swagger
UI](https://editor.swagger.io).
+The [Swagger](http://localhost:8080/swagger-ui/index.html) page shows all the
available endpoints, and it could be used to test them.
+You can take a look at the [OpenAPI
definition](http://localhost:8080/v3/api-docs) - automatically generated and
included in this service - to determine all available operations exposed by
this service. For easy readability you can visualize the OpenAPI definition
file using a UI tool like for example available [Swagger
Editor](https://editor.swagger.io).
In addition, various clients to interact with this service can be easily
generated using this OpenAPI definition.
diff --git
a/kogito-springboot-examples/rules-legacy-springboot-example/README.md
b/kogito-springboot-examples/rules-legacy-springboot-example/README.md
index c27213987..a6d0dc3f0 100644
--- a/kogito-springboot-examples/rules-legacy-springboot-example/README.md
+++ b/kogito-springboot-examples/rules-legacy-springboot-example/README.md
@@ -25,13 +25,14 @@ mvn clean compile spring-boot:run
```sh
mvn clean package
-java -jar target/ruleunit-springboot-example.jar
+java -jar target/rules-legacy-springboot-example.jar
```
## OpenAPI (Swagger) documentation
[Specification at swagger.io](https://swagger.io/docs/specification/about/)
-You can take a look at the [OpenAPI
definition](http://localhost:8080/v3/api-docs) - automatically generated and
included in this service - to determine all available operations exposed by
this service. For easy readability you can visualize the OpenAPI definition
file using a UI tool like for example available [Swagger
UI](https://editor.swagger.io).
+The [Swagger](http://localhost:8080/swagger-ui/index.html) page shows all the
available endpoints, and it could be used to test them.
+You can take a look at the [OpenAPI
definition](http://localhost:8080/v3/api-docs) - automatically generated and
included in this service - to determine all available operations exposed by
this service. For easy readability you can visualize the OpenAPI definition
file using a UI tool like for example available [Swagger
Editor](https://editor.swagger.io).
In addition, various clients to interact with this service can be easily
generated using this OpenAPI definition.
diff --git
a/kogito-springboot-examples/ruleunit-event-driven-springboot/README.md
b/kogito-springboot-examples/ruleunit-event-driven-springboot/README.md
index a22962f99..7eeec7d62 100644
--- a/kogito-springboot-examples/ruleunit-event-driven-springboot/README.md
+++ b/kogito-springboot-examples/ruleunit-event-driven-springboot/README.md
@@ -70,16 +70,22 @@ mvn clean compile spring-boot:run
```
mvn clean package
-java -jar target/dmn-event-driven-springboot.jar
+java -jar target/ruleunit-event-driven-springboot.jar
```
or on Windows
```
mvn clean package
-java -jar target\dmn-event-driven-springboot.jar
+java -jar target\ruleunit-event-driven-springboot.jar
```
+## OpenAPI (Swagger) documentation
+[Specification at swagger.io](https://swagger.io/docs/specification/about/)
+
+The [Swagger](http://localhost:8080/swagger-ui/index.html) page shows all the
available endpoints, and it could be used to test them.
+You can take a look at the [OpenAPI
definition](http://localhost:8080/v3/api-docs) - automatically generated and
included in this service - to determine all available operations exposed by
this service. For easy readability you can visualize the OpenAPI definition
file using a UI tool like for example available [Swagger
Editor](https://editor.swagger.io).
+
## Example Usage
Here is an example of a input event that triggers the evaluation of the [Loan
Unit](src/main/resources/org/kie/kogito/queries/RuleUnitQuery.drl) queries
diff --git a/kogito-springboot-examples/ruleunit-springboot-example/README.md
b/kogito-springboot-examples/ruleunit-springboot-example/README.md
index 8b6bb2063..e7178d97d 100644
--- a/kogito-springboot-examples/ruleunit-springboot-example/README.md
+++ b/kogito-springboot-examples/ruleunit-springboot-example/README.md
@@ -31,7 +31,8 @@ java -jar target/ruleunit-springboot-example.jar
## OpenAPI (Swagger) documentation
[Specification at swagger.io](https://swagger.io/docs/specification/about/)
-You can take a look at the [OpenAPI
definition](http://localhost:8080/v3/api-docs) - automatically generated and
included in this service - to determine all available operations exposed by
this service. For easy readability you can visualize the OpenAPI definition
file using a UI tool like for example available [Swagger
UI](https://editor.swagger.io).
+The [Swagger](http://localhost:8080/swagger-ui/index.html) page shows all the
available endpoints, and it could be used to test them.
+You can take a look at the [OpenAPI
definition](http://localhost:8080/v3/api-docs) - automatically generated and
included in this service - to determine all available operations exposed by
this service. For easy readability you can visualize the OpenAPI definition
file using a UI tool like for example available [Swagger
Editor](https://editor.swagger.io).
In addition, various clients to interact with this service can be easily
generated using this OpenAPI definition.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
