Apicurio Studio configuration reference

This chapter provides reference information on the configuration options that are available for Apicurio Studio.

Apicurio Studio configuration options

The following Apicurio Studio configuration options are available for each component category:

api

Table 1. api configuration options
Name Type Default Available from Description

apicurio.api.errors.include-stack-in-response

boolean

false

1.0.0

Include stack trace in errors responses

auth

Table 2. auth configuration options
Name Type Default Available from Description

apicurio.authn.audit.log.prefix

string

audit

1.0.0

Prefix used for application audit logging.

apicurio.authn.basic-client-credentials.cache-expiration

integer

10

1.0.0

Default client credentials token expiration time.

apicurio.authn.basic-client-credentials.cache-expiration-offset

integer

10

1.0.0

Client credentials token expiration offset from JWT expiration.

apicurio.authn.basic-client-credentials.enabled

boolean [dynamic]

false

1.0.0

Enable basic auth client credentials

apicurio.authn.basic.scope

optional<string>

1.0.0

Client credentials scope.

quarkus.oidc.auth-server-url

string

1.0.0

OIDC auth server URL

quarkus.oidc.client-id

string

1.0.0

Client identifier used by the server for authentication.

quarkus.oidc.client-secret

optional<string>

1.0.0

Client secret used by the server for authentication.

quarkus.oidc.enabled

boolean

false

1.0.0

OIDC enabled

quarkus.oidc.tenant-enabled

boolean

false

1.0.0

Enable auth

quarkus.oidc.token-path

string

1.0.0

Authentication server token endpoint.

redirects

Table 3. redirects configuration options
Name Type Default Available from Description

apicurio.enable-redirects

boolean

true

1.0.0

Enable redirects

apicurio.redirects

map<string, string>

1.0.0

Studio redirects

storage

Table 4. storage configuration options
Name Type Default Available from Description

apicurio.storage.db-kind

string

h2

1.0.0

Application datasource database type

ui

Table 5. ui configuration options
Name Type Default Available from Description

apicurio.ui.auth.oidc.client-id

string

apicurio-studio-ui

1.0.0

The user interface OIDC clientId

apicurio.ui.auth.oidc.redirect-uri

string

/

1.0.0

The user interface OIDC redirectUri

apicurio.ui.context-path

string

/

1.0.0

Context path of the UI

apicurio.ui.editors.url

string

/editors/

1.0.0

URL to the 'editors' UI component

apicurio.ui.masthead.enabled

boolean

true

1.0.0

Enabled to show the masthead

apicurio.ui.masthead.label

string

APICURIO STUDIO

1.0.0

The masthead label (shown if the logo does not render)

apicurio.ui.nav-prefix-path

string

_

1.0.0

Navigation prefix for all UI paths

apicurio.ui.openapi.vendor-extensions.url

optional<string>

1.0.0

URL to a JSON file containing OpenAPI vendor extensions