-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: updated pom, added docs, added new exception handler (#24)
* feat: updated pom, added docs, added new exception handler * fix: est * empty commit du restart pipeline
- Loading branch information
1 parent
0218d75
commit a7b54a2
Showing
10 changed files
with
257 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
name: onecx-help | ||
title: Help Management | ||
version: latest |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* xref:onecx-help-bff:index.adoc[Help Bff] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
include::onecx-help-bff-attributes.adoc[opts=optional] | ||
|
||
== onecx-help-bff | ||
|
||
include::docs.adoc[opts=optional] | ||
|
||
|
||
include::onecx-help-bff-docs.adoc[opts=optional] |
5 changes: 5 additions & 0 deletions
5
docs/modules/onecx-help-bff/pages/onecx-help-bff-attributes.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
|
||
:docker-registry: https://github.com/onecx/onecx-help-bff/pkgs/container/onecx-help-bff | ||
:helm-registry: https://github.com/onecx/onecx-help-bff/pkgs/container/charts%2Fonecx-help-bff | ||
:properties-file: src/main/resources/application.properties | ||
:helm-file: src/main/helm/values.yaml |
66 changes: 66 additions & 0 deletions
66
docs/modules/onecx-help-bff/pages/onecx-help-bff-docs.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
|
||
include::onecx-help-bff-attributes.adoc[opts=optional] | ||
|
||
=== Default properties | ||
|
||
.{properties-file} | ||
[%collapsible%open] | ||
==== | ||
[source,properties,subs=attributes+] | ||
---- | ||
quarkus.http.auth.permission.health.paths=/q/* | ||
quarkus.http.auth.permission.health.policy=permit | ||
quarkus.http.auth.permission.default.paths=/* | ||
quarkus.http.auth.permission.default.policy=authenticated | ||
onecx.permissions.application-id=${quarkus.application.name} | ||
%prod.quarkus.rest-client.onecx_help_svc.url=http://onecx-help-svc:8080 | ||
%prod.quarkus.oidc-client.client-id=${quarkus.application.name} | ||
org.eclipse.microprofile.rest.client.propagateHeaders=apm-principal-token | ||
quarkus.openapi-generator.codegen.spec.onecx_help_svc_yaml.config-key=onecx_help_svc | ||
quarkus.openapi-generator.codegen.spec.onecx_help_svc_yaml.base-package=gen.org.tkit.onecx.help.client | ||
quarkus.openapi-generator.codegen.spec.onecx_help_svc_yaml.return-response=true | ||
quarkus.openapi-generator.codegen.input-base-dir=target/tmp/openapi | ||
quarkus.openapi-generator.codegen.spec.onecx_help_svc_yaml.additional-api-type-annotations=@org.eclipse.microprofile.rest.client.annotation.RegisterClientHeaders; | ||
quarkus.openapi-generator.codegen.spec.onecx_help_svc_yaml.additional-model-type-annotations=@io.quarkus.runtime.annotations.RegisterForReflection; | ||
---- | ||
==== | ||
|
||
=== Extensions | ||
|
||
include::onecx-help-bff-extensions.adoc[opts=optional] | ||
|
||
=== Container | ||
|
||
{docker-registry}[Docker registry] | ||
|
||
|
||
=== Helm | ||
|
||
{helm-registry}[Helm registry] | ||
|
||
Default values | ||
|
||
.{helm-file} | ||
[source,yaml] | ||
---- | ||
app: | ||
name: bff | ||
image: | ||
repository: "onecx/onecx-help-bff" | ||
operator: | ||
# Permission | ||
permission: | ||
enabled: true | ||
spec: | ||
permissions: | ||
helps: | ||
read: permission on all GET requests and POST search | ||
write: permission on PUT, POST, PATCH requests, where objects are saved or updated | ||
delete: permission on all DELETE requests | ||
keycloak: | ||
client: | ||
enabled: true | ||
password: "my-custom-password" | ||
---- | ||
|
145 changes: 145 additions & 0 deletions
145
docs/modules/onecx-help-bff/pages/onecx-help-bff-extensions.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,145 @@ | ||
|
||
include::onecx-help-bff-attributes.adoc[opts=optional] | ||
|
||
[.extension.table.searchable, cols="50,.^15,.^15,.^20"] | ||
|=== | ||
h| Extensions | ||
h| Documentation | ||
h| Configuration | ||
h| Version | ||
|
||
| quarkus-rest | ||
|
||
| https://quarkus.io/guides/rest[Link] | ||
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-rest.adoc[Link] | ||
| 3.9.3 | ||
| quarkus-smallrye-openapi | ||
| https://quarkus.io/guides/openapi-swaggerui[Link] | ||
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-smallrye-openapi.adoc[Link] | ||
| 3.9.3 | ||
| quarkus-rest-jackson | ||
| https://quarkus.io/guides/rest-json[Link] | ||
| | ||
| 3.9.3 | ||
| quarkus-openapi-generator | ||
| https://docs.quarkiverse.io/quarkus-openapi-generator/dev/index.html[Link] | ||
| https://github.com/quarkiverse/quarkus-openapi-generator/blob/2.4.1/docs/modules/ROOT/pages/includes/quarkus-openapi-generator.adoc[Link] | ||
| 2.4.1 | ||
| quarkus-rest-client-reactive-jackson | ||
| https://quarkus.io/guides/rest-client[Link] | ||
| | ||
| 3.9.3 | ||
| tkit-quarkus-log-cdi | ||
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-log-cdi.html[Link] | ||
| https://github.com/1000kit/tkit-quarkus/blob/2.22.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-cdi.adoc[Link] | ||
| 2.22.0 | ||
| tkit-quarkus-log-rs | ||
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-log-rs.html[Link] | ||
| https://github.com/1000kit/tkit-quarkus/blob/2.22.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-rs.adoc[Link] | ||
| 2.22.0 | ||
| tkit-quarkus-log-json | ||
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-log-json.html[Link] | ||
| https://github.com/1000kit/tkit-quarkus/blob/2.22.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-log-json.adoc[Link] | ||
| 2.22.0 | ||
| tkit-quarkus-rest | ||
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-rest.html[Link] | ||
| https://github.com/1000kit/tkit-quarkus/blob/2.22.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-rest.adoc[Link] | ||
| 2.22.0 | ||
| tkit-quarkus-rest-context | ||
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-rest-context.html[Link] | ||
| https://github.com/1000kit/tkit-quarkus/blob/2.22.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-rest-context.adoc[Link] | ||
| 2.22.0 | ||
| quarkus-hibernate-validator | ||
| https://quarkus.io/guides/validation[Link] | ||
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-hibernate-validator.adoc[Link] | ||
| 3.9.3 | ||
| quarkus-smallrye-health | ||
| https://quarkus.io/guides/smallrye-health[Link] | ||
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-smallrye-health.adoc[Link] | ||
| 3.9.3 | ||
| quarkus-opentelemetry | ||
| https://quarkus.io/guides/opentelemetry[Link] | ||
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-opentelemetry.adoc[Link] | ||
| 3.9.3 | ||
| quarkus-micrometer-registry-prometheus | ||
| https://quarkus.io/guides/telemetry-micrometer[Link] | ||
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-micrometer-registry-prometheus.adoc[Link] | ||
| 3.9.3 | ||
| quarkus-oidc | ||
| https://quarkus.io/guides/security-oidc-bearer-token-authentication-tutorial[Link] | ||
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-oidc.adoc[Link] | ||
| 3.9.3 | ||
| quarkus-oidc-client-reactive-filter | ||
| https://quarkus.io/guides/security-openid-connect-client-reference[Link] | ||
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-oidc-client-reactive-filter.adoc[Link] | ||
| 3.9.3 | ||
| onecx-permissions | ||
| https://onecx.github.io/docs/onecx-quarkus/current/onecx-quarkus/onecx-permissions.html[Link] | ||
| https://github.com/onecx/onecx-quarkus/blob/0.17.0/docs/modules/onecx-quarkus/pages/includes/onecx-permissions.adoc[Link] | ||
| 0.17.0 | ||
| tkit-quarkus-security | ||
| https://1000kit.github.io/tkit-quarkus/current/tkit-quarkus/tkit-quarkus-security.html[Link] | ||
| https://github.com/1000kit/tkit-quarkus/blob/2.22.0/docs/modules/tkit-quarkus/pages/includes/tkit-quarkus-security.adoc[Link] | ||
| 2.22.0 | ||
| onecx-core | ||
| https://onecx.github.io/docs/onecx-quarkus/current/onecx-quarkus/onecx-core.html[Link] | ||
| | ||
| 0.17.0 | ||
| quarkus-arc | ||
| https://quarkus.io/guides/cdi-reference[Link] | ||
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-arc.adoc[Link] | ||
| 3.9.3 | ||
| quarkus-container-image-docker | ||
| https://quarkus.io/guides/container-image[Link] | ||
| https://github.com/quarkusio/quarkusio.github.io/blob/develop/_generated-doc/latest/config/quarkus-container-image-docker.adoc[Link] | ||
| 3.9.3 | ||
| quarkus-oidc-client | ||
| | ||
| | ||
| 3.9.3 | ||
|=== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters