onecx-workspace-api-bff

Configuration

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

onecx.path.shell-mapping.enabled

Enable or disable shell mapping

Environment variable: ONECX_PATH_SHELL_MAPPING_ENABLED

boolean

false

onecx.path.shell-mapping.prefix

Prefix to be used for paths

Environment variable: ONECX_PATH_SHELL_MAPPING_PREFIX

string

ui/

Default properties

src/main/resources/application.properties 
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}
org.eclipse.microprofile.rest.client.propagateHeaders=apm-principal-token
%prod.quarkus.rest-client.onecx_workspace_svc.url=http://onecx-workspace-svc:8080
quarkus.openapi-generator.codegen.input-base-dir=target/tmp/openapi
quarkus.openapi-generator.codegen.spec.onecx_workspace_svc_user_menu_yaml.config-key=onecx_workspace_svc
quarkus.openapi-generator.codegen.spec.onecx_workspace_svc_user_menu_yaml.base-package=gen.org.tkit.onecx.workspace.user.client
quarkus.openapi-generator.codegen.spec.onecx_workspace_svc_user_menu_yaml.return-response=true
quarkus.openapi-generator.codegen.spec.onecx_workspace_svc_user_menu_yaml.additional-api-type-annotations=@org.eclipse.microprofile.rest.client.annotation.RegisterClientHeaders;
quarkus.openapi-generator.codegen.spec.onecx_workspace_svc_user_menu_yaml.additional-model-type-annotations=@io.quarkus.runtime.annotations.RegisterForReflection;
quarkus.openapi-generator.codegen.spec.onecx_workspace_svc_user_menu_yaml.enable-security-generation=false
%prod.quarkus.rest-client.onecx_workspace_svc.providers=io.quarkus.oidc.client.reactive.filter.OidcClientRequestReactiveFilter
%prod.quarkus.oidc-client.client-id=${quarkus.application.name}

Extensions

Extensions

Documentation

Configuration

Version

quarkus-rest

Link

Link

3.27.1

quarkus-smallrye-openapi

Link

Link

3.27.1

quarkus-rest-jackson

Link

3.27.1

quarkus-smallrye-health

Link

Link

3.27.1

quarkus-openapi-generator

Link

Link

2.13.0-lts

quarkus-rest-client-jackson

Link

3.27.1

tkit-quarkus-log-cdi

Link

Link

4.6.0

tkit-quarkus-log-rs

Link

Link

4.6.0

tkit-quarkus-log-json

Link

Link

4.6.0

tkit-quarkus-rest

Link

Link

4.6.0

tkit-quarkus-rest-context

Link

Link

4.6.0

tkit-quarkus-security

Link

Link

4.6.0

quarkus-hibernate-validator

Link

Link

3.27.1

onecx-permissions

Link

Link

2.3.0

quarkus-oidc

Link

Link

3.27.1

onecx-core

Link

2.3.0

quarkus-micrometer-registry-prometheus

Link

Link

3.27.1

quarkus-opentelemetry

Link

Link

3.27.1

quarkus-arc

Link

Link

3.27.1

quarkus-container-image-docker

Link

Link

3.27.1

quarkus-rest-client-oidc-filter

3.27.1

| | | 3.20.2.1

|===th

| | | 2.40.0

=== Container

Docker registry

=== Helm

Helm registry

Default values

.src/main/helm/values.yaml [source,yaml] ---- app: name: api-bff image: repository: "onecx/onecx-workspace-api-bff" operator: # Permission permission: enabled: true spec: permissions: menu: ext-api-req: permission to request menu api keycloak: client: enabled: true spec: kcConfig: defaultClientScopes: [ ocx-ws:read, ocx-pm:read ] microservice: spec: description: OneCX Workspace API Backend for Frontend name: OneCX Workspace API BFF

----

ption: OneCX Workspace API Backend for Frontend name: OneCX Workspace API BFF

----

TE requests role: 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 assignment: 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 menu: 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 slot: 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 spec: kcConfig: defaultClientScopes: [ ocx-ws:all, ocx-th:read, ocx-ps:read, ocx-ia:read, ocx-pm:read ]

----