OneCX Workspace API Legacy

Configuration

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

Configuration property

Type

Default

onecx.workspace.api.legacy.workspaces."workspaces".name

Mapping workspace configuration.

Environment variable: ONECX_WORKSPACE_API_LEGACY_WORKSPACES__WORKSPACES__NAME

string

required

onecx.workspace.api.legacy.workspaces."workspaces".rename

Rename workspace configuration.

Environment variable: ONECX_WORKSPACE_API_LEGACY_WORKSPACES__WORKSPACES__RENAME

string

required

onecx.workspace.api.legacy.token.access.roles.path

access token roles path

Environment variable: ONECX_WORKSPACE_API_LEGACY_TOKEN_ACCESS_ROLES_PATH

string

realm_access/roles

onecx.workspace.api.legacy.token.id.roles

access token roles path

Environment variable: ONECX_WORKSPACE_API_LEGACY_TOKEN_ID_ROLES

string

realm_roles

onecx.workspace.api.legacy.shell-mapping.enabled

Enable or disable shell mapping

Environment variable: ONECX_WORKSPACE_API_LEGACY_SHELL_MAPPING_ENABLED

boolean

false

onecx.workspace.api.legacy.shell-mapping.prefix

Prefix to be used for paths

Environment variable: ONECX_WORKSPACE_API_LEGACY_SHELL_MAPPING_PREFIX

string

/ui/

Link to Docker registry

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
org.eclipse.microprofile.rest.client.propagateHeaders=apm-principal-token
%prod.quarkus.rest-client.onecx_workspace_svc.url=http://onecx-workspace-svc:8080
%prod.quarkus.rest-client.onecx_workspace_svc.providers=io.quarkus.oidc.client.reactive.filter.OidcClientRequestReactiveFilter
%prod.quarkus.oidc-client.client-id=${quarkus.application.name}
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

Extensions

Extensions List

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

quarkus-oidc

Link

Link

3.27.1

quarkus-rest-client-oidc-filter

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-openapi-generator-oidc

2.13.0-lts

Helm

Link to Helm registry

Default values in src/main/helm/values.yaml
app:
  name: api-legacy
  image:
    repository: "onecx/onecx-workspace-api-legacy"
  operator:
    keycloak:
      client:
        enabled: true
        spec:
          kcConfig:
            defaultClientScopes: [ ocx-ws:read ]
    microservice:
      spec:
        description: OneCX Workspace API Legacy
        name: OneCX Workspace API Legacy